Package org.apache.sysds.api.mlcontext
Class Frame
- java.lang.Object
- 
- org.apache.sysds.api.mlcontext.Frame
 
- 
 public class Frame extends Object Frame encapsulates a SystemDS frame.
- 
- 
Constructor SummaryConstructors Constructor Description Frame(org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> binaryBlocks, FrameMetadata frameMetadata)Create a Frame, specifying the SystemDS binary-block frame and its metadata.Frame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame)Convert a Spark DataFrame to a SystemDS binary-block representation.Frame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, long numRows, long numCols)Convert a Spark DataFrame to a SystemDS binary-block representation, specifying the number of rows and columns.Frame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, FrameMetadata frameMetadata)Convert a Spark DataFrame to a SystemDS binary-block representation.Frame(FrameObject frameObject, SparkExecutionContext sparkExecutionContext)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description FrameMetadatagetFrameMetadata()Obtain the frame metadatabooleanhasBinaryBlocks()Whether or not this frame contains data as binary blocksbooleanhasFrameObject()Whether or not this frame contains data as a FrameObjectString[][]to2DStringArray()Obtain the frame as a two-dimensional String arrayorg.apache.spark.api.java.JavaPairRDD<Long,FrameBlock>toBinaryBlocks()Obtain the frame as aJavaPairRDD<Long, FrameBlock>org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>toDF()Obtain the frame as aDataFrameFrameObjecttoFrameObject()Obtain the frame as a SystemDS FrameObject.org.apache.spark.api.java.JavaRDD<String>toJavaRDDStringCSV()Obtain the frame as aJavaRDD<String>in CSV formatorg.apache.spark.api.java.JavaRDD<String>toJavaRDDStringIJV()Obtain the frame as aJavaRDD<String>in IJV formatorg.apache.spark.rdd.RDD<String>toRDDStringCSV()Obtain the frame as aRDD<String>in CSV formatorg.apache.spark.rdd.RDD<String>toRDDStringIJV()Obtain the frame as aRDD<String>in IJV formatStringtoString()
 
- 
- 
- 
Constructor Detail- 
Framepublic Frame(FrameObject frameObject, SparkExecutionContext sparkExecutionContext) 
 - 
Framepublic Frame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, FrameMetadata frameMetadata)Convert a Spark DataFrame to a SystemDS binary-block representation.- Parameters:
- dataFrame- the Spark DataFrame
- frameMetadata- frame metadata, such as number of rows and columns
 
 - 
Framepublic Frame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame, long numRows, long numCols)Convert a Spark DataFrame to a SystemDS binary-block representation, specifying the number of rows and columns.- Parameters:
- dataFrame- the Spark DataFrame
- numRows- the number of rows
- numCols- the number of columns
 
 - 
Framepublic Frame(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> dataFrame) Convert a Spark DataFrame to a SystemDS binary-block representation.- Parameters:
- dataFrame- the Spark DataFrame
 
 - 
Framepublic Frame(org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> binaryBlocks, FrameMetadata frameMetadata) Create a Frame, specifying the SystemDS binary-block frame and its metadata.- Parameters:
- binaryBlocks- the- JavaPairRDD<Long, FrameBlock>frame
- frameMetadata- frame metadata, such as number of rows and columnss
 
 
- 
 - 
Method Detail- 
toFrameObjectpublic FrameObject toFrameObject() Obtain the frame as a SystemDS FrameObject.- Returns:
- the frame as a SystemDS FrameObject
 
 - 
to2DStringArraypublic String[][] to2DStringArray() Obtain the frame as a two-dimensional String array- Returns:
- the frame as a two-dimensional String array
 
 - 
toJavaRDDStringIJVpublic org.apache.spark.api.java.JavaRDD<String> toJavaRDDStringIJV() Obtain the frame as aJavaRDD<String>in IJV format- Returns:
- the frame as a JavaRDD<String>in IJV format
 
 - 
toJavaRDDStringCSVpublic org.apache.spark.api.java.JavaRDD<String> toJavaRDDStringCSV() Obtain the frame as aJavaRDD<String>in CSV format- Returns:
- the frame as a JavaRDD<String>in CSV format
 
 - 
toRDDStringCSVpublic org.apache.spark.rdd.RDD<String> toRDDStringCSV() Obtain the frame as aRDD<String>in CSV format- Returns:
- the frame as a RDD<String>in CSV format
 
 - 
toRDDStringIJVpublic org.apache.spark.rdd.RDD<String> toRDDStringIJV() Obtain the frame as aRDD<String>in IJV format- Returns:
- the frame as a RDD<String>in IJV format
 
 - 
toDFpublic org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> toDF() Obtain the frame as aDataFrame- Returns:
- the frame as a DataFrame
 
 - 
toBinaryBlockspublic org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> toBinaryBlocks() Obtain the frame as aJavaPairRDD<Long, FrameBlock>- Returns:
- the frame as a JavaPairRDD<Long, FrameBlock>
 
 - 
getFrameMetadatapublic FrameMetadata getFrameMetadata() Obtain the frame metadata- Returns:
- the frame metadata
 
 - 
hasBinaryBlockspublic boolean hasBinaryBlocks() Whether or not this frame contains data as binary blocks- Returns:
- trueif data as binary blocks are present,- falseotherwise.
 
 - 
hasFrameObjectpublic boolean hasFrameObject() Whether or not this frame contains data as a FrameObject- Returns:
- trueif data as binary blocks are present,- falseotherwise.
 
 
- 
 
-