org.hibernate.type
Class StringType

java.lang.Object
  org.hibernate.type.AbstractType
      org.hibernate.type.NullableType
          org.hibernate.type.ImmutableType
              org.hibernate.type.StringType

All Implemented Interfaces:

java.io.Serializable, DiscriminatorType, IdentifierType, LiteralType, Type

public class StringType
extends ImmutableType
implements DiscriminatorType

string: A type that maps an SQL VARCHAR to a Java String.

Author:

Gavin King

See Also:

Serialized Form

Constructor Summary

StringType()

Method Summary

java.lang.Object	fromStringValue(java.lang.String xml)
java.lang.Object	get(java.sql.ResultSet rs, java.lang.String name) Get a column value from a result set, without worrying about the possibility of null values.
java.lang.String	getName() Returns the abbreviated name of the type.
java.lang.Class	getReturnedClass() The class returned by nullSafeGet() methods.
java.lang.String	objectToSQLString(java.lang.Object value, Dialect dialect) String representation of the value, suitable for embedding in an SQL statement.
void	set(java.sql.PreparedStatement st, java.lang.Object value, int index) Set a parameter value without worrying about the possibility of null values.
int	sqlType() A convenience form of NullableType.sqlTypes(org.hibernate.engine.Mapping), returning just a single type value since these are explicitly dealing with single column mappings.
java.lang.Object	stringToObject(java.lang.String xml) Convert the value from the mapping file to a Java object.
java.lang.String	toString(java.lang.Object value)

Methods inherited from class org.hibernate.type.ImmutableType

deepCopy, isMutable, replace

Methods inherited from class org.hibernate.type.NullableType

fromXMLNode, fromXMLString, getColumnSpan, isDirty, isEqual, isEqual, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeSet, nullSafeSet, nullSafeSet, nullSafeToString, setToXMLNode, sqlTypes, toColumnNullness, toLoggableString, toXMLString

Methods inherited from class org.hibernate.type.AbstractType

assemble, beforeAssemble, compare, disassemble, getHashCode, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, isXMLElement, replace, replaceNode, resolve, semiResolve

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.type.Type

assemble, beforeAssemble, compare, deepCopy, disassemble, fromXMLNode, getColumnSpan, getHashCode, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isDirty, isEntityType, isEqual, isEqual, isModified, isMutable, isSame, isXMLElement, nullSafeGet, nullSafeGet, nullSafeSet, nullSafeSet, replace, replace, resolve, semiResolve, setToXMLNode, sqlTypes, toColumnNullness, toLoggableString

Constructor Detail

StringType

public StringType()

Method Detail

get

public java.lang.Object get(java.sql.ResultSet rs,
                            java.lang.String name)
                     throws java.sql.SQLException

Description copied from class: NullableType

Get a column value from a result set, without worrying about the possibility of null values. Called from NullableType.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.SessionImplementor, java.lang.Object) after nullness checks have been performed.

Specified by:

get in class NullableType

Parameters:

rs - The result set from which to extract the value.

name - The name of the value to extract.

Returns:

The extracted value.

Throws:

java.sql.SQLException - Indicates problem making the JDBC call(s).

getReturnedClass

public java.lang.Class getReturnedClass()

Description copied from interface: Type

The class returned by nullSafeGet() methods. This is used to establish the class of an array of this type.

Specified by:

getReturnedClass in interface Type

Returns:

Class

set

public void set(java.sql.PreparedStatement st,
                java.lang.Object value,
                int index)
         throws java.sql.SQLException

Description copied from class: NullableType

Set a parameter value without worrying about the possibility of null values. Called from NullableType.nullSafeSet(java.sql.PreparedStatement, java.lang.Object, int, boolean[], org.hibernate.engine.SessionImplementor) after nullness checks have been performed.

Specified by:

set in class NullableType

Parameters:

st - The statement into which to bind the parameter value.

value - The parameter value to bind.

index - The position or index at which to bind the param value.

Throws:

java.sql.SQLException - Indicates problem making the JDBC call(s).

sqlType

public int sqlType()

Description copied from class: NullableType

A convenience form of NullableType.sqlTypes(org.hibernate.engine.Mapping), returning just a single type value since these are explicitly dealing with single column mappings.

Specified by:

sqlType in class NullableType

Returns:

The Types mapping value.

getName

public java.lang.String getName()

Description copied from interface: Type

Returns the abbreviated name of the type.

Specified by:

getName in interface Type

Returns:

String the Hibernate type name

objectToSQLString

public java.lang.String objectToSQLString(java.lang.Object value,
                                          Dialect dialect)
                                   throws java.lang.Exception

Description copied from interface: LiteralType

String representation of the value, suitable for embedding in an SQL statement.

Specified by:

objectToSQLString in interface LiteralType

Returns:

String the value, as it appears in a SQL query

Throws:

java.lang.Exception

stringToObject

public java.lang.Object stringToObject(java.lang.String xml)
                                throws java.lang.Exception

Description copied from interface: IdentifierType

Convert the value from the mapping file to a Java object.

Specified by:

stringToObject in interface IdentifierType

Parameters:

xml - the value of discriminator-value or unsaved-value attribute

Returns:

Object

Throws:

java.lang.Exception

toString

public java.lang.String toString(java.lang.Object value)

Specified by:

toString in class NullableType

fromStringValue

public java.lang.Object fromStringValue(java.lang.String xml)

Specified by:

fromStringValue in class NullableType