Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.iapi.types.DataValueFactory

Method Summary

Modifier and Type	Method and Description
public BitDataValue	getBitDataValue(byte[] value) Get a SQL bit with the given value.
public BitDataValue	getBitDataValue(byte[] value, BitDataValue previous)
public BitDataValue	getBlobDataValue(byte[] value, BitDataValue previous) Get a SQL Blob with the given value.
public BitDataValue	getBlobDataValue(Blob value, BitDataValue previous) Get a SQL Blob with the given value.
public RuleBasedCollator	Returns: Collator null if the collation type is UCS_BASIC. Collator based on territory if the collation type is TERRITORY_BASED getCharacterCollator(int This will be UCS_BASIC or TERRITORY_BASED collationType) Return the RuleBasedCollator depending on the collation type.
public StringDataValue	getCharDataValue(String value) Get a new SQLChar object to represent a SQL CHAR (UCS_BASIC) with the given value.
public StringDataValue	getCharDataValue(String value, StringDataValue previous) Get a SQLChar object to represent a SQL CHAR (UCS_BASIC with the given value.
public StringDataValue	getCharDataValue(String value, StringDataValue previous, int collationType) Get a StringDataValue to represent a SQL CHAR with the passed in collationType.
public StringDataValue	getClobDataValue(String value, StringDataValue previous) Get a SQLClob object to represent a SQL CLOB (UCS_BASIC) with the given value.
public StringDataValue	getClobDataValue(Clob value, StringDataValue previous) Get a SQLClob object to represent a SQL CLOB (UCS_BASIC) with the given value.
public StringDataValue	getClobDataValue(String value, StringDataValue previous, int collationType) Get a StringDataValue to represent a SQL LONG VARCHAR with the passed in collationType.
public StringDataValue	getClobDataValue(Clob value, StringDataValue previous, int collationType) Get a StringDataValue to represent a SQL CLOB with the passed in collationType.
public NumberDataValue	getDataValue(Integer value, NumberDataValue previous) Get a SQL int with the given value.
public NumberDataValue	getDataValue(char value, NumberDataValue previous) Get a SQL int with a char value.
public NumberDataValue	getDataValue(Short value, NumberDataValue previous) Get a SQL smallint with the given value.
public NumberDataValue	getDataValue(Byte value, NumberDataValue previous) Get a SQL TINYINT with the given value.
public NumberDataValue	getDataValue(Long value, NumberDataValue previous) Get a SQL bigint with the given value.
public NumberDataValue	getDataValue(Float value, NumberDataValue previous) Get a SQL real with the given value.
public NumberDataValue	getDataValue(Double value, NumberDataValue previous) Get a SQL double precision with the given value.
public BooleanDataValue	getDataValue(Boolean value, BooleanDataValue previous) Get a SQL boolean with the given value.
public UserDataValue	getDataValue(Object value, UserDataValue previous) Get a User-defined data value with the given value and type name.
public RefDataValue	getDataValue(RowLocation value, RefDataValue previous) Get a RefDataValue with the given value.
public NumberDataValue	getDataValue(int value, NumberDataValue previous) Get a SQL int with the given value.
public NumberDataValue	getDataValue(long value, NumberDataValue previous) Get a SQL bigint with the given value.
public NumberDataValue	getDataValue(float value, NumberDataValue previous) Get a SQL real with the given value.
public NumberDataValue	getDataValue(double value, NumberDataValue previous) Get a SQL double precision with the given value.
public NumberDataValue	getDataValue(short value, NumberDataValue previous) Get a SQL SMALLINT with the given value.
public NumberDataValue	getDataValue(byte value, NumberDataValue previous) Get a SQL TINYINT with the given value.
public BooleanDataValue	getDataValue(boolean value, BooleanDataValue previous) Get a SQL boolean with the given value.
public DateTimeDataValue	getDataValue(Date value, DateTimeDataValue previous) Get a SQL date with the given value.
public DateTimeDataValue	getDataValue(Time value, DateTimeDataValue previous) Get a SQL time with the given value.
public DateTimeDataValue	getDataValue(Timestamp value, DateTimeDataValue previous) Get a SQL timestamp with the given value.
public DateTimeDataValue	Returns: the corresponding date value getDate(DataValueDescriptor A date, timestamp, string or integer. operand) Implements the SQL date function
public DateTimeDataValue	Returns: A DateTimeDataValue getDateValue(String A date in one of the DB2 standard date formats or the local format. dateStr, boolean If true then the timestamp must be in the JDBC timestamp escape format, otherwise it must be in the DB2 timestamp format. isJdbcEscape)
public NumberDataValue	getDecimalDataValue(Number value, NumberDataValue previous) Get a SQL DECIMAL with the given value.
public BitDataValue	getLongVarbitDataValue(byte[] value, BitDataValue previous) Get a SQL Long Bit Varying with the given value.
public StringDataValue	getLongvarcharDataValue(String value) Get a SQL long varchar with the given value.
public StringDataValue	getLongvarcharDataValue(String value, StringDataValue previous) Get a SQLLongvarchar object to represent a SQL LONG VARCHAR (UCS_BASIC) with the given value.
public StringDataValue	getLongvarcharDataValue(String value, StringDataValue previous, int collationType) Get a StringDataValue to represent a SQL LONG VARCHAR with the passed in collationType.
public DataValueDescriptor	Returns: DataValueDescriptor which will be constructed using the passed parameters getNull(int Format id for the DVD formatId, int this is meaningful only for character types. collationType) Return an object based on the format id and collation type.
public BitDataValue	getNullBit(BitDataValue dataValue) Get a SQL Bit with a SQL null value.
public BitDataValue	getNullBlob(BitDataValue dataValue) Get a SQL Blob with a SQL null value.
public BooleanDataValue	getNullBoolean(BooleanDataValue dataValue) Get a SQL boolean with a SQL null value.
public NumberDataValue	getNullByte(NumberDataValue dataValue) Get a SQL tinyint with a SQL null value.
public StringDataValue	getNullChar(StringDataValue dataValue) Get a SQL CHAR (UCS_BASIC) with a SQL null value.
public StringDataValue	getNullChar(StringDataValue dataValue, int collationType) Get a SQL CHAR set to NULL with collation set to collationType.
public StringDataValue	getNullClob(StringDataValue dataValue) Get a SQL CLOB (UCS_BASIC) with a SQL null value.
public StringDataValue	getNullClob(StringDataValue dataValue, int collationType) Get a SQL CLOB set to NULL with collation set to collationType.
public DateTimeDataValue	getNullDate(DateTimeDataValue dataValue) Get a SQL date with a SQL null value.
public NumberDataValue	getNullDecimal(NumberDataValue dataValue) Get a SQL Decimal/Numeric with a SQL null value.
public NumberDataValue	getNullDouble(NumberDataValue dataValue) Get a SQL double with a SQL null value.
public NumberDataValue	getNullFloat(NumberDataValue dataValue) Get a SQL float with a SQL null value.
public NumberDataValue	getNullInteger(NumberDataValue dataValue) Get a SQL int with a SQL null value.
public NumberDataValue	getNullLong(NumberDataValue dataValue) Get a SQL bigint with a SQL null value.
public BitDataValue	getNullLongVarbit(BitDataValue dataValue) Get a SQL Long Bit Varying with a SQL null value.
public StringDataValue	getNullLongvarchar(StringDataValue dataValue) Get a SQL LONG VARCHAR (UCS_BASIC) with a SQL null value.
public StringDataValue	getNullLongvarchar(StringDataValue dataValue, int collationType) Get a SQL LONG VARCHAR set to NULL with collation set to collationType.
public UserDataValue	getNullObject(UserDataValue dataValue) Get a User-defined data value with a SQL null value.
public RefDataValue	getNullRef(RefDataValue dataValue) Get a RefDataValue with a SQL null value.
public NumberDataValue	getNullShort(NumberDataValue dataValue) Get a SQL smallint with a SQL null value.
public DateTimeDataValue	getNullTime(DateTimeDataValue dataValue) Get a SQL time with a SQL null value.
public DateTimeDataValue	getNullTimestamp(DateTimeDataValue dataValue) Get a SQL timestamp with a SQL null value.
public BitDataValue	getNullVarbit(BitDataValue dataValue) Get a SQL Bit Varying with a SQL null value.
public StringDataValue	getNullVarchar(StringDataValue dataValue) Get a SQL VARCHAR (UCS_BASIC) with a SQL null value.
public StringDataValue	getNullVarchar(StringDataValue dataValue, int collationType) Get a SQL VARCHAR set to NULL with collation set to collationType.
public XMLDataValue	getNullXML(XMLDataValue dataValue) Get an XML with a SQL null value.
public DateTimeDataValue	getTimestamp(DataValueDescriptor Must be a timestamp or a string convertible to a timestamp. operand) Implement the timestamp SQL function: construct a SQL timestamp from a string, or timestamp.
public DateTimeDataValue	getTimestamp(DataValueDescriptor Must be convertible to a date. date, DataValueDescriptor Must be convertible to a time. time) Construct a SQL timestamp from a date and time.
public DateTimeDataValue	Returns: An internal timestamp getTimestampValue(String A time in string format. timestampStr, boolean If true then the time must be in the JDBC time escape format, otherwise it must be in the DB2 time format. isJdbcEscape)
public DateTimeDataValue	Returns: A DateTimeDataValue getTimeValue(String A date in one of the DB2 standard time formats or the local format. timeStr, boolean If true then the timestamp must be in the JDBC time escape format, otherwise it must be in the DB2 time format. isJdbcEscape)
public BitDataValue	getVarbitDataValue(byte[] value, BitDataValue previous) Get a SQL bit with the given value.
public StringDataValue	getVarcharDataValue(String value) Get a SQL varchar with the given value.
public StringDataValue	getVarcharDataValue(String value, StringDataValue previous) Get a SQLVarhar object to represent a SQL VARCHAR (UCS_BASIC) with the given value.
public StringDataValue	getVarcharDataValue(String value, StringDataValue previous, int collationType) Get a StringDataValue to represent a SQL VARCHAR with the passed in collationType.
public XMLDataValue	getXMLDataValue(XMLDataValue previous) Get a null XML value.

Method Detail

getBitDataValue	back to summary
public BitDataValue getBitDataValue(byte[] value) throws StandardException Get a SQL bit with the given value. The second form re-uses the previous value, if non-null, as the data holder to return. Exceptions StandardException: Thrown on error

getBitDataValue

back to summary

public BitDataValue getBitDataValue(byte[] value) throws StandardException

Get a SQL bit with the given value. The second form re-uses the previous value, if non-null, as the data holder to return.

Exceptions

StandardException:: Thrown on error

getBitDataValue	back to summary
public BitDataValue getBitDataValue(byte[] value, BitDataValue previous) throws StandardException

getBlobDataValue	back to summary
public BitDataValue getBlobDataValue(byte[] value, BitDataValue previous) throws StandardException Get a SQL Blob with the given value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value. Exceptions StandardException: Thrown on error

getBlobDataValue

back to summary

public BitDataValue getBlobDataValue(byte[] value, BitDataValue previous) throws StandardException

Get a SQL Blob with the given value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value.

Exceptions

StandardException:: Thrown on error

getBlobDataValue	back to summary
public BitDataValue getBlobDataValue(Blob value, BitDataValue previous) throws StandardException Get a SQL Blob with the given value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value. Exceptions StandardException: Thrown on error

getBlobDataValue

back to summary

public BitDataValue getBlobDataValue(Blob value, BitDataValue previous) throws StandardException

Get a SQL Blob with the given value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value.

Exceptions

StandardException:: Thrown on error

getCharacterCollator	back to summary
public RuleBasedCollator getCharacterCollator(int collationType) throws StandardException Return the RuleBasedCollator depending on the collation type. If the collation type is UCS_BASIC, then this method will return null. If the collation type is TERRITORY_BASED then the return value will be the Collator derived from the database's locale. If this is the first time Collator is being requested for a database with collation type of TERRITORY_BASED, then we will check to make sure that JVM supports the Collator for the database's locale. If not, we will throw an exception This method will be used when Store code is trying to create a DVD template row using the format ids and the collation types. First a DVD will be constructed just using format id. Then if the DVD is of type StringDataValue, then it will call this method to get the Collator object. If the Collator object returned from this method is null then we will continue to use the default DVDs for the character types, ie the DVDs which just use the JVM's default collation. (This is why, we want this method to return null if we are dealing with UCS_BASIC.) If the Collator object returned is not null, then we will construct collation sensitive DVD for the character types. So, the return value of this method determines if we are going to create a character DVD with default collation or with custom collation. Parameters collationType:int This will be UCS_BASIC or TERRITORY_BASED Returns:RuleBasedCollator Collator null if the collation type is UCS_BASIC. Collator based on territory if the collation type is TERRITORY_BASED

getCharacterCollator

back to summary

public RuleBasedCollator getCharacterCollator(int collationType) throws StandardException

Return the RuleBasedCollator depending on the collation type. If the collation type is UCS_BASIC, then this method will return null. If the collation type is TERRITORY_BASED then the return value will be the Collator derived from the database's locale. If this is the first time Collator is being requested for a database with collation type of TERRITORY_BASED, then we will check to make sure that JVM supports the Collator for the database's locale. If not, we will throw an exception This method will be used when Store code is trying to create a DVD template row using the format ids and the collation types. First a DVD will be constructed just using format id. Then if the DVD is of type StringDataValue, then it will call this method to get the Collator object. If the Collator object returned from this method is null then we will continue to use the default DVDs for the character types, ie the DVDs which just use the JVM's default collation. (This is why, we want this method to return null if we are dealing with UCS_BASIC.) If the Collator object returned is not null, then we will construct collation sensitive DVD for the character types. So, the return value of this method determines if we are going to create a character DVD with default collation or with custom collation.

Parameters

collationType:int: This will be UCS_BASIC or TERRITORY_BASED

Returns:RuleBasedCollator

Collator null if the collation type is UCS_BASIC. Collator based on territory if the collation type is TERRITORY_BASED

getCharDataValue	back to summary
public StringDataValue getCharDataValue(String value) Get a new SQLChar object to represent a SQL CHAR (UCS_BASIC) with the given value. A null argument means get a SQL NULL value.

getCharDataValue	back to summary
public StringDataValue getCharDataValue(String value, StringDataValue previous) throws StandardException Get a SQLChar object to represent a SQL CHAR (UCS_BASIC with the given value. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new SQLChar will be created and set to the value.

getCharDataValue	back to summary
public StringDataValue getCharDataValue(String value, StringDataValue previous, int collationType) throws StandardException Get a StringDataValue to represent a SQL CHAR with the passed in collationType. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new StringDataValue will be created and set to the value. If collationType is equal to StringDataValue.COLLATION_TYPE_UCS_BASIC then the call is the equivalent of the overload without collationType.

getCharDataValue

back to summary

public StringDataValue getCharDataValue(String value, StringDataValue previous, int collationType) throws StandardException

Get a StringDataValue to represent a SQL CHAR with the passed in collationType. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new StringDataValue will be created and set to the value. If collationType is equal to StringDataValue.COLLATION_TYPE_UCS_BASIC then the call is the equivalent of the overload without collationType.

getClobDataValue	back to summary
public StringDataValue getClobDataValue(String value, StringDataValue previous) throws StandardException Get a SQLClob object to represent a SQL CLOB (UCS_BASIC) with the given value. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new SQLLongvarchar will be created and set to the value.

getClobDataValue

back to summary

public StringDataValue getClobDataValue(String value, StringDataValue previous) throws StandardException

Get a SQLClob object to represent a SQL CLOB (UCS_BASIC) with the given value. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new SQLLongvarchar will be created and set to the value.

getClobDataValue	back to summary
public StringDataValue getClobDataValue(Clob value, StringDataValue previous) throws StandardException Get a SQLClob object to represent a SQL CLOB (UCS_BASIC) with the given value. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new SQLLongvarchar will be created and set to the value.

getClobDataValue

back to summary

public StringDataValue getClobDataValue(Clob value, StringDataValue previous) throws StandardException

getClobDataValue	back to summary
public StringDataValue getClobDataValue(String value, StringDataValue previous, int collationType) throws StandardException Get a StringDataValue to represent a SQL LONG VARCHAR with the passed in collationType. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new StringDataValue will be created and set to the value. If collationType is equal to StringDataValue.COLLATION_TYPE_UCS_BASIC then the call is the equivalent of the overload without collationType.

getClobDataValue

back to summary

public StringDataValue getClobDataValue(String value, StringDataValue previous, int collationType) throws StandardException

Get a StringDataValue to represent a SQL LONG VARCHAR with the passed in collationType. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new StringDataValue will be created and set to the value. If collationType is equal to StringDataValue.COLLATION_TYPE_UCS_BASIC then the call is the equivalent of the overload without collationType.

getClobDataValue	back to summary
public StringDataValue getClobDataValue(Clob value, StringDataValue previous, int collationType) throws StandardException Get a StringDataValue to represent a SQL CLOB with the passed in collationType. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new StringDataValue will be created and set to the value. If collationType is equal to StringDataValue.COLLATION_TYPE_UCS_BASIC then the call is the equivalent of the overload without collationType.

getClobDataValue

back to summary

public StringDataValue getClobDataValue(Clob value, StringDataValue previous, int collationType) throws StandardException

Get a StringDataValue to represent a SQL CLOB with the passed in collationType. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new StringDataValue will be created and set to the value. If collationType is equal to StringDataValue.COLLATION_TYPE_UCS_BASIC then the call is the equivalent of the overload without collationType.

getDataValue	back to summary
public NumberDataValue getDataValue(Integer value, NumberDataValue previous) throws StandardException Get a SQL int with the given value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value.

getDataValue	back to summary
public NumberDataValue getDataValue(char value, NumberDataValue previous) throws StandardException Get a SQL int with a char value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value.

getDataValue	back to summary
public NumberDataValue getDataValue(Short value, NumberDataValue previous) throws StandardException Get a SQL smallint with the given value. A null argument means get a SQL null value. The second arg uses the previous value (if non-null) to hold the return value.

getDataValue	back to summary
public NumberDataValue getDataValue(Byte value, NumberDataValue previous) throws StandardException Get a SQL TINYINT with the given value. A null argument means get a SQL null value. The second arg uses the previous value (if non-null) to hold the return value.

getDataValue	back to summary
public NumberDataValue getDataValue(Long value, NumberDataValue previous) throws StandardException Get a SQL bigint with the given value. A null argument means get a SQL null value. The second arg uses the previous value (if non-null) to hold the return value.

getDataValue	back to summary
public NumberDataValue getDataValue(Float value, NumberDataValue previous) throws StandardException Get a SQL real with the given value. A null argument means get a SQL null value. The second arg uses the previous value (if non-null) to hold the return value.

getDataValue	back to summary
public NumberDataValue getDataValue(Double value, NumberDataValue previous) throws StandardException Get a SQL double precision with the given value. A null argument means a SQL null value. The second arg uses the previous value (if non-null) to hold the return value. Exceptions StandardException: Thrown on error

getDataValue

back to summary

public NumberDataValue getDataValue(Double value, NumberDataValue previous) throws StandardException

Get a SQL double precision with the given value. A null argument means a SQL null value. The second arg uses the previous value (if non-null) to hold the return value.

Exceptions

StandardException:: Thrown on error

getDataValue	back to summary
public BooleanDataValue getDataValue(Boolean value, BooleanDataValue previous) throws StandardException Get a SQL boolean with the given value. A null argument means get a SQL null value. The second arg uses the previous value (if non-null) to hold the return value.

getDataValue	back to summary
public UserDataValue getDataValue(Object value, UserDataValue previous) Get a User-defined data value with the given value and type name. A null argument means get a SQL null value. The second arg uses the previous value (if non-null) hold the return value.

getDataValue	back to summary
public RefDataValue getDataValue(RowLocation value, RefDataValue previous) Get a RefDataValue with the given value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value.

getDataValue	back to summary
public NumberDataValue getDataValue(int value, NumberDataValue previous) throws StandardException Get a SQL int with the given value. The second arg re-uses the previous value, if non-null, as the data holder to return.

getDataValue	back to summary
public NumberDataValue getDataValue(long value, NumberDataValue previous) throws StandardException Get a SQL bigint with the given value. The second arg re-uses the previous value, if non-null, as the data holder to return.

getDataValue	back to summary
public NumberDataValue getDataValue(float value, NumberDataValue previous) throws StandardException Get a SQL real with the given value. Uses the previous value, if non-null, as the data holder to return. Exceptions StandardException: Thrown on error

getDataValue

back to summary

public NumberDataValue getDataValue(float value, NumberDataValue previous) throws StandardException

Get a SQL real with the given value. Uses the previous value, if non-null, as the data holder to return.

Exceptions

StandardException:: Thrown on error

getDataValue	back to summary
public NumberDataValue getDataValue(double value, NumberDataValue previous) throws StandardException Get a SQL double precision with the given value. Uses the previous value, if non-null, as the data holder to return. Exceptions StandardException: Thrown on error

getDataValue

back to summary

public NumberDataValue getDataValue(double value, NumberDataValue previous) throws StandardException

Get a SQL double precision with the given value. Uses the previous value, if non-null, as the data holder to return.

Exceptions

StandardException:: Thrown on error

getDataValue	back to summary
public NumberDataValue getDataValue(short value, NumberDataValue previous) throws StandardException Get a SQL SMALLINT with the given value. Uses the previous value, if non-null, as the data holder to return.

getDataValue	back to summary
public NumberDataValue getDataValue(byte value, NumberDataValue previous) throws StandardException Get a SQL TINYINT with the given value. Uses the previous value, if non-null, as the data holder to return.

getDataValue	back to summary
public BooleanDataValue getDataValue(boolean value, BooleanDataValue previous) throws StandardException Get a SQL boolean with the given value. The second arg re-uses the previous value, if non-null, as the data holder to return.

getDataValue	back to summary
public DateTimeDataValue getDataValue(Date value, DateTimeDataValue previous) throws StandardException Get a SQL date with the given value. A null argument means get a SQL null value. The second arg re-uses the previous value, if non-null, as the data holder to return.

getDataValue	back to summary
public DateTimeDataValue getDataValue(Time value, DateTimeDataValue previous) throws StandardException Get a SQL time with the given value. A null argument means get a SQL null value. The second arg re-uses the previous value, if non-null, as the data holder to return.

getDataValue	back to summary
public DateTimeDataValue getDataValue(Timestamp value, DateTimeDataValue previous) throws StandardException Get a SQL timestamp with the given value. A null argument means get a SQL null value. The second arg re-uses the previous value, if non-null, as the data holder to return.

getDate	back to summary
public DateTimeDataValue getDate(DataValueDescriptor operand) throws StandardException Implements the SQL date function Parameters operand:DataValueDescriptor A date, timestamp, string or integer. Returns:DateTimeDataValue the corresponding date value Exceptions StandardException: if the syntax is invalid or the date is out of range.

getDate

back to summary

public DateTimeDataValue getDate(DataValueDescriptor operand) throws StandardException

Implements the SQL date function

Parameters

operand:DataValueDescriptor: A date, timestamp, string or integer.

Returns:DateTimeDataValue

the corresponding date value

Exceptions

StandardException:: if the syntax is invalid or the date is out of range.

getDateValue	back to summary
public DateTimeDataValue getDateValue(String dateStr, boolean isJdbcEscape) throws StandardException Parameters dateStr:String A date in one of the DB2 standard date formats or the local format. isJdbcEscape:boolean If true then the timestamp must be in the JDBC timestamp escape format, otherwise it must be in the DB2 timestamp format. Returns:DateTimeDataValue A DateTimeDataValue Exceptions StandardException: if the syntax is invalid or the date is out of range.

getDateValue

back to summary

public DateTimeDataValue getDateValue(String dateStr, boolean isJdbcEscape) throws StandardException

Parameters

dateStr:String: A date in one of the DB2 standard date formats or the local format.
isJdbcEscape:boolean: If true then the timestamp must be in the JDBC timestamp escape format, otherwise it must be in the DB2 timestamp format.

Returns:DateTimeDataValue

A DateTimeDataValue

Exceptions

StandardException:: if the syntax is invalid or the date is out of range.

getDecimalDataValue	back to summary
public NumberDataValue getDecimalDataValue(Number value, NumberDataValue previous) throws StandardException Get a SQL DECIMAL with the given value. Uses the previous value, if non-null, as the data holder to return. Exceptions StandardException: Thrown on error

getDecimalDataValue

back to summary

public NumberDataValue getDecimalDataValue(Number value, NumberDataValue previous) throws StandardException

Get a SQL DECIMAL with the given value. Uses the previous value, if non-null, as the data holder to return.

Exceptions

StandardException:: Thrown on error

getLongVarbitDataValue	back to summary
public BitDataValue getLongVarbitDataValue(byte[] value, BitDataValue previous) throws StandardException Get a SQL Long Bit Varying with the given value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value. Exceptions StandardException: Thrown on error

getLongVarbitDataValue

back to summary

public BitDataValue getLongVarbitDataValue(byte[] value, BitDataValue previous) throws StandardException

Get a SQL Long Bit Varying with the given value. A null argument means get a SQL null value. Uses the previous value (if non-null) to hold the return value.

Exceptions

StandardException:: Thrown on error

getLongvarcharDataValue	back to summary
public StringDataValue getLongvarcharDataValue(String value) Get a SQL long varchar with the given value. A null argument means get a SQL null value.

getLongvarcharDataValue	back to summary
public StringDataValue getLongvarcharDataValue(String value, StringDataValue previous) throws StandardException Get a SQLLongvarchar object to represent a SQL LONG VARCHAR (UCS_BASIC) with the given value. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new SQLLongvarchar will be created and set to the value.

getLongvarcharDataValue

back to summary

public StringDataValue getLongvarcharDataValue(String value, StringDataValue previous) throws StandardException

Get a SQLLongvarchar object to represent a SQL LONG VARCHAR (UCS_BASIC) with the given value. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new SQLLongvarchar will be created and set to the value.

getLongvarcharDataValue	back to summary
public StringDataValue getLongvarcharDataValue(String value, StringDataValue previous, int collationType) throws StandardException Get a StringDataValue to represent a SQL LONG VARCHAR with the passed in collationType. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new StringDataValue will be created and set to the value. If collationType is equal to StringDataValue.COLLATION_TYPE_UCS_BASIC then the call is the equivalent of the overload without collationType.

getLongvarcharDataValue

back to summary

public StringDataValue getLongvarcharDataValue(String value, StringDataValue previous, int collationType) throws StandardException

getNull	back to summary
public DataValueDescriptor getNull(int formatId, int collationType) throws StandardException Return an object based on the format id and collation type. For format ids which do not correspond to character types, a format id is sufficient to get the right DVD. But for character types, Derby uses same format id for collation sensitive character types and for character types that use the default JVM collation. To get the correct DVD for character types, we need to know the collation type. Using collation type, we will determine if we need to construct collation sensitive DVD and associate the correct RuleBasedCollator with such DVDs. Parameters formatId:int Format id for the DVD collationType:int this is meaningful only for character types. Returns:DataValueDescriptor DataValueDescriptor which will be constructed using the passed parameters

getNull

back to summary

public DataValueDescriptor getNull(int formatId, int collationType) throws StandardException

Return an object based on the format id and collation type. For format ids which do not correspond to character types, a format id is sufficient to get the right DVD. But for character types, Derby uses same format id for collation sensitive character types and for character types that use the default JVM collation. To get the correct DVD for character types, we need to know the collation type. Using collation type, we will determine if we need to construct collation sensitive DVD and associate the correct RuleBasedCollator with such DVDs.

Parameters

formatId:int: Format id for the DVD
collationType:int: this is meaningful only for character types.

Returns:DataValueDescriptor

DataValueDescriptor which will be constructed using the passed parameters

getNullBit	back to summary
public BitDataValue getNullBit(BitDataValue dataValue) throws StandardException Get a SQL Bit with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value. Exceptions StandardException: Thrown on error

getNullBit

back to summary

public BitDataValue getNullBit(BitDataValue dataValue) throws StandardException

Get a SQL Bit with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

Exceptions

StandardException:: Thrown on error

getNullBlob	back to summary
public BitDataValue getNullBlob(BitDataValue dataValue) throws StandardException Get a SQL Blob with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value. Exceptions StandardException: Thrown on error

getNullBlob

back to summary

public BitDataValue getNullBlob(BitDataValue dataValue) throws StandardException

Get a SQL Blob with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

Exceptions

StandardException:: Thrown on error

getNullBoolean	back to summary
public BooleanDataValue getNullBoolean(BooleanDataValue dataValue) Get a SQL boolean with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullByte	back to summary
public NumberDataValue getNullByte(NumberDataValue dataValue) Get a SQL tinyint with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullChar	back to summary
public StringDataValue getNullChar(StringDataValue dataValue) Get a SQL CHAR (UCS_BASIC) with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullChar	back to summary
public StringDataValue getNullChar(StringDataValue dataValue, int collationType) throws StandardException Get a SQL CHAR set to NULL with collation set to collationType. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullClob	back to summary
public StringDataValue getNullClob(StringDataValue dataValue) Get a SQL CLOB (UCS_BASIC) with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullClob	back to summary
public StringDataValue getNullClob(StringDataValue dataValue, int collationType) throws StandardException Get a SQL CLOB set to NULL with collation set to collationType. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullDate	back to summary
public DateTimeDataValue getNullDate(DateTimeDataValue dataValue) Get a SQL date with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullDecimal	back to summary
public NumberDataValue getNullDecimal(NumberDataValue dataValue) Get a SQL Decimal/Numeric with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullDouble	back to summary
public NumberDataValue getNullDouble(NumberDataValue dataValue) Get a SQL double with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullFloat	back to summary
public NumberDataValue getNullFloat(NumberDataValue dataValue) Get a SQL float with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullInteger	back to summary
public NumberDataValue getNullInteger(NumberDataValue dataValue) Get a SQL int with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullLong	back to summary
public NumberDataValue getNullLong(NumberDataValue dataValue) Get a SQL bigint with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullLongVarbit

back to summary

public BitDataValue getNullLongVarbit(BitDataValue dataValue) throws StandardException

Get a SQL Long Bit Varying with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

Exceptions

StandardException:: Thrown on error

getNullLongvarchar	back to summary
public StringDataValue getNullLongvarchar(StringDataValue dataValue) Get a SQL LONG VARCHAR (UCS_BASIC) with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullLongvarchar	back to summary
public StringDataValue getNullLongvarchar(StringDataValue dataValue, int collationType) throws StandardException Get a SQL LONG VARCHAR set to NULL with collation set to collationType. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullObject	back to summary
public UserDataValue getNullObject(UserDataValue dataValue) Get a User-defined data value with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullRef	back to summary
public RefDataValue getNullRef(RefDataValue dataValue) Get a RefDataValue with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullShort	back to summary
public NumberDataValue getNullShort(NumberDataValue dataValue) Get a SQL smallint with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullTime	back to summary
public DateTimeDataValue getNullTime(DateTimeDataValue dataValue) Get a SQL time with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullTimestamp	back to summary
public DateTimeDataValue getNullTimestamp(DateTimeDataValue dataValue) Get a SQL timestamp with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullVarbit

back to summary

public BitDataValue getNullVarbit(BitDataValue dataValue) throws StandardException

Get a SQL Bit Varying with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

Exceptions

StandardException:: Thrown on error

getNullVarchar	back to summary
public StringDataValue getNullVarchar(StringDataValue dataValue) Get a SQL VARCHAR (UCS_BASIC) with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullVarchar	back to summary
public StringDataValue getNullVarchar(StringDataValue dataValue, int collationType) throws StandardException Get a SQL VARCHAR set to NULL with collation set to collationType. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getNullXML	back to summary
public XMLDataValue getNullXML(XMLDataValue dataValue) Get an XML with a SQL null value. If the supplied value is null then get a new value, otherwise set it to null and return that value.

getTimestamp

back to summary

public DateTimeDataValue getTimestamp(DataValueDescriptor operand) throws StandardException

Implement the timestamp SQL function: construct a SQL timestamp from a string, or timestamp.

Parameters

operand:DataValueDescriptor: Must be a timestamp or a string convertible to a timestamp.

getTimestamp

back to summary

public DateTimeDataValue getTimestamp(DataValueDescriptor date, DataValueDescriptor time) throws StandardException

Construct a SQL timestamp from a date and time.

Parameters

date:DataValueDescriptor: Must be convertible to a date.
time:DataValueDescriptor: Must be convertible to a time.

getTimestampValue

back to summary

public DateTimeDataValue getTimestampValue(String timestampStr, boolean isJdbcEscape) throws StandardException

Parameters

timestampStr:String: A time in string format.
isJdbcEscape:boolean: If true then the time must be in the JDBC time escape format, otherwise it must be in the DB2 time format.

Returns:DateTimeDataValue

An internal timestamp

Exceptions

StandardException:: if the syntax is invalid or the timestamp is out of range.

getTimeValue

back to summary

public DateTimeDataValue getTimeValue(String timeStr, boolean isJdbcEscape) throws StandardException

Parameters

timeStr:String: A date in one of the DB2 standard time formats or the local format.
isJdbcEscape:boolean: If true then the timestamp must be in the JDBC time escape format, otherwise it must be in the DB2 time format.

Returns:DateTimeDataValue

A DateTimeDataValue

Exceptions

StandardException:: if the syntax is invalid or the time is out of range.

getVarbitDataValue

back to summary

public BitDataValue getVarbitDataValue(byte[] value, BitDataValue previous) throws StandardException

Get a SQL bit with the given value. Uses the previous value, if non-null, as the data holder to return.

Exceptions

StandardException:: Thrown on error

getVarcharDataValue	back to summary
public StringDataValue getVarcharDataValue(String value) Get a SQL varchar with the given value. A null argument means get a SQL null value.

getVarcharDataValue

back to summary

public StringDataValue getVarcharDataValue(String value, StringDataValue previous) throws StandardException

Get a SQLVarhar object to represent a SQL VARCHAR (UCS_BASIC) with the given value. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new SQLVarchar will be created and set to the value.

getVarcharDataValue

back to summary

public StringDataValue getVarcharDataValue(String value, StringDataValue previous, int collationType) throws StandardException

Get a StringDataValue to represent a SQL VARCHAR with the passed in collationType. A null argument means get a SQL NULL value. If previous is not null (Java reference) then it will be set to the value passed in and returned, otherwise a new StringDataValue will be created and set to the value. If collationType is equal to StringDataValue.COLLATION_TYPE_UCS_BASIC then the call is the equivalent of the overload without collationType.

getXMLDataValue	back to summary
public XMLDataValue getXMLDataValue(XMLDataValue previous) throws StandardException Get a null XML value. Uses the previous value, if non-null, as the data holder to return.

public Interface DataValueFactory

Method Summary

Method Detail