org.datavec.api.transform.metadata

Class CategoricalMetaData

java.lang.Object

org.datavec.api.transform.metadata.BaseColumnMetaData

org.datavec.api.transform.metadata.CategoricalMetaData

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ColumnMetaData

public class CategoricalMetaData
extends BaseColumnMetaData

Metadata for categorical columns.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.datavec.api.transform.metadata.BaseColumnMetaData

name

Constructor Summary

Constructors

Constructor and Description
CategoricalMetaData(java.lang.String name, java.util.List<java.lang.String> stateNames)
CategoricalMetaData(java.lang.String name, java.lang.String... stateNames)

Method Summary

Modifier and Type	Method and Description
CategoricalMetaData	clone()
ColumnType	getColumnType() Get the type of column
java.util.List<java.lang.String>	getStateNames()
boolean	isValid(java.lang.Object input) Is the given object valid for this column, given the column type and any restrictions given by the ColumnMetaData object?
boolean	isValid(Writable writable) Is the given Writable valid for this column, given the column type and any restrictions given by the ColumnMetaData object?
java.lang.String	toString()

Methods inherited from class org.datavec.api.transform.metadata.BaseColumnMetaData

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoricalMetaData

public CategoricalMetaData(java.lang.String name,
                           java.lang.String... stateNames)

CategoricalMetaData

public CategoricalMetaData(java.lang.String name,
                           java.util.List<java.lang.String> stateNames)

Method Detail

getColumnType

public ColumnType getColumnType()

Description copied from interface: ColumnMetaData

Get the type of column

isValid

public boolean isValid(Writable writable)

Description copied from interface: ColumnMetaData

Is the given Writable valid for this column, given the column type and any restrictions given by the ColumnMetaData object?

Parameters:

writable - Writable to check

Returns:

true if value, false if invalid

isValid

public boolean isValid(java.lang.Object input)

Is the given object valid for this column, given the column type and any restrictions given by the ColumnMetaData object?

Parameters:

input - object to check

Returns:

true if value, false if invalid

clone

public CategoricalMetaData clone()

Specified by:

clone in interface ColumnMetaData

Specified by:

clone in class BaseColumnMetaData

Returns:

getStateNames

public java.util.List<java.lang.String> getStateNames()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object