Package oracle.kv.table

Interface TimestampValue

All Superinterfaces:

java.lang.Comparable<FieldValue>, FieldValue

public interface TimestampValue
extends FieldValue

TimestampValue extends FieldValue to represent a Timestamp value.

Since:

4.3

Method Summary

Modifier and Type	Method	Description
TimestampValue	clone()	Create a deep copy of this object.
java.sql.Timestamp	get()	Get the Timestamp value of this object.
int	getDay()	Returns the day of the Timestamp represented by this TimestampValue object.
int	getFracSecond()	Returns the fractional seconds of the Timestamp represented by this TimestampValue object.
int	getHour()	Returns the hour of the Timestamp represented by this TimestampValue object.
int	getMinute()	Returns the minute of the Timestamp represented by this TimestampValue object.
int	getMonth()	Returns the month of the Timestamp represented by this TimestampValue object.
int	getNano()	Returns the nanoseconds of the Timestamp represented by this TimestampValue object.
int	getSecond()	Returns the second of the Timestamp represented by this TimestampValue object.
int	getYear()	Returns the year of the Timestamp represented by this TimestampValue object.
java.lang.String	toString()	Formats the Timestamp value to a string with the default pattern TimestampDef.DEFAULT_PATTERN in UTC zone.
java.lang.String	toString(java.lang.String pattern, boolean withZoneUTC)	Formats the Timestamp value to a string with the specified pattern.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface oracle.kv.table.FieldValue

asArray, asBinary, asBoolean, asDouble, asEnum, asFixedBinary, asFloat, asIndexKey, asInteger, asLong, asMap, asNumber, asPrimaryKey, asRecord, asRow, asString, asTimestamp, getDefinition, getType, isArray, isAtomic, isBinary, isBoolean, isComplex, isDouble, isEMPTY, isEnum, isFixedBinary, isFloat, isIndexKey, isInteger, isJsonNull, isLong, isMap, isNull, isNumber, isNumeric, isPrimaryKey, isRecord, isRow, isString, isTimestamp, toJsonString

Method Detail

get

java.sql.Timestamp get()

Get the Timestamp value of this object.

Returns:

the Timestamp value

clone

TimestampValue clone()

Create a deep copy of this object.

Specified by:

clone in interface FieldValue

Returns:

a deep copy of this object

toString

java.lang.String toString()

Formats the Timestamp value to a string with the default pattern TimestampDef.DEFAULT_PATTERN in UTC zone.

Overrides:

toString in class java.lang.Object

Returns:

the formatted string

Throws:

java.lang.IllegalArgumentException - if failed to format the Timestamp value to a string with default pattern.

toString

java.lang.String toString(java.lang.String pattern,
                          boolean withZoneUTC)

Formats the Timestamp value to a string with the specified pattern.

Parameters:

pattern - the pattern for the timestampString. If null, then default pattern TimestampDef.DEFAULT_PATTERN is used to format to a string. The symbols that can be used to specify a pattern are described in DateTimeFormatter.

withZoneUTC - true if use UTC zone, otherwise the local time zone is used.

Returns:

the formatted string

Throws:

java.lang.IllegalArgumentException - if failed to format the Timestamp value to a string in format of given pattern.

getYear

int getYear()

Returns the year of the Timestamp represented by this TimestampValue object.

Returns:

the year

getMonth

int getMonth()

Returns the month of the Timestamp represented by this TimestampValue object.

Returns:

the month

getDay

int getDay()

Returns the day of the Timestamp represented by this TimestampValue object.

Returns:

the day

getHour

int getHour()

Returns the hour of the Timestamp represented by this TimestampValue object.

Returns:

the hour

getMinute

int getMinute()

Returns the minute of the Timestamp represented by this TimestampValue object.

Returns:

the minute

getSecond

int getSecond()

Returns the second of the Timestamp represented by this TimestampValue object.

Returns:

the second

getNano

int getNano()

Returns the nanoseconds of the Timestamp represented by this TimestampValue object.

Returns:

the nanoseconds

getFracSecond

int getFracSecond()

Returns the fractional seconds of the Timestamp represented by this TimestampValue object. The range of the number returned depends on the precision of the timestamp value. For example, if the precision is 3 (milli seconds), the number will be between 0 and 999. If the precision is 0, the returned number will always be 0.

Returns:

the fractional seconds.