public class FrameMetadata extends Metadata
| Constructor and Description | 
|---|
| FrameMetadata() | 
| FrameMetadata(DataCharacteristics dataCharacteristics)Constructor to create a FrameMetadata object based on a
 DataCharacteristics object. | 
| FrameMetadata(FrameFormat frameFormat)Constructor to create a FrameMetadata object based on frame format. | 
| FrameMetadata(FrameFormat frameFormat,
             FrameSchema frameSchema)Constructor to create a FrameMetadata object based on frame format and
 frame schema. | 
| FrameMetadata(FrameFormat frameFormat,
             FrameSchema frameSchema,
             int numRows,
             int numColumns)Constructor to create a FrameMetadata object based on frame format, frame
 schema, the number of rows, and the number of columns in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             FrameSchema frameSchema,
             int numRows,
             int numColumns,
             int numNonZeros,
             int blen)Constructor to create a FrameMetadata object based on frame format, frame
 schema, the number of rows, the number of columns, the number of non-zero
 values, the number of rows per block, and the number of columns per block
 in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             FrameSchema frameSchema,
             Long numRows,
             Long numColumns)Constructor to create a FrameMetadata object based on frame format, frame
 schema, the number of rows, and the number of columns in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             FrameSchema frameSchema,
             Long numRows,
             Long numColumns,
             Long numNonZeros,
             Integer blen)Constructor to create a FrameMetadata object based on frame format, frame
 schema, the number of rows, the number of columns, the number of non-zero
 values, the number of rows per block, and the number of columns per block
 in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             int numRows,
             int numColumns)Constructor to create a FrameMetadata object based on frame format, the
 number of rows, and the number of columns in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             int numRows,
             int numColumns,
             int numNonZeros)Constructor to create a FrameMetadata object based on frame format, the
 number of rows, the number of columns, and the number of non-zero values
 in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             int numRows,
             int numColumns,
             int numNonZeros,
             int blen)Constructor to create a FrameMetadata object based on frame format, the
 number of rows, the number of columns, the number of non-zero values, the
 number of rows per block, and the number of columns per block in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             Long numRows,
             Long numColumns)Constructor to create a FrameMetadata object based on frame format, the
 number of rows, and the number of columns in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             Long numRows,
             Long numColumns,
             Long numNonZeros)Constructor to create a FrameMetadata object based on frame format, the
 number of rows, the number of columns, and the number of non-zero values
 in a frame. | 
| FrameMetadata(FrameFormat frameFormat,
             Long numRows,
             Long numColumns,
             Long numNonZeros,
             Integer blen)Constructor to create a FrameMetadata object based on frame format, the
 number of rows, the number of columns, the number of non-zero values, the
 number of rows per block, and the number of columns per block in a frame. | 
| FrameMetadata(FrameSchema frameSchema)Constructor to create a FrameMetadata object based on frame schema. | 
| FrameMetadata(FrameSchema frameSchema,
             MatrixCharacteristics matrixCharacteristics)Constructor to create a FrameMetadata object based on the frame schema
 and a DataCharacteristics object. | 
| FrameMetadata(int numRows,
             int numColumns)Constructor to create a FrameMetadata object based on the number of rows
 and the number of columns in a frame. | 
| FrameMetadata(int numRows,
             int numColumns,
             int numNonZeros)Constructor to create a FrameMetadata object based on the number of rows,
 the number of columns, and the number of non-zero values in a frame. | 
| FrameMetadata(int numRows,
             int numColumns,
             int numNonZeros,
             int blen)Constructor to create a FrameMetadata object based on the number of rows,
 the number of columns, the number of non-zero values, the number of rows
 per block, and the number of columns per block in a frame. | 
| FrameMetadata(Long numRows,
             Long numColumns)Constructor to create a FrameMetadata object based on the number of rows
 and the number of columns in a frame. | 
| FrameMetadata(Long numRows,
             Long numColumns,
             Integer blen)Constructor to create a FrameMetadata object based on the number of rows,
 the number of columns, the number of rows per block, and the number of
 columns per block in a frame. | 
| FrameMetadata(Long numRows,
             Long numColumns,
             Long numNonZeros)Constructor to create a FrameMetadata object based on the number of rows,
 the number of columns, and the number of non-zero values in a frame. | 
| FrameMetadata(Long numRows,
             Long numColumns,
             Long numNonZeros,
             Integer blen)Constructor to create a FrameMetadata object based on the number of rows,
 the number of columns, the number of non-zero values, the number of rows
 per block, and the number of columns per block in a frame. | 
| FrameMetadata(String schema)Constructor to create a FrameMetadata object based on a string
 representation of a frame schema. | 
| Modifier and Type | Method and Description | 
|---|---|
| FrameFormat | getFrameFormat()Obtain the frame format | 
| FrameSchema | getFrameSchema()Obtain the frame schema | 
| void | setFrameFormat(FrameFormat frameFormat)Set the frame format | 
| void | setFrameSchema(FrameSchema frameSchema)Set the frame schema | 
| void | setMatrixCharacteristics(MatrixCharacteristics matrixCharacteristics)Set the FrameMetadata fields based on a DataCharacteristics object. | 
asMatrixCharacteristics, getBlocksize, getNumColumns, getNumNonZeros, getNumRows, setBlocksize, setNumColumns, setNumNonZeros, setNumRows, toStringpublic FrameMetadata()
public FrameMetadata(String schema)
schema - String representation of the frame schema.public FrameMetadata(FrameFormat frameFormat)
frameFormat - The frame format.public FrameMetadata(FrameSchema frameSchema)
frameSchema - The frame schema.public FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema)
frameFormat - The frame format.frameSchema - The frame schema.public FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, Long numRows, Long numColumns)
frameFormat - The frame format.frameSchema - The frame schema.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.public FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, int numRows, int numColumns)
frameFormat - The frame format.frameSchema - The frame schema.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.public FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, Long numRows, Long numColumns, Long numNonZeros, Integer blen)
frameFormat - The frame format.frameSchema - The frame schema.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.blen - The number of rows/cols per block in the frame.public FrameMetadata(FrameFormat frameFormat, FrameSchema frameSchema, int numRows, int numColumns, int numNonZeros, int blen)
frameFormat - The frame format.frameSchema - The frame schema.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.blen - The number of rows/cols per block in the frame.public FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns)
frameFormat - The frame format.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.public FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns)
frameFormat - The frame format.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.public FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns, Long numNonZeros)
frameFormat - The frame format.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.public FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns, int numNonZeros)
frameFormat - The frame format.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.public FrameMetadata(FrameFormat frameFormat, Long numRows, Long numColumns, Long numNonZeros, Integer blen)
frameFormat - The frame format.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.blen - The number of rows/cols per block in the frame.public FrameMetadata(FrameFormat frameFormat, int numRows, int numColumns, int numNonZeros, int blen)
frameFormat - The frame format.numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.blen - The number of rows/cols per block in the frame.public FrameMetadata(Long numRows, Long numColumns)
numRows - The number of rows in the frame.numColumns - The number of columns in the frame.public FrameMetadata(int numRows,
                     int numColumns)
numRows - The number of rows in the frame.numColumns - The number of columns in the frame.public FrameMetadata(Long numRows, Long numColumns, Long numNonZeros)
numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.public FrameMetadata(int numRows,
                     int numColumns,
                     int numNonZeros)
numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.public FrameMetadata(Long numRows, Long numColumns, Integer blen)
numRows - The number of rows in the frame.numColumns - The number of columns in the frame.blen - The number of rows/cols per block in the frame.public FrameMetadata(Long numRows, Long numColumns, Long numNonZeros, Integer blen)
numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.blen - The number of rows/cols per block in the frame.public FrameMetadata(int numRows,
                     int numColumns,
                     int numNonZeros,
                     int blen)
numRows - The number of rows in the frame.numColumns - The number of columns in the frame.numNonZeros - The number of non-zero values in the frame.blen - The number of rows/cols per block in the frame.public FrameMetadata(DataCharacteristics dataCharacteristics)
dataCharacteristics - the frame metadata as a DataCharacteristics objectpublic FrameMetadata(FrameSchema frameSchema, MatrixCharacteristics matrixCharacteristics)
frameSchema - The frame schema.matrixCharacteristics - the frame metadata as a DataCharacteristics objectpublic void setMatrixCharacteristics(MatrixCharacteristics matrixCharacteristics)
setMatrixCharacteristics in class MetadatamatrixCharacteristics - the frame metadata as a DataCharacteristics objectpublic FrameFormat getFrameFormat()
public void setFrameFormat(FrameFormat frameFormat)
frameFormat - the frame formatpublic FrameSchema getFrameSchema()
public void setFrameSchema(FrameSchema frameSchema)
frameSchema - the frame schemaCopyright © 2021 The Apache Software Foundation. All rights reserved.