Module datarush.library

Package com.pervasive.datarush.tokens.scalar

Class DateRegister

java.lang.Object

com.pervasive.datarush.tokens.scalar.DateRegister

All Implemented Interfaces:

DataRegister, DateSettable, DateValued, ScalarRegister, ScalarSettable, ScalarValued, TokenSettable, TokenValued, ScalarTyped, TokenTyped, Serializable

public final class DateRegister
extends Object
implements ScalarRegister, DateSettable

A mutable DateValued object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DateRegister()	Creates a new null-valued register.

Method Summary

Modifier and Type	Method	Description
CalendarDate	asCalendarDate()	Gets the contained date value.
Date	asDate()	Gets the contained date value as a java.sql.Date relative to the default time zone.
Date	asDate(TimeZone tz)	Gets the contained date value as a java.sql.Date relative to the given time zone.
long	asEpochDays()	Gets the contained date value as the number of days since Java epoch (January 1, 1970).
ScalarTokenType	getType()	Gets the data type of the token.
boolean	isNull()	Indicates whether the token is null valued.
boolean	isZero()	Indicates whether the value is the zero value for the type.
void	set(long days)	Sets the container to a date value specified as the number of days since Java epoch (January 1, 1970 GMT).
void	set(CalendarDate date)	Sets the container to the specified calendar date.
void	set(TokenValued value)	Sets the contained value to the given token value.
void	set(Date date)	Sets the container to a date value specified as a java.util.Date object, relative to the default time zone.
void	set(Date date, TimeZone tz)	Sets the container to a date value specified as a java.util.Date object, relative to the given time zone.
void	setNull()	Sets the contained value to be null valued.
void	setZero()	Sets the contained value to be zero valued.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pervasive.datarush.types.ScalarTyped

getType

Methods inherited from interface com.pervasive.datarush.tokens.scalar.ScalarValued

getType, isZero

Methods inherited from interface com.pervasive.datarush.tokens.TokenValued

isNull

Constructor Detail

DateRegister

public DateRegister()

Creates a new null-valued register.

Method Detail

setNull

public void setNull()

Description copied from interface: TokenSettable

Sets the contained value to be null valued.

Specified by:

setNull in interface TokenSettable

setZero

public void setZero()

Description copied from interface: TokenSettable

Sets the contained value to be zero valued.

Specified by:

setZero in interface TokenSettable

set

public void set(Date date)

Description copied from interface: DateSettable

Sets the container to a date value specified as a java.util.Date object, relative to the default time zone. The time zone returned by TimeZone.getDefault() is used.

Specified by:

set in interface DateSettable

Parameters:

date - date value to which to set the container, expressed as a point in time relative to the default time zone

set

public void set(Date date,
                TimeZone tz)

Description copied from interface: DateSettable

Sets the container to a date value specified as a java.util.Date object, relative to the given time zone.

Specified by:

set in interface DateSettable

Parameters:

date - date value to which to set the container, expressed as a point in time relative to the specified time zone

tz - the time zone in which the date should be interpreted

set

public void set(long days)

Description copied from interface: DateSettable

Sets the container to a date value specified as the number of days since Java epoch (January 1, 1970 GMT).

Specified by:

set in interface DateSettable

Parameters:

days - date value to which to set the container, expressed as the number of days since Java epoch

set

public void set(CalendarDate date)

Description copied from interface: DateSettable

Sets the container to the specified calendar date.

Specified by:

set in interface DateSettable

Parameters:

date - value to which to set the container

set

public void set(TokenValued value)

Description copied from interface: TokenSettable

Sets the contained value to the given token value. The given value must have a type compatible with this object.

Specified by:

set in interface TokenSettable

Parameters:

value - the value to which to set the container

getType

public final ScalarTokenType getType()

Description copied from interface: TokenValued

Gets the data type of the token. This type will dictate the valid values that can be contained.

Specified by:

getType in interface ScalarTyped

Specified by:

getType in interface ScalarValued

Specified by:

getType in interface TokenTyped

Specified by:

getType in interface TokenValued

Returns:

the token type.

asEpochDays

public final long asEpochDays()

Description copied from interface: DateValued

Gets the contained date value as the number of days since Java epoch (January 1, 1970).

Specified by:

asEpochDays in interface DateValued

Returns:

the contained value as days since Java epoch. If null valued, as indicated by TokenValued.isNull(), 0 is returned.

asDate

public final Date asDate()

Description copied from interface: DateValued

Gets the contained date value as a java.sql.Date relative to the default time zone. The time zone used by TimeZone.getDefault() is used.

Specified by:

asDate in interface DateValued

Returns:

the contained value as a java.sql.Date. If null valued, as indicated by TokenValued.isNull(), null is returned.

asDate

public final Date asDate(TimeZone tz)

Description copied from interface: DateValued

Gets the contained date value as a java.sql.Date relative to the given time zone.

Specified by:

asDate in interface DateValued

Parameters:

tz - the time zone in which to interpret the date

Returns:

the contained value as a java.sql.Date. If null valued, as indicated by TokenValued.isNull(), null is returned.

asCalendarDate

public final CalendarDate asCalendarDate()

Description copied from interface: DateValued

Gets the contained date value. This value represents the timezone free date portion of a timestamp.

Specified by:

asCalendarDate in interface DateValued

Returns:

the contained value as a calendar date. If null valued, as indicated by TokenValued.isNull(), null is returned.

isZero

public final boolean isZero()

Description copied from interface: ScalarValued

Indicates whether the value is the zero value for the type. Zero values are not stored in sparse representation formats.

Specified by:

isZero in interface ScalarValued

Returns:

true if the value is the zero value, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

isNull

public final boolean isNull()

Description copied from interface: TokenValued

Indicates whether the token is null valued. Tokens support null values analogous to SQL. Before accessing the value of the container, it is usually best to ensure it is not null valued using this method.

Specified by:

isNull in interface TokenValued

Returns:

true if the token is null valued, false otherwise