org.datavec.api.transform.metadata

Class StringMetaData

java.lang.Object

org.datavec.api.transform.metadata.BaseColumnMetaData

org.datavec.api.transform.metadata.StringMetaData

All Implemented Interfaces:

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

public class StringMetaData
extends BaseColumnMetaData

Metadata for an String column

See Also:

Serialized Form

Field Summary

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

name

Constructor Summary

Constructors

Constructor and Description
StringMetaData()
StringMetaData(java.lang.String name) Default constructor with no restrictions on allowable strings
StringMetaData(java.lang.String name, java.lang.String mustMatchRegex, java.lang.Integer minLength, java.lang.Integer maxLength)

Method Summary

Modifier and Type	Method and Description
StringMetaData	clone()
ColumnType	getColumnType() Get the type of column
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

StringMetaData

public StringMetaData()

StringMetaData

public StringMetaData(java.lang.String name)

Default constructor with no restrictions on allowable strings

StringMetaData

public StringMetaData(java.lang.String name,
                      java.lang.String mustMatchRegex,
                      java.lang.Integer minLength,
                      java.lang.Integer maxLength)

Parameters:

mustMatchRegex - Nullable. If not null: this is a regex that each string must match in order for the entry to be considered valid.

minLength - Min allowable String length. If null: no restriction on min String length

maxLength - Max allowable String length. If null: no restriction on max String length

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 StringMetaData clone()

Specified by:

clone in interface ColumnMetaData

Specified by:

clone in class BaseColumnMetaData

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object