org.hibernate.type
Class AbstractStandardBasicType<T>

java.lang.Object
  org.hibernate.type.AbstractStandardBasicType<T>

All Implemented Interfaces:

Serializable, BasicType, StringRepresentableType<T>, Type, XmlRepresentableType<T>

Direct Known Subclasses:

AbstractSingleColumnStandardBasicType

public abstract class AbstractStandardBasicType<T>
extends Object
implements BasicType, StringRepresentableType<T>, XmlRepresentableType<T>

TODO : javadoc

Author:

Steve Ebersole

See Also:

Serialized Form

Constructor Summary

AbstractStandardBasicType(SqlTypeDescriptor sqlTypeDescriptor, JavaTypeDescriptor<T> javaTypeDescriptor)

Method Summary

Object	assemble(Serializable cached, SessionImplementor session, Object owner) Reconstruct the object from its cached "disassembled" state.
void	beforeAssemble(Serializable cached, SessionImplementor session) Called before assembling a query result set from the query cache, to allow batch fetching of entities missing from the second-level cache.
int	compare(Object x, Object y, EntityMode entityMode) Perform a Comparator style comparison between values
Object	deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory) Return a deep copy of the persistent state, stopping at entities and at collections.
protected T	deepCopy(T value)
Serializable	disassemble(Object value, SessionImplementor session, Object owner) Return a cacheable "disassembled" representation of the object.
T	fromString(String string)
T	fromStringValue(String xml) Consume the given string representation back into this types java form.
Object	fromXMLNode(org.dom4j.Node xml, Mapping factory) Parse the XML representation of an instance.
T	fromXMLString(String xml, Mapping factory)
Object	get(ResultSet rs, String name, SessionImplementor session)
int	getColumnSpan(Mapping mapping) How many columns are used to persist this type.
protected int	getHashCode(Object x)
int	getHashCode(Object x, EntityMode entityMode) Get a hash code, consistent with persistence "equality".
int	getHashCode(Object x, EntityMode entityMode, SessionFactoryImplementor factory) Get a hash code, consistent with persistence "equality".
JavaTypeDescriptor<T>	getJavaTypeDescriptor()
protected MutabilityPlan<T>	getMutabilityPlan()
String[]	getRegistrationKeys() Get the names under which this type should be registered in the type registry.
protected T	getReplacement(T original, T target)
Class	getReturnedClass() The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.SessionImplementor, java.lang.Object) methods.
Type	getSemiResolvedType(SessionFactoryImplementor factory) Get the type of a semi-resolved value.
SqlTypeDescriptor	getSqlTypeDescriptor()
Object	hydrate(ResultSet rs, String[] names, SessionImplementor session, Object owner) Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset.
boolean	isAnyType() Return true if the implementation is castable to AnyType.
boolean	isAssociationType() Return true if the implementation is castable to AssociationType.
boolean	isCollectionType() Return true if the implementation is castable to CollectionType.
boolean	isComponentType() Return true if the implementation is castable to CompositeType.
protected boolean	isDirty(Object old, Object current)
boolean	isDirty(Object old, Object current, boolean[] checkable, SessionImplementor session) Should the parent be considered dirty, given both the old and current value?
boolean	isDirty(Object old, Object current, SessionImplementor session) Should the parent be considered dirty, given both the old and current value?
boolean	isEntityType() Return true if the implementation is castable to EntityType.
boolean	isEqual(Object x, Object y, EntityMode entityMode) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).
boolean	isEqual(Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).
boolean	isEqual(T one, T another)
boolean	isModified(Object oldHydratedState, Object currentState, boolean[] checkable, SessionImplementor session) Has the value been modified compared to the current database state? The difference between this and the Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.SessionImplementor) methods is that here we need to account for "partially" built values.
boolean	isMutable() Are objects of this type mutable.
protected boolean	isSame(Object x, Object y)
boolean	isSame(Object x, Object y, EntityMode entityMode) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references.
boolean	isXMLElement()
Object	nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) Retrieve an instance of the mapped class from a JDBC resultset.
T	nullSafeGet(ResultSet rs, String name, SessionImplementor session)
Object	nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner) Retrieve an instance of the mapped class from a JDBC resultset.
protected T	nullSafeGet(ResultSet rs, String name, WrapperOptions options)
void	nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) Write an instance of the mapped class to a prepared statement.
protected void	nullSafeSet(PreparedStatement st, Object value, int index, WrapperOptions options)
protected boolean	registerUnderJavaType()
Object	replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache) During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging.
Object	replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection) During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging.
Object	resolve(Object value, SessionImplementor session, Object owner) Map identifiers to entities or collections.
Object	semiResolve(Object value, SessionImplementor session, Object owner) Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
void	set(PreparedStatement st, T value, int index, SessionImplementor session)
void	setToXMLNode(org.dom4j.Node node, Object value, SessionFactoryImplementor factory) A representation of the value to be embedded in an XML element.
int[]	sqlTypes(Mapping mapping) Return the JDBC types codes (per Types) for the columns mapped by this type.
boolean[]	toColumnNullness(Object value, Mapping mapping) Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
String	toLoggableString(Object value, SessionFactoryImplementor factory) A representation of the value to be embedded in a log file.
String	toString(T value) Render the value to the string representation.
String	toXMLString(T value, SessionFactoryImplementor factory)

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

getName, nullSafeSet

Constructor Detail

AbstractStandardBasicType

public AbstractStandardBasicType(SqlTypeDescriptor sqlTypeDescriptor,
                                 JavaTypeDescriptor<T> javaTypeDescriptor)

Method Detail

fromString

public T fromString(String string)

toString

public String toString(T value)

Description copied from interface: StringRepresentableType

Render the value to the string representation.

Specified by:

toString in interface StringRepresentableType<T>

Parameters:

value - The value to render to string.

Returns:

The string representation

fromStringValue

public T fromStringValue(String xml)
                  throws HibernateException

Description copied from interface: StringRepresentableType

Consume the given string representation back into this types java form.

Specified by:

fromStringValue in interface StringRepresentableType<T>

Parameters:

xml - The string representation to be consumed.

Returns:

The java type representation

Throws:

HibernateException - Problem consuming

toXMLString

public String toXMLString(T value,
                          SessionFactoryImplementor factory)
                   throws HibernateException

Specified by:

toXMLString in interface XmlRepresentableType<T>

Throws:

HibernateException

fromXMLString

public T fromXMLString(String xml,
                       Mapping factory)
                throws HibernateException

Specified by:

fromXMLString in interface XmlRepresentableType<T>

Throws:

HibernateException

getMutabilityPlan

protected MutabilityPlan<T> getMutabilityPlan()

getReplacement

protected T getReplacement(T original,
                           T target)

toColumnNullness

public boolean[] toColumnNullness(Object value,
                                  Mapping mapping)

Description copied from interface: Type

Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.

Specified by:

toColumnNullness in interface Type

Parameters:

value - an instance of the type

getRegistrationKeys

public String[] getRegistrationKeys()

Description copied from interface: BasicType

Get the names under which this type should be registered in the type registry.

Specified by:

getRegistrationKeys in interface BasicType

Returns:

The keys under which to register this type.

registerUnderJavaType

protected boolean registerUnderJavaType()

getJavaTypeDescriptor

public final JavaTypeDescriptor<T> getJavaTypeDescriptor()

getSqlTypeDescriptor

public final SqlTypeDescriptor getSqlTypeDescriptor()

getReturnedClass

public final Class getReturnedClass()

Description copied from interface: Type

The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.SessionImplementor, java.lang.Object) methods. This is used to establish the class of an array of this type.

Specified by:

getReturnedClass in interface Type

Returns:

The java type class handled by this type.

sqlTypes

public final int[] sqlTypes(Mapping mapping)
                     throws MappingException

Description copied from interface: Type

Return the JDBC types codes (per Types) for the columns mapped by this type.

Specified by:

sqlTypes in interface Type

Parameters:

mapping - The mapping object :/

Returns:

The JDBC type codes.

Throws:

MappingException - Generally indicates an issue accessing the passed mapping object.

getColumnSpan

public final int getColumnSpan(Mapping mapping)
                        throws MappingException

Description copied from interface: Type

How many columns are used to persist this type. Always the same as sqlTypes(mapping).length

Specified by:

getColumnSpan in interface Type

Parameters:

mapping - The mapping object :/

Returns:

The number of columns

Throws:

MappingException - Generally indicates an issue accessing the passed mapping object.

isAssociationType

public final boolean isAssociationType()

Description copied from interface: Type

Return true if the implementation is castable to AssociationType. This does not necessarily imply that the type actually represents an association. Essentially a polymorphic version of (type instanceof AssociationType.class)

Specified by:

isAssociationType in interface Type

Returns:

True if this type is also an AssociationType implementor; false otherwise.

isCollectionType

public final boolean isCollectionType()

Description copied from interface: Type

Return true if the implementation is castable to CollectionType. Essentially a polymorphic version of (type instanceof CollectionType.class)

A CollectionType is additionally an AssociationType; so if this method returns true, Type.isAssociationType() should also return true.

Specified by:

isCollectionType in interface Type

Returns:

True if this type is also an CollectionType implementor; false otherwise.

isComponentType

public final boolean isComponentType()

Description copied from interface: Type

Return true if the implementation is castable to CompositeType. Essentially a polymorphic version of (type instanceof CompositeType.class). A component type may own collections or associations and hence must provide certain extra functionality.

Specified by:

isComponentType in interface Type

Returns:

True if this type is also an CompositeType implementor; false otherwise.

isEntityType

public final boolean isEntityType()

Description copied from interface: Type

Return true if the implementation is castable to EntityType. Essentially a polymorphic version of (type instanceof EntityType.class).

An EntityType is additionally an AssociationType; so if this method returns true, Type.isAssociationType() should also return true.

Specified by:

isEntityType in interface Type

Returns:

True if this type is also an EntityType implementor; false otherwise.

isAnyType

public final boolean isAnyType()

Description copied from interface: Type

Return true if the implementation is castable to AnyType. Essentially a polymorphic version of (type instanceof AnyType.class).

An AnyType is additionally an AssociationType; so if this method returns true, Type.isAssociationType() should also return true.

Specified by:

isAnyType in interface Type

Returns:

True if this type is also an AnyType implementor; false otherwise.

isXMLElement

public final boolean isXMLElement()

Specified by:

isXMLElement in interface Type

isSame

public final boolean isSame(Object x,
                            Object y,
                            EntityMode entityMode)

Description copied from interface: Type

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references.

For most types this should equate to #equals check on the values. For associations the implication is a bit different. For most types it is conceivable to simply delegate to Type.isEqual(java.lang.Object, java.lang.Object, org.hibernate.EntityMode)

Specified by:

isSame in interface Type

Parameters:

x - The first value

y - The second value

entityMode - The entity mode of the values.

Returns:

True if there are considered the same (see discussion above).

isSame

protected final boolean isSame(Object x,
                               Object y)

isEqual

public final boolean isEqual(Object x,
                             Object y,
                             EntityMode entityMode)

Description copied from interface: Type

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).

This should always equate to some form of comparison of the value's internal state. As an example, for something like a date the comparison should be based on its internal "time" state based on the specific portion it is meant to represent (timestamp, date, time).

Specified by:

isEqual in interface Type

Parameters:

x - The first value

y - The second value

entityMode - The entity mode of the values.

Returns:

True if there are considered equal (see discussion above).

isEqual

public final boolean isEqual(Object x,
                             Object y,
                             EntityMode entityMode,
                             SessionFactoryImplementor factory)

Description copied from interface: Type

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).

This should always equate to some form of comparison of the value's internal state. As an example, for something like a date the comparison should be based on its internal "time" state based on the specific portion it is meant to represent (timestamp, date, time).

Specified by:

isEqual in interface Type

Parameters:

x - The first value

y - The second value

entityMode - The entity mode of the values.

factory - The session factory

Returns:

True if there are considered equal (see discussion above).

isEqual

public final boolean isEqual(T one,
                             T another)

getHashCode

public final int getHashCode(Object x,
                             EntityMode entityMode)

Description copied from interface: Type

Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's #hashCode.

Specified by:

getHashCode in interface Type

Parameters:

x - The value for which to retrieve a hash code

entityMode - The entity mode of the value.

Returns:

The hash code

getHashCode

public final int getHashCode(Object x,
                             EntityMode entityMode,
                             SessionFactoryImplementor factory)

Description copied from interface: Type

Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's #hashCode.

Specified by:

getHashCode in interface Type

Parameters:

x - The value for which to retrieve a hash code

entityMode - The entity mode of the value.

factory - The session factory

Returns:

The hash code

getHashCode

protected final int getHashCode(Object x)

compare

public final int compare(Object x,
                         Object y,
                         EntityMode entityMode)

Description copied from interface: Type

Perform a Comparator style comparison between values

Specified by:

compare in interface Type

Parameters:

x - The first value

y - The second value

entityMode - The entity mode of the values.

Returns:

The comparison result. See Comparator.compare(T, T) for a discussion.

isDirty

public final boolean isDirty(Object old,
                             Object current,
                             SessionImplementor session)

Description copied from interface: Type

Should the parent be considered dirty, given both the old and current value?

Specified by:

isDirty in interface Type

Parameters:

old - the old value

current - the current value

session - The session from which the request originated.

Returns:

true if the field is dirty

isDirty

public final boolean isDirty(Object old,
                             Object current,
                             boolean[] checkable,
                             SessionImplementor session)

Description copied from interface: Type

Should the parent be considered dirty, given both the old and current value?

Specified by:

isDirty in interface Type

Parameters:

old - the old value

current - the current value

checkable - An array of booleans indicating which columns making up the value are actually checkable

session - The session from which the request originated.

Returns:

true if the field is dirty

isDirty

protected final boolean isDirty(Object old,
                                Object current)

isModified

public final boolean isModified(Object oldHydratedState,
                                Object currentState,
                                boolean[] checkable,
                                SessionImplementor session)

Description copied from interface: Type

Has the value been modified compared to the current database state? The difference between this and the Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.SessionImplementor) methods is that here we need to account for "partially" built values. This is really only an issue with association types. For most type implementations it is enough to simply delegate to Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.SessionImplementor) here/

Specified by:

isModified in interface Type

Parameters:

oldHydratedState - the database state, in a "hydrated" form, with identifiers unresolved

currentState - the current state of the object

checkable - which columns are actually updatable

session - The session from which the request originated.

Returns:

true if the field has been modified

nullSafeGet

public final Object nullSafeGet(ResultSet rs,
                                String[] names,
                                SessionImplementor session,
                                Object owner)
                         throws SQLException

Description copied from interface: Type

Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.

Specified by:

nullSafeGet in interface Type

names - the column names

owner - the parent entity

Returns:

Object

Throws:

SQLException

See Also:

alternative, 2-phase property initialization

nullSafeGet

public final Object nullSafeGet(ResultSet rs,
                                String name,
                                SessionImplementor session,
                                Object owner)
                         throws SQLException

Description copied from interface: Type

Retrieve an instance of the mapped class from a JDBC resultset. Implementations should handle possibility of null values. This method might be called if the type is known to be a single-column type.

Specified by:

nullSafeGet in interface Type

name - the column name

owner - the parent entity

Returns:

Object

Throws:

SQLException

nullSafeGet

public final T nullSafeGet(ResultSet rs,
                           String name,
                           SessionImplementor session)
                    throws SQLException

Throws:

SQLException

nullSafeGet

protected final T nullSafeGet(ResultSet rs,
                              String name,
                              WrapperOptions options)
                       throws SQLException

Throws:

SQLException

get

public Object get(ResultSet rs,
                  String name,
                  SessionImplementor session)
           throws HibernateException,
                  SQLException

Throws:

HibernateException

SQLException

nullSafeSet

public final void nullSafeSet(PreparedStatement st,
                              Object value,
                              int index,
                              SessionImplementor session)
                       throws SQLException

Description copied from interface: Type

Write an instance of the mapped class to a prepared statement. Implementors should handle possibility of null values. A multi-column type should be written to parameters starting from index.

Specified by:

nullSafeSet in interface Type

value - the object to write

index - statement parameter index

Throws:

SQLException

nullSafeSet

protected final void nullSafeSet(PreparedStatement st,
                                 Object value,
                                 int index,
                                 WrapperOptions options)
                          throws SQLException

Throws:

SQLException

set

public void set(PreparedStatement st,
                T value,
                int index,
                SessionImplementor session)
         throws HibernateException,
                SQLException

Throws:

HibernateException

SQLException

toLoggableString

public final String toLoggableString(Object value,
                                     SessionFactoryImplementor factory)

Description copied from interface: Type

A representation of the value to be embedded in a log file.

Specified by:

toLoggableString in interface Type

Returns:

String

setToXMLNode

public final void setToXMLNode(org.dom4j.Node node,
                               Object value,
                               SessionFactoryImplementor factory)

Description copied from interface: Type

A representation of the value to be embedded in an XML element.

Specified by:

setToXMLNode in interface Type

fromXMLNode

public final Object fromXMLNode(org.dom4j.Node xml,
                                Mapping factory)

Description copied from interface: Type

Parse the XML representation of an instance.

Specified by:

fromXMLNode in interface Type

Returns:

an instance of the type

isMutable

public final boolean isMutable()

Description copied from interface: Type

Are objects of this type mutable. (With respect to the referencing object ... entities and collections are considered immutable because they manage their own internal state.)

Specified by:

isMutable in interface Type

Returns:

boolean

deepCopy

public final Object deepCopy(Object value,
                             EntityMode entityMode,
                             SessionFactoryImplementor factory)

Description copied from interface: Type

Return a deep copy of the persistent state, stopping at entities and at collections.

Specified by:

deepCopy in interface Type

Parameters:

value - generally a collection element or entity field

Returns:

Object a copy

deepCopy

protected final T deepCopy(T value)

disassemble

public final Serializable disassemble(Object value,
                                      SessionImplementor session,
                                      Object owner)
                               throws HibernateException

Description copied from interface: Type

Return a cacheable "disassembled" representation of the object.

Specified by:

disassemble in interface Type

Parameters:

value - the value to cache

session - the session

owner - optional parent entity object (needed for collections)

Returns:

the disassembled, deep cloned state

Throws:

HibernateException

assemble

public final Object assemble(Serializable cached,
                             SessionImplementor session,
                             Object owner)
                      throws HibernateException

Description copied from interface: Type

Reconstruct the object from its cached "disassembled" state.

Specified by:

assemble in interface Type

Parameters:

cached - the disassembled state from the cache

session - the session

owner - the parent entity object

Returns:

the the object

Throws:

HibernateException

beforeAssemble

public final void beforeAssemble(Serializable cached,
                                 SessionImplementor session)

Description copied from interface: Type

Called before assembling a query result set from the query cache, to allow batch fetching of entities missing from the second-level cache.

Specified by:

beforeAssemble in interface Type

hydrate

public final Object hydrate(ResultSet rs,
                            String[] names,
                            SessionImplementor session,
                            Object owner)
                     throws HibernateException,
                            SQLException

Description copied from interface: Type

Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. This is useful for 2-phase property initialization - the second phase is a call to resolveIdentifier().

Specified by:

hydrate in interface Type

names - the column names

session - the session

owner - the parent entity

Returns:

Object an identifier or actual value

Throws:

HibernateException

SQLException

See Also:

Type.resolve(Object, SessionImplementor, Object)

resolve

public final Object resolve(Object value,
                            SessionImplementor session,
                            Object owner)
                     throws HibernateException

Description copied from interface: Type

Map identifiers to entities or collections. This is the second phase of 2-phase property initialization.

Specified by:

resolve in interface Type

Parameters:

value - an identifier or value returned by hydrate()

session - the session

owner - the parent entity

Returns:

the given value, or the value associated with the identifier

Throws:

HibernateException

See Also:

Type.hydrate(ResultSet, String[], SessionImplementor, Object)

semiResolve

public final Object semiResolve(Object value,
                                SessionImplementor session,
                                Object owner)
                         throws HibernateException

Description copied from interface: Type

Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.

Specified by:

semiResolve in interface Type

Throws:

HibernateException

getSemiResolvedType

public final Type getSemiResolvedType(SessionFactoryImplementor factory)

Description copied from interface: Type

Get the type of a semi-resolved value.

Specified by:

getSemiResolvedType in interface Type

replace

public final Object replace(Object original,
                            Object target,
                            SessionImplementor session,
                            Object owner,
                            Map copyCache)

Description copied from interface: Type

During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging. For immutable objects, or null values, it is safe to simply return the first parameter. For mutable objects, it is safe to return a copy of the first parameter. For objects with component values, it might make sense to recursively replace component values.

Specified by:

replace in interface Type

Parameters:

original - the value from the detached entity being merged

target - the value in the managed entity

Returns:

the value to be merged

replace

public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner,
                      Map copyCache,
                      ForeignKeyDirection foreignKeyDirection)

Description copied from interface: Type

During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging. For immutable objects, or null values, it is safe to simply return the first parameter. For mutable objects, it is safe to return a copy of the first parameter. For objects with component values, it might make sense to recursively replace component values.

Specified by:

replace in interface Type

Parameters:

original - the value from the detached entity being merged

target - the value in the managed entity

Returns:

the value to be merged