org.datavec.api.transform.schema

Class Schema

java.lang.Object

org.datavec.api.transform.schema.Schema

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SequenceSchema

public class Schema
extends Object
implements Serializable

A Schema defines the layout of tabular data. Specifically, it contains names for each column, as well as details of types (Integer, String, Long, Double, etc).
Type information for each column may optionally include restrictions on the allowable values for each column.

See also: SequenceSchema

Author:

Alex Black

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schema.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
	Schema(List<ColumnMetaData> columnMetaData)
protected	Schema(Schema.Builder builder)

Method Summary

Modifier and Type	Method and Description
static Schema	fromJson(String json)
static Schema	fromYaml(String yaml)
List<ColumnMetaData>	getColumnMetaData()
List<String>	getColumnNames()
List<ColumnType>	getColumnTypes()
int	getIndexOfColumn(String columnName)
ColumnMetaData	getMetaData(int column)
ColumnMetaData	getMetaData(String column)
String	getName(int column)
ColumnType	getType(int column)
boolean	hasColumn(String columnName) Determine if the schema has a column with the specified name
Schema	newSchema(List<ColumnMetaData> columnMetaData)
int	numColumns()
String	toJson()
String	toString()
String	toYaml()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Schema

protected Schema(Schema.Builder builder)

Schema

public Schema(List<ColumnMetaData> columnMetaData)

Method Detail

newSchema

public Schema newSchema(List<ColumnMetaData> columnMetaData)

numColumns

public int numColumns()

getName

public String getName(int column)

getType

public ColumnType getType(int column)

getMetaData

public ColumnMetaData getMetaData(int column)

getMetaData

public ColumnMetaData getMetaData(String column)

getColumnNames

public List<String> getColumnNames()

getColumnTypes

public List<ColumnType> getColumnTypes()

getColumnMetaData

public List<ColumnMetaData> getColumnMetaData()

getIndexOfColumn

public int getIndexOfColumn(String columnName)

hasColumn

public boolean hasColumn(String columnName)

Determine if the schema has a column with the specified name

Parameters:

columnName - Name to see if the column exists

Returns:

True if a column exists for that name, false otherwise

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

toYaml

public String toYaml()

fromJson

public static Schema fromJson(String json)

fromYaml

public static Schema fromYaml(String yaml)