Package oracle.kv.table

Class FieldValueFactory

java.lang.Object

oracle.kv.table.FieldValueFactory

public class FieldValueFactory
extends java.lang.Object

Factory class to create FieldValue instance objects.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
FieldValueFactory()

Method Summary

Modifier and Type	Method	Description
static BinaryValue	createBinary(byte[] v)	Creates a BinaryValue instance from its java representation.
static BooleanValue	createBoolean(boolean v)	Creates a BooleanValue instance from its java representation.
static DoubleValue	createDouble(double v)	Creates a DoubleValue instance from its java representation.
static FloatValue	createFloat(float v)	Creates a FloatValue instance from its java representation.
static IntegerValue	createInteger(int v)	Creates a IntegerValue instance from its java representation.
static FieldValue	createJsonNull()	Creates a special FieldValue instance representing a JSON null value, which returns true from FieldValue.isJsonNull().
static LongValue	createLong(long v)	Creates a LongValue instance from its java representation.
static NumberValue	createNumber(double v)	Creates a NumberValue instance from a double value.
static NumberValue	createNumber(float v)	Creates a NumberValue instance from a float value.
static NumberValue	createNumber(int v)	Creates a NumberValue instance from a int value.
static NumberValue	createNumber(long v)	Creates a NumberValue instance from a long value.
static NumberValue	createNumber(java.math.BigDecimal v)	Creates a NumberValue instance from a BigDecimal value.
static StringValue	createString(java.lang.String v)	Creates a StringValue instance from its java representation.
static TimestampValue	createTimestamp(int year, int month, int day, int hour, int minute, int second, int fracSeconds, int precision)	Creates a TimestampValue instance from date time components.
static TimestampValue	createTimestamp(java.lang.String s, int precision)	Creates a TimestampValue instance from a string in format of TimestampDef.DEFAULT_PATTERN.
static TimestampValue	createTimestamp(java.sql.Timestamp v, int precision)	Creates a TimestampValue instance from its java representation.
static FieldValue	createValueFromJson(java.io.Reader jsonReader)	Creates a FieldValue instance from JSON input where the type is not known.
static FieldValue	createValueFromJson(java.lang.String jsonString)	Creates a FieldValue instance from JSON input where the type is not known.
static FieldValue	createValueFromJson(FieldDef type, java.io.InputStream jsonStream)	Creates a new value from a JSON doc (which is given as an InputStream).
static FieldValue	createValueFromJson(FieldDef type, java.io.Reader jsonReader)	Creates a new value from a JSON doc (which is given as a Reader).
static FieldValue	createValueFromJson(FieldDef type, java.lang.String jsonString)	Creates a new value from a JSON doc (which is given as a String).

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldValueFactory

public FieldValueFactory()

Method Detail

createValueFromJson

public static FieldValue createValueFromJson(java.lang.String jsonString)

Creates a FieldValue instance from JSON input where the type is not known. This method maps the JSON into a map (object) or array where the element type is JSON or one of the scalar types supporting JSON: INTEGER, LONG, FLOAT, DOUBLE, STRING, and BOOLEAN.

Parameters:

jsonString - the JSON representation

Returns:

a FieldValue

Throws:

java.lang.IllegalArgumentException - if the input is not valid JSON or the input cannot be parsed, or it cannot be mapped into supported data types.

Since:

4.2

createValueFromJson

public static FieldValue createValueFromJson(java.io.Reader jsonReader)
                                      throws java.io.IOException

Creates a FieldValue instance from JSON input where the type is not known. This method maps the JSON into a map (object) or array where the element type is JSON or one of the scalar types supporting JSON: INTEGER, LONG, FLOAT, DOUBLE, STRING, and BOOLEAN.

Parameters:

jsonReader - a Reader over JSON

Returns:

a FieldValue

Throws:

java.lang.IllegalArgumentException - if the input is not valid JSON or the input cannot be parsed, or it cannot be mapped into supported data types.

java.io.IOException - if the input is not valid JSON or the input cannot be parse, or it cannot be mapped into supported data types.

Since:

4.2

createValueFromJson

public static FieldValue createValueFromJson(FieldDef type,
                                             java.lang.String jsonString)

Creates a new value from a JSON doc (which is given as a String).

If type is RecordDef then:
(a) the JSON doc may have fields that do not appear in the record schema. Such fields are simply skipped.
(b) the JSON doc may be missing fields that appear in the record's schema. Such fields will remain unset in the record value. This means RecordValue.get(String) will return null and FieldValue.toJsonString(boolean) will skip unset fields.

If type is BINARY then the value must be a base64 encoded value.

Note: This methods doesn't handle arbitrary JSON, it has to comply to the given type. Also, top level null is not supported.

Parameters:

type - the type definition of the instance.

jsonString - the JSON representation

Returns:

the newly created instance

Throws:

java.lang.IllegalArgumentException - for invalid documents

createValueFromJson

public static FieldValue createValueFromJson(FieldDef type,
                                             java.io.Reader jsonReader)
                                      throws java.io.IOException

Creates a new value from a JSON doc (which is given as a Reader). If type is RecordDef then: (a) the JSON doc may have fields that do not appear in the record schema. Such fields are simply skipped. (b) the JSON doc may be missing fields that appear in the record's schema. Such fields will remain unset in the record value. If type is BINARY then the value must be a base64 encoded value. Note: This methods doesn't handle arbitrary JSON, it has to comply to the given type. Also, top level null is not supported.

Parameters:

type - the type definition of the instance.

jsonReader - the JSON representation

Returns:

the newly created instance

Throws:

java.lang.IllegalArgumentException - for invalid documents

java.io.IOException - for an invalid Reader

createValueFromJson

public static FieldValue createValueFromJson(FieldDef type,
                                             java.io.InputStream jsonStream)
                                      throws java.io.IOException

Creates a new value from a JSON doc (which is given as an InputStream). If type is RecordDef then: (a) the JSON doc may have fields that do not appear in the record schema. Such fields are simply skipped. (b) the JSON doc may be missing fields that appear in the record's schema. Such fields will remain unset in the record value. If type is BINARY then the value must be a base64 encoded value. Note: This methods doesn't handle arbitrary JSON, it has to comply to the given type. Also, top level null is not supported.

Parameters:

type - the type definition of the instance.

jsonStream - the JSON representation

Returns:

the newly created instance

Throws:

java.lang.IllegalArgumentException - for invalid documents

java.io.IOException - for an invalid InputStream

createBinary

public static BinaryValue createBinary(byte[] v)

Creates a BinaryValue instance from its java representation.

Parameters:

v - the java value

Returns:

the newly created instance

createBoolean

public static BooleanValue createBoolean(boolean v)

Creates a BooleanValue instance from its java representation.

Parameters:

v - the java value

Returns:

the newly created instance

createDouble

public static DoubleValue createDouble(double v)

Creates a DoubleValue instance from its java representation.

Parameters:

v - the java value

Returns:

the newly created instance

createFloat

public static FloatValue createFloat(float v)

Creates a FloatValue instance from its java representation.

Parameters:

v - the java value

Returns:

the newly created instance

createInteger

public static IntegerValue createInteger(int v)

Creates a IntegerValue instance from its java representation.

Parameters:

v - the java value

Returns:

the newly created instance

createLong

public static LongValue createLong(long v)

Creates a LongValue instance from its java representation.

Parameters:

v - the java value

Returns:

the newly created instance

createNumber

public static NumberValue createNumber(int v)

Creates a NumberValue instance from a int value.

Parameters:

v - the java value

Returns:

the newly created instance

Since:

4.4

createNumber

public static NumberValue createNumber(long v)

Creates a NumberValue instance from a long value.

Parameters:

v - the java value

Returns:

the newly created instance

Since:

4.4

createNumber

public static NumberValue createNumber(float v)

Creates a NumberValue instance from a float value.

Parameters:

v - the java value

Returns:

the newly created instance

Since:

4.4

createNumber

public static NumberValue createNumber(double v)

Creates a NumberValue instance from a double value.

Parameters:

v - the java value

Returns:

the newly created instance

Since:

4.4

createNumber

public static NumberValue createNumber(java.math.BigDecimal v)

Creates a NumberValue instance from a BigDecimal value.

Parameters:

v - the java value

Returns:

the newly created instance

Since:

4.4

createJsonNull

public static FieldValue createJsonNull()

Creates a special FieldValue instance representing a JSON null value, which returns true from FieldValue.isJsonNull().

Returns:

the newly created instance

Since:

4.3

createString

public static StringValue createString(java.lang.String v)

Creates a StringValue instance from its java representation.

Parameters:

v - the java value

Returns:

the newly created instance

createTimestamp

public static TimestampValue createTimestamp(java.sql.Timestamp v,
                                             int precision)

Creates a TimestampValue instance from its java representation.

Parameters:

v - the java value

precision - the precision of Timestamp value

Returns:

the newly created instance

Throws:

java.lang.IllegalArgumentException - if precision is invalid.

createTimestamp

public static TimestampValue createTimestamp(java.lang.String s,
                                             int precision)

Creates a TimestampValue instance from a string in format of TimestampDef.DEFAULT_PATTERN.

Parameters:

s - the string value

precision - the precision of Timestamp value

Returns:

the newly created instance

Throws:

java.lang.IllegalArgumentException - if precision is invalid or the string is not in the format of TimestampDef.DEFAULT_PATTERN.

createTimestamp

public static TimestampValue createTimestamp(int year,
                                             int month,
                                             int day,
                                             int hour,
                                             int minute,
                                             int second,
                                             int fracSeconds,
                                             int precision)

Creates a TimestampValue instance from date time components.

Parameters:

year - the year, from -6383 to 9999.

month - the month of year, from 1 to 12

day - the day of month, from 1 to 31

hour - the hour of day, from 0 to 23

minute - the minute of hour, from 0 to 59

second - the second of minute, from 0 to 59

fracSeconds - the number of fractional seconds in the specified precision. e.g. if precision is 3, then fractional seconds can be a value within the range 0 ~ 999.

precision - the precision of Timestamp value

Returns:

the newly created instance

Throws:

java.lang.IllegalArgumentException - if precision is invalid or any component is invalid.