public interface StringDataValue extends ConcatableDataValue
Modifier and Type | Field and Description |
---|---|
static int |
BOTH |
static int |
COLLATION_DERIVATION_EXPLICIT |
static int |
COLLATION_DERIVATION_IMPLICIT |
static int |
COLLATION_DERIVATION_NONE
For a character string type, the collation derivation should always be
"explicit"(not possible in Derby 10.3), "implicit" or "none".
|
static int |
COLLATION_TYPE_TERRITORY_BASED |
static int |
COLLATION_TYPE_TERRITORY_BASED_IDENTICAL |
static int |
COLLATION_TYPE_TERRITORY_BASED_PRIMARY |
static int |
COLLATION_TYPE_TERRITORY_BASED_SECONDARY |
static int |
COLLATION_TYPE_TERRITORY_BASED_TERTIARY |
static int |
COLLATION_TYPE_UCS_BASIC
In Derby 10.3, it is possible to have database with one of the following
two configurations
1)all the character columns will have a collation type of UCS_BASIC.
|
static int |
LEADING |
static int |
TRAILING |
UNKNOWN_LOGICAL_LENGTH
ORDER_OP_EQUALS, ORDER_OP_GREATEROREQUALS, ORDER_OP_GREATERTHAN, ORDER_OP_LESSOREQUALS, ORDER_OP_LESSTHAN
IGNORE_PRECISION
Modifier and Type | Method and Description |
---|---|
StringDataValue |
ansiTrim(int trimType,
StringDataValue trimChar,
StringDataValue result)
The SQL Ansi trim function.
|
StringDataValue |
concatenate(StringDataValue leftOperand,
StringDataValue rightOperand,
StringDataValue result)
The SQL concatenation '||' operator.
|
char[] |
getCharArray()
Get a char array.
|
StreamHeaderGenerator |
getStreamHeaderGenerator()
Returns the stream header generator for the string data value.
|
CharacterStreamDescriptor |
getStreamWithDescriptor()
Returns a descriptor for the input stream for this data value.
|
StringDataValue |
getValue(java.text.RuleBasedCollator collatorForComparison)
Gets either SQLChar/SQLVarchar/SQLLongvarchar/SQLClob(base classes) or
CollatorSQLChar/CollatorSQLVarchar/CollatorSQLLongvarch/CollatorSQLClob
(subclasses).
|
BooleanDataValue |
like(DataValueDescriptor pattern)
The SQL like() function with out escape clause.
|
BooleanDataValue |
like(DataValueDescriptor pattern,
DataValueDescriptor escape)
The SQL like() function WITH escape clause.
|
NumberDataValue |
locate(StringDataValue searchFrom,
NumberDataValue start,
NumberDataValue result)
Position in searchFrom of the first occurrence of this.value.
|
StringDataValue |
lower(StringDataValue result)
Convert the string to lower case.
|
void |
setStreamHeaderFormat(java.lang.Boolean usePreTenFiveHdrFormat)
Tells the data value descriptor which CLOB stream header format to use.
|
void |
setValue(java.sql.Clob value)
Stuff a StringDataValue with a Clob.
|
StringDataValue |
upper(StringDataValue result)
Convert the string to upper case.
|
charLength, substring
checkHostVariable, cloneHolder, cloneValue, coalesce, compare, compare, compare, compare, equals, estimateMemoryUsage, getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLength, getLong, getNewNull, getObject, getShort, getStream, getString, getTime, getTimestamp, getTraceString, getTypeName, greaterOrEquals, greaterThan, hasStream, in, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, readExternalFromArray, recycle, setBigDecimal, setInto, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromResultSet, typePrecedence, typeToBigDecimal
isNull, restoreToNull
getTypeFormatId
setWidth
static final int BOTH
static final int TRAILING
static final int LEADING
static final int COLLATION_DERIVATION_NONE
static final int COLLATION_DERIVATION_IMPLICIT
COLLATION_DERIVATION_NONE
,
Constant Field Valuesstatic final int COLLATION_DERIVATION_EXPLICIT
COLLATION_DERIVATION_NONE
,
Constant Field Valuesstatic final int COLLATION_TYPE_UCS_BASIC
static final int COLLATION_TYPE_TERRITORY_BASED
COLLATION_TYPE_UCS_BASIC
,
Constant Field Valuesstatic final int COLLATION_TYPE_TERRITORY_BASED_PRIMARY
static final int COLLATION_TYPE_TERRITORY_BASED_SECONDARY
static final int COLLATION_TYPE_TERRITORY_BASED_TERTIARY
static final int COLLATION_TYPE_TERRITORY_BASED_IDENTICAL
StringDataValue concatenate(StringDataValue leftOperand, StringDataValue rightOperand, StringDataValue result) throws StandardException
leftOperand
- String on the left hand side of '||'rightOperand
- String on the right hand side of '||'result
- The result of a previous call to this method,
null if not called yet.StandardException
- Thrown on errorBooleanDataValue like(DataValueDescriptor pattern) throws StandardException
pattern
- the pattern to useStandardException
- Thrown on errorBooleanDataValue like(DataValueDescriptor pattern, DataValueDescriptor escape) throws StandardException
pattern
- the pattern to useescape
- the escape characterStandardException
- Thrown on errorStringDataValue ansiTrim(int trimType, StringDataValue trimChar, StringDataValue result) throws StandardException
trimType
- type of trim. Possible values are LEADING
, TRAILING
or BOTH
.trimChar
- The character to trim from thisresult
- The result of a previous call to this method,
null if not called yet.StandardException
StringDataValue upper(StringDataValue result) throws StandardException
result
- The result (reusable - allocate if null).StandardException
- Thrown on errorStringDataValue lower(StringDataValue result) throws StandardException
result
- The result (reusable - allocate if null).StandardException
- Thrown on errorNumberDataValue locate(StringDataValue searchFrom, NumberDataValue start, NumberDataValue result) throws StandardException
searchFrom
- - The string to search fromstart
- - The position to search from in string searchFromresult
- - The object to returnStandardException
- Thrown on errorchar[] getCharArray() throws StandardException
WARNING: may return a character array that has spare characters at the end. MUST be used in conjunction with getLength() to be safe.
StandardException
- Thrown on errorStringDataValue getValue(java.text.RuleBasedCollator collatorForComparison)
StreamHeaderGenerator getStreamHeaderGenerator()
The generator writes the correct header into the destination buffer or stream and also keeps track of whether appending an end-of-stream marker is required or not.
Note that the generator may fail to generate a header if there is no context at the time the header is asked for, and the mode hasn't been set explicitly.
setStreamHeaderFormat(java.lang.Boolean)
void setStreamHeaderFormat(java.lang.Boolean usePreTenFiveHdrFormat)
usePreTenFiveHdrFormat
- true
if the database accessed is
prior to version 10.5, false
if the version is 10.5 or
newer, and null
if unknown at this timeCharacterStreamDescriptor getStreamWithDescriptor() throws StandardException
The descriptor contains information about header data, current positions, length, whether the stream should be buffered or not, and if the stream is capable of repositioning itself.
StandardException
- if obtaining the descriptor fails, or if the
value isn't represented as a stream.void setValue(java.sql.Clob value) throws StandardException
setValue
in interface DataValueDescriptor
value
- The Clob value to set this DataValueDescriptor toStandardException
Apache Derby V10.13 Internals - Copyright © 2004,2016 The Apache Software Foundation. All Rights Reserved.