Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> iapi >> [ types overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.derby.iapi.types
Interface StringDataValue  

All Superinterfaces:

ConcatableDataValue, DataValueDescriptor, java.io.Externalizable, org.apache.derby.iapi.services.io.Formatable, Orderable, java.io.Serializable, org.apache.derby.iapi.services.io.Storable, org.apache.derby.iapi.services.io.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 org.apache.derby.iapi.error.StandardException

The SQL concatenation '||' operator.

---

like

public BooleanDataValue like(DataValueDescriptor pattern)
                      throws org.apache.derby.iapi.error.StandardException

The SQL like() function with out escape clause.

---

like

public BooleanDataValue like(DataValueDescriptor pattern,
                             DataValueDescriptor escape)
                      throws org.apache.derby.iapi.error.StandardException

The SQL like() function WITH escape clause.

---

trim

public StringDataValue trim(int trimType,
                            StringDataValue result)
                     throws org.apache.derby.iapi.error.StandardException

The SQL trim(), ltrim() and rtrim() functions.

---

upper

public StringDataValue upper(StringDataValue result)
                      throws org.apache.derby.iapi.error.StandardException

Convert the string to upper case.

---

lower

public StringDataValue lower(StringDataValue result)
                      throws org.apache.derby.iapi.error.StandardException

Convert the string to lower case.

---

locate

public NumberDataValue locate(StringDataValue searchFrom,
                              NumberDataValue start,
                              NumberDataValue result)
                       throws org.apache.derby.iapi.error.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.

---

getCharArray

public char[] getCharArray()
                    throws org.apache.derby.iapi.error.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.

---

XMLParse

public XMLDataValue XMLParse(XMLDataValue result,
                             boolean preserveWS)
                      throws org.apache.derby.iapi.error.StandardException

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> iapi >> [ types overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---