org.datavec.api.transform.metadata

Class TimeMetaData

java.lang.Object

org.datavec.api.transform.metadata.TimeMetaData

All Implemented Interfaces:

Serializable, Cloneable, ColumnMetaData

public class TimeMetaData
extends Object
implements ColumnMetaData

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

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

TimeMetaData

public TimeMetaData()

Create a TimeMetaData column with no restrictions and UTC timezone.

TimeMetaData

public TimeMetaData(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(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(TimeZone timeZone,
                    Long minValidTime,
                    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(org.joda.time.DateTimeZone timeZone,
                    Long minValidTime,
                    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

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

Specified by:

clone in interface ColumnMetaData

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object