org.axiondb.types
Class StringType

java.lang.Object
  extended byorg.axiondb.types.BaseDataType
      extended byorg.axiondb.types.StringType
All Implemented Interfaces:
Comparator, DataType, DataTypeFactory, Serializable

public class StringType
extends BaseDataType

A DataType representing a String value.

Version:
$Revision: 1.10 $ $Date: 2003/12/11 18:52:39 $
See Also:
Serialized Form

Constructor Summary
StringType()
           
 
Method Summary
 boolean accepts(Object value)
          Returns true iff value is null or a String.
 int compare(Object a, Object b)
           
 Object convert(Object value)
          Returns a String converted from the given value, or throws IllegalArgumentException if the given value isn't acceptable.
 int getColumnDisplaySize()
          Value returned by ResultSetMetaData#getColumnDisplaySizefor this data type.
protected  Comparator getComparator()
          This base implementation simply returns a ComparableComparator.
 int getJdbcType()
          Returns the JDBC type codemost closely matching this type.
 String getLiteralPrefix()
          Prefix used to quote a literal to delimit value for this type when in SQL syntax or result display
 String getLiteralSuffix()
          Suffix used to quote a literal to delimit value for this type when in SQL syntax or result display
 String getPreferredValueClassName()
          Returns the "normal" type returned by 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()
           
 Object read(DataInput in)
          Instantiate an object of my type from the given DataInput.
 Object successor(Object value)
          Returns the successor for the given value.
 boolean supportsSuccessor()
          Returns true if the successor(java.lang.Object)method is supported, false otherwise.
 byte[] toByteArray(Object value)
          Convert the given non- null value to a byte[], or throw a AxionException.
 String toString()
          Returns "string"
 void write(Object value, DataOutput out)
          Writes the given value to the given DataOutput.
 
Methods inherited from class org.axiondb.types.BaseDataType
getNullableCode, getPrecision, 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
equals
 

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 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

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

toString

public String toString()
Returns "string"

Returns:
"string"

toByteArray

public byte[] toByteArray(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

accepts

public boolean accepts(Object value)
Returns true iff value is null or a String.

Specified by:
accepts in interface DataType
Specified by:
accepts in class BaseDataType

convert

public Object convert(Object value)
               throws IllegalArgumentException
Returns a String converted from the given value, or throws IllegalArgumentException if the given value isn't acceptable.

Specified by:
convert in interface DataType
Specified by:
convert in class BaseDataType
Throws:
IllegalArgumentException

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 Object successor(Object value)
                 throws 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:
IllegalArgumentException

read

public Object read(DataInput in)
            throws 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:
IOException
See Also:
write(java.lang.Object, java.io.DataOutput)

write

public void write(Object value,
                  DataOutput out)
           throws 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:
IOException

makeNewInstance

public DataType makeNewInstance()
Specified by:
makeNewInstance in interface DataTypeFactory
Specified by:
makeNewInstance in class BaseDataType

getLiteralPrefix

public 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

getLiteralSuffix

public 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

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

compare

public int compare(Object a,
                   Object b)
Specified by:
compare in interface Comparator
Overrides:
compare in class BaseDataType

getComparator

protected 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()