org.datavec.api.transform.metadata

Class TimeMetaData

java.lang.Object

org.datavec.api.transform.metadata.BaseColumnMetaData

org.datavec.api.transform.metadata.TimeMetaData

All Implemented Interfaces:

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

public class TimeMetaData
extends BaseColumnMetaData

TimeMetaData: Meta data for a date/time column. NOTE: Time values are stored in epoch (millisecond) format.

See Also:

Serialized Form

Field Summary

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

name

Constructor Summary

Constructors

Constructor and Description
TimeMetaData(java.lang.String name) Create a TimeMetaData column with no restrictions and UTC timezone.
TimeMetaData(java.lang.String name, org.joda.time.DateTimeZone timeZone) Create a TimeMetaData column with no restriction on the allowable times
TimeMetaData(java.lang.String name, org.joda.time.DateTimeZone timeZone, java.lang.Long minValidTime, java.lang.Long maxValidTime)
TimeMetaData(java.lang.String name, java.util.TimeZone timeZone) Create a TimeMetaData column with no restriction on the allowable times
TimeMetaData(java.lang.String name, java.util.TimeZone timeZone, java.lang.Long minValidTime, java.lang.Long maxValidTime)

Method Summary

Modifier and Type	Method and Description
TimeMetaData	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

TimeMetaData

public TimeMetaData(java.lang.String name)

Create a TimeMetaData column with no restrictions and UTC timezone.

TimeMetaData

public TimeMetaData(java.lang.String name,
                    java.util.TimeZone timeZone)

Create a TimeMetaData column with no restriction on the allowable times

Parameters:

timeZone - Timezone for this column. Typically used for parsing

TimeMetaData

public TimeMetaData(java.lang.String name,
                    org.joda.time.DateTimeZone timeZone)

Create a TimeMetaData column with no restriction on the allowable times

Parameters:

timeZone - Timezone for this column.

TimeMetaData

public TimeMetaData(java.lang.String name,
                    java.util.TimeZone timeZone,
                    java.lang.Long minValidTime,
                    java.lang.Long maxValidTime)

Parameters:

timeZone - Timezone for this column. Typically used for parsing and some transforms

minValidTime - Minimum valid time, in milliseconds (timestamp format). If null: no restriction

maxValidTime - Maximum valid time, in milliseconds (timestamp format). If null: no restriction

TimeMetaData

public TimeMetaData(java.lang.String name,
                    org.joda.time.DateTimeZone timeZone,
                    java.lang.Long minValidTime,
                    java.lang.Long maxValidTime)

Parameters:

timeZone - Timezone for this column. Typically used for parsing and some transforms

minValidTime - Minimum valid time, in milliseconds (timestamp format). If null: no restriction

maxValidTime - Maximum valid time, in milliseconds (timestamp format). If null: no restriction

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 TimeMetaData 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