org.apache.derby.iapi.types
Interface StringDataValue

All Superinterfaces:
ConcatableDataValue, DataValueDescriptor, java.io.Externalizable, Formatable, Orderable, java.io.Serializable, Storable, TypedFormat, VariableSizeDataValue
All Known Implementing Classes:
SQLChar

public interface StringDataValue
extends ConcatableDataValue


Field Summary
static int BOTH
           
static int LEADING
           
static int TRAILING
           
 
Fields inherited from interface org.apache.derby.iapi.types.Orderable
ORDER_OP_EQUALS, ORDER_OP_GREATEROREQUALS, ORDER_OP_GREATERTHAN, ORDER_OP_LESSOREQUALS, ORDER_OP_LESSTHAN
 
Fields inherited from interface org.apache.derby.iapi.types.VariableSizeDataValue
IGNORE_PRECISION
 
Method Summary
 StringDataValue concatenate(StringDataValue leftOperand, StringDataValue rightOperand, StringDataValue result)
          The SQL concatenation '||' operator.
 char[] getCharArray()
          Get a char array.
 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.
 StringDataValue trim(int trimType, StringDataValue result)
          The SQL trim(), ltrim() and rtrim() functions.
 StringDataValue upper(StringDataValue result)
          Convert the string to upper case.
 XMLDataValue XMLParse(XMLDataValue result, boolean preserveWS)
           
 
Methods inherited from interface org.apache.derby.iapi.types.ConcatableDataValue
charLength, substring
 
Methods inherited from interface org.apache.derby.iapi.types.DataValueDescriptor
checkHostVariable, coalesce, compare, compare, equals, estimateMemoryUsage, getBoolean, getByte, getBytes, getClone, getDate, getDouble, getFloat, getInt, getLength, getLong, getNewNull, getObject, getShort, getStream, getString, getTime, getTimestamp, getTypeName, greaterOrEquals, greaterThan, in, isNotNull, isNullOp, lessOrEquals, lessThan, normalize, notEquals, readExternalFromArray, setBigDecimal, setInto, setInto, setObjectForCast, setToNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromResultSet, typePrecedence, typeToBigDecimal
 
Methods inherited from interface org.apache.derby.iapi.services.io.Storable
isNull, restoreToNull
 
Methods inherited from interface java.io.Externalizable
readExternal, writeExternal
 
Methods inherited from interface org.apache.derby.iapi.services.io.TypedFormat
getTypeFormatId
 
Methods inherited from interface org.apache.derby.iapi.types.VariableSizeDataValue
setWidth
 

Field Detail

BOTH

public static final int BOTH
See Also:
Constant Field Values

TRAILING

public static final int TRAILING
See Also:
Constant Field Values

LEADING

public static final int LEADING
See Also:
Constant Field Values
Method Detail

concatenate

public StringDataValue concatenate(StringDataValue leftOperand,
                                   StringDataValue rightOperand,
                                   StringDataValue result)
                            throws StandardException
The SQL concatenation '||' operator.

Parameters:
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.
Returns:
A ConcatableDataValue containing the result of the '||'
Throws:
StandardException - Thrown on error

like

public BooleanDataValue like(DataValueDescriptor pattern)
                      throws StandardException
The SQL like() function with out escape clause.

Parameters:
pattern - the pattern to use
Returns:
A BooleanDataValue containing the result of the like
Throws:
StandardException - Thrown on error

like

public BooleanDataValue like(DataValueDescriptor pattern,
                             DataValueDescriptor escape)
                      throws StandardException
The SQL like() function WITH escape clause.

Parameters:
pattern - the pattern to use
escape - the escape character
Returns:
A BooleanDataValue containing the result of the like
Throws:
StandardException - Thrown on error

trim

public StringDataValue trim(int trimType,
                            StringDataValue result)
                     throws StandardException
The SQL trim(), ltrim() and rtrim() functions.

Parameters:
trimType - Type of trim
result - The result of a previous call to this method, null if not called yet.
Returns:
A StringDataValue containing the result of the trim()
Throws:
StandardException - Thrown on error

upper

public StringDataValue upper(StringDataValue result)
                      throws StandardException
Convert the string to upper case.

Parameters:
result - The result (reusable - allocate if null).
Returns:
The string converted to upper case.
Throws:
StandardException - Thrown on error

lower

public StringDataValue lower(StringDataValue result)
                      throws StandardException
Convert the string to lower case.

Parameters:
result - The result (reusable - allocate if null).
Returns:
The string converted to lower case.
Throws:
StandardException - Thrown on error

locate

public NumberDataValue locate(StringDataValue searchFrom,
                              NumberDataValue start,
                              NumberDataValue result)
                       throws StandardException
Position in searchFrom of the first occurrence of this.value. The search begins from position start. 0 is returned if searchFrom does not contain this.value. Position 1 is the first character in searchFrom.

Parameters:
searchFrom - - The string to search from
start - - The position to search from in string searchFrom
result - - The object to return
Returns:
The position in searchFrom the fist occurrence of this.value. 0 is returned if searchFrom does not contain this.value.
Throws:
StandardException - Thrown on error

getCharArray

public char[] getCharArray()
                    throws StandardException
Get a char array. Typically, this is a simple getter that is cheaper than getString() because we always need to create a char array when doing I/O. Use this instead of getString() where reasonable.

WARNING: may return a character array that has spare characters at the end. MUST be used in conjunction with getLength() to be safe.

Throws:
StandardException - Thrown on error

XMLParse

public XMLDataValue XMLParse(XMLDataValue result,
                             boolean preserveWS)
                      throws StandardException
Throws:
StandardException

Built on Tue 2006-10-10 19:23:47+0200, from revision exported

Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.