org.datavec.api.transform.metadata

Class StringMetaData

java.lang.Object

org.datavec.api.transform.metadata.StringMetaData

All Implemented Interfaces:

Serializable, Cloneable, ColumnMetaData

public class StringMetaData
extends Object
implements ColumnMetaData

Metadata for an String column

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
StringMetaData	clone()
ColumnType	getColumnType() Get the type of column
boolean	isValid(Writable writable) Is the given Writable valid for this column, given the column type and any restrictions given by the ColumnMetaData object?
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StringMetaData

public StringMetaData()

Default constructor with no restrictions on allowable strings

StringMetaData

public StringMetaData(String mustMatchRegex,
                      Integer minLength,
                      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

Specified by:

getColumnType in interface ColumnMetaData

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?

Specified by:

isValid in interface ColumnMetaData

Parameters:

writable - Writable to check

Returns:

true if value, false if invalid

clone

public StringMetaData clone()

Specified by:

clone in interface ColumnMetaData

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object