org.axiondb.types

Class StringType

java.lang.Object

org.axiondb.types.BaseDataType

org.axiondb.types.StringType

All Implemented Interfaces:

java.io.Serializable, java.util.Comparator, DataType, DataTypeFactory

public class StringType
extends BaseDataType

A DataType representing a String value.

Version:

$Revision: 1.14 $ $Date: 2005/11/24 20:47:31 $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.axiondb.DataType

DataType.BinaryRepresentation, DataType.ExactNumeric, DataType.NonFixedPrecision

Constructor Summary

Constructors

Constructor and Description
StringType()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(java.lang.Object value) Returns true iff value is null or a String.
int	compare(java.lang.Object a, java.lang.Object b)
java.lang.Object	convert(java.lang.Object value) Returns a Stringconverted from the given value , or throws IllegalArgumentExceptionif the given value isn't acceptable.
int	getColumnDisplaySize() Value returned by ResultSetMetaData#getColumnDisplaySizefor this data type.
protected java.util.Comparator	getComparator() This base implementation simply returns a ComparableComparator.
int	getJdbcType() Returns the JDBC type codemost closely matching this type.
java.lang.String	getLiteralPrefix() Prefix used to quote a literal to delimit value for this type when in SQL syntax or result display
java.lang.String	getLiteralSuffix() Suffix used to quote a literal to delimit value for this type when in SQL syntax or result display
int	getPrecision() Value returned by ResultSetMetaData#getPrecisionfor this data type.
java.lang.String	getPreferredValueClassName() Returns the "normal" type returned by DataType.convert(java.lang.Object).
short	getSearchableCode() Code indicating how much WHERE ...
static StringType	instance()
boolean	isCaseSensitive() For character and string-related types, indicates whether type acknowledges case when storing and retrieving values
DataType	makeNewInstance() Creates a new instance of this DataType implementation.
java.lang.Object	read(java.io.DataInput in) Instantiate an object of my type from the given DataInput.
java.lang.Object	successor(java.lang.Object value) Returns the successor for the given value.
boolean	supportsSuccessor() Returns true if the DataType.successor(java.lang.Object)method is supported, false otherwise.
byte[]	toByteArray(java.lang.Object value) Convert the given non- null value to a byte[], or throw a AxionException.
java.lang.String	toString() Returns "string"
void	write(java.lang.Object value, java.io.DataOutput out) Writes the given value to the given DataOutput.

Methods inherited from class org.axiondb.types.BaseDataType

getNullableCode, getPrecisionRadix, getScale, isCurrency, isUnsigned, toBigDecimal, toBigInteger, toBlob, toBoolean, toByte, toClob, toDate, toDouble, toFloat, toInt, toLong, toNumber, toShort, toString, toTime, toTimestamp, toURL

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

StringType

public StringType()

Method Detail

getJdbcType

public int getJdbcType()

Description copied from interface: DataType

Returns the JDBC type codemost closely matching this type.

Specified by:

getJdbcType in interface DataType

Specified by:

getJdbcType in class BaseDataType

getPreferredValueClassName

public java.lang.String getPreferredValueClassName()

Description copied from interface: DataType

Returns the "normal" type returned by DataType.convert(java.lang.Object). Returns java.lang.Object if unknown.

Specified by:

getPreferredValueClassName in interface DataType

Overrides:

getPreferredValueClassName in class BaseDataType

See Also:

AxionResultSetMetaData.getColumnClassName(int)

getColumnDisplaySize

public int getColumnDisplaySize()

Description copied from interface: DataType

Value returned by ResultSetMetaData#getColumnDisplaySizefor this data type.

Specified by:

getColumnDisplaySize in interface DataType

Overrides:

getColumnDisplaySize in class BaseDataType

See Also:

ResultSetMetaData.getColumnDisplaySize(int)

getPrecision

public int getPrecision()

Description copied from interface: DataType

Value returned by ResultSetMetaData#getPrecisionfor this data type.

Specified by:

getPrecision in interface DataType

Overrides:

getPrecision in class BaseDataType

See Also:

ResultSetMetaData.getPrecision(int)

isCaseSensitive

public boolean isCaseSensitive()

Description copied from interface: DataType

For character and string-related types, indicates whether type acknowledges case when storing and retrieving values

Specified by:

isCaseSensitive in interface DataType

Overrides:

isCaseSensitive in class BaseDataType

See Also:

DatabaseMetaData.getTypeInfo(), ResultSetMetaData.isCaseSensitive(int)

toString

public java.lang.String toString()

Returns "string"

Overrides:

toString in class java.lang.Object

Returns:

"string"

toByteArray

public byte[] toByteArray(java.lang.Object value)
                   throws AxionException

Description copied from interface: DataType

Convert the given non- null value to a byte[], or throw a AxionException.

Specified by:

toByteArray in interface DataType

Overrides:

toByteArray in class BaseDataType

Throws:

AxionException

See Also:

ResultSet.getBytes(int)

accepts

public boolean accepts(java.lang.Object value)

Returns true iff value is null or a String.

Specified by:

accepts in interface DataType

Specified by:

accepts in class BaseDataType

Parameters:

value - non- null value

convert

public java.lang.Object convert(java.lang.Object value)
                         throws AxionException

Returns a Stringconverted from the given value , or throws IllegalArgumentExceptionif the given value isn't acceptable.

Specified by:

convert in interface DataType

Specified by:

convert in class BaseDataType

Throws:

AxionException

supportsSuccessor

public boolean supportsSuccessor()

Description copied from interface: DataType

Returns true if the DataType.successor(java.lang.Object)method is supported, false otherwise.

Specified by:

supportsSuccessor in interface DataType

Overrides:

supportsSuccessor in class BaseDataType

successor

public java.lang.Object successor(java.lang.Object value)
                           throws java.lang.IllegalArgumentException

Description copied from interface: DataType

Returns the successor for the given value. For example, the successor of the integer 1 is 2.

Specified by:

successor in interface DataType

Overrides:

successor in class BaseDataType

Throws:

java.lang.IllegalArgumentException

read

public java.lang.Object read(java.io.DataInput in)
                      throws java.io.IOException

Description copied from interface: DataType

Instantiate an object of my type from the given DataInput. The next sequence of bytes to be read from the DataInput will have been written by DataType.write(java.lang.Object, java.io.DataOutput).

Specified by:

read in interface DataType

Specified by:

read in class BaseDataType

Throws:

java.io.IOException

See Also:

write(java.lang.Object, java.io.DataOutput)

write

public void write(java.lang.Object value,
                  java.io.DataOutput out)
           throws java.io.IOException

Writes the given value to the given DataOutput. Null values are written as "null", false, the non-null String "null" is written as "null", true, all other values are written directly.

Specified by:

write in interface DataType

Specified by:

write in class BaseDataType

Parameters:

value - the value to write, which must be acceptable

Throws:

java.io.IOException

makeNewInstance

public DataType makeNewInstance()

Description copied from interface: DataType

Creates a new instance of this DataType implementation.

Specified by:

makeNewInstance in interface DataType

Specified by:

makeNewInstance in interface DataTypeFactory

Specified by:

makeNewInstance in class BaseDataType

Returns:

new instance of this DataType implementation.

getLiteralPrefix

public java.lang.String getLiteralPrefix()

Description copied from interface: DataType

Prefix used to quote a literal to delimit value for this type when in SQL syntax or result display

Specified by:

getLiteralPrefix in interface DataType

Overrides:

getLiteralPrefix in class BaseDataType

See Also:

DatabaseMetaData.getTypeInfo()

getLiteralSuffix

public java.lang.String getLiteralSuffix()

Description copied from interface: DataType

Suffix used to quote a literal to delimit value for this type when in SQL syntax or result display

Specified by:

getLiteralSuffix in interface DataType

Overrides:

getLiteralSuffix in class BaseDataType

See Also:

DatabaseMetaData.getTypeInfo()

getSearchableCode

public short getSearchableCode()

Description copied from interface: DataType

Code indicating how much WHERE ... LIKE support is available across a column of this type

Specified by:

getSearchableCode in interface DataType

Overrides:

getSearchableCode in class BaseDataType

See Also:

DatabaseMetaData.getTypeInfo()

compare

public int compare(java.lang.Object a,
                   java.lang.Object b)

Specified by:

compare in interface java.util.Comparator

Overrides:

compare in class BaseDataType

getComparator

protected java.util.Comparator getComparator()

Description copied from class: BaseDataType

This base implementation simply returns a ComparableComparator.

Overrides:

getComparator in class BaseDataType

instance

public static final StringType instance()