Package org.hibernate.type

Class CustomType

java.lang.Object

org.hibernate.type.AbstractType

org.hibernate.type.CustomType

All Implemented Interfaces:

java.io.Serializable, BasicType, DiscriminatorType, IdentifierType, LiteralType, ProcedureParameterExtractionAware, ProcedureParameterNamedBinder, StringRepresentableType, Type, VersionType

public class CustomType
extends AbstractType
implements IdentifierType, DiscriminatorType, VersionType, BasicType, StringRepresentableType, ProcedureParameterNamedBinder, ProcedureParameterExtractionAware

Adapts UserType to the generic Type interface, in order to isolate user code from changes in the internal Type contracts.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.hibernate.type.AbstractType

LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE

Constructor Summary

Constructors

Constructor	Description
CustomType(UserType userType)
CustomType(UserType userType, java.lang.String[] registrationKeys)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	assemble(java.io.Serializable cached, SharedSessionContractImplementor session, java.lang.Object owner)	Reconstruct the object from its disassembled state.
boolean	canDoExtraction()	Can the given instance of this type actually perform the parameter value extractions?
boolean	canDoSetting()	Can the given instance of this type actually set the parameter value by name
java.lang.Object	deepCopy(java.lang.Object value, SessionFactoryImplementor factory)	Return a deep copy of the persistent state, stopping at entities and at collections.
Size[]	defaultSizes(Mapping mapping)	Defines the column sizes to use according to this type if the user did not explicitly say (and if no Type.dictatedSizes(org.hibernate.engine.spi.Mapping) were given).
Size[]	dictatedSizes(Mapping mapping)	Return the column sizes dictated by this type.
java.io.Serializable	disassemble(java.lang.Object value, SharedSessionContractImplementor session, java.lang.Object owner)	Return a disassembled representation of the object.
boolean	equals(java.lang.Object obj)
java.lang.Object	extract(java.sql.CallableStatement statement, int startIndex, SharedSessionContractImplementor session)	Perform the extraction
java.lang.Object	extract(java.sql.CallableStatement statement, java.lang.String[] paramNames, SharedSessionContractImplementor session)	Perform the extraction
java.lang.Object	fromStringValue(java.lang.String string)	Consume the given string representation back into this types java form.
java.lang.Object	fromXMLString(java.lang.String xml, Mapping factory)
int	getColumnSpan(Mapping session)	How many columns are used to persist this type.
java.util.Comparator	getComparator()	Get a comparator for version values.
int	getHashCode(java.lang.Object x)	Get a hash code, consistent with persistence "equality".
java.lang.String	getName()	Returns the abbreviated name of the type.
java.lang.String[]	getRegistrationKeys()	Get the names under which this type should be registered in the type registry.
java.lang.Class	getReturnedClass()	The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object) methods.
UserType	getUserType()
int	hashCode()
boolean	isDirty(java.lang.Object old, java.lang.Object current, boolean[] checkable, SharedSessionContractImplementor session)	Should the parent be considered dirty, given both the old and current value?
boolean	isEqual(java.lang.Object x, java.lang.Object y)	Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).
boolean	isMutable()	Are objects of this type mutable.
java.lang.Object	next(java.lang.Object current, SharedSessionContractImplementor session)	Increment the version.
java.lang.Object	nullSafeGet(java.sql.ResultSet rs, java.lang.String[] names, SharedSessionContractImplementor session, java.lang.Object owner)	Extract a value of the mapped class from the JDBC result set.
java.lang.Object	nullSafeGet(java.sql.ResultSet rs, java.lang.String columnName, SharedSessionContractImplementor session, java.lang.Object owner)	Extract a value of the mapped class from the JDBC result set.
void	nullSafeSet(java.sql.CallableStatement statement, java.lang.Object value, java.lang.String name, SharedSessionContractImplementor session)	Bind a value to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter.
void	nullSafeSet(java.sql.PreparedStatement st, java.lang.Object value, int index, boolean[] settable, SharedSessionContractImplementor session)	Bind a value represented by an instance of the mapped class to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter.
void	nullSafeSet(java.sql.PreparedStatement st, java.lang.Object value, int index, SharedSessionContractImplementor session)	Bind a value represented by an instance of the mapped class to the JDBC prepared statement.
java.lang.String	objectToSQLString(java.lang.Object value, Dialect dialect)	Convert the value into a string representation, suitable for embedding in an SQL statement as a literal.
java.lang.Object	replace(java.lang.Object original, java.lang.Object target, SharedSessionContractImplementor session, java.lang.Object owner, java.util.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.
java.lang.Object	seed(SharedSessionContractImplementor session)	Generate an initial version.
int[]	sqlTypes(Mapping pi)	Return the JDBC types codes (per Types) for the columns mapped by this type.
java.lang.Object	stringToObject(java.lang.String xml)	Convert the value from the mapping file to a Java object.
boolean[]	toColumnNullness(java.lang.Object value, Mapping mapping)	Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
java.lang.String	toLoggableString(java.lang.Object value, SessionFactoryImplementor factory)	Generate a representation of the value for logging purposes.
java.lang.String	toString(java.lang.Object value)	Render the value to the string representation.
java.lang.String	toXMLString(java.lang.Object value, SessionFactoryImplementor factory)

Methods inherited from class org.hibernate.type.AbstractType

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.type.Type

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

Constructor Detail

CustomType

public CustomType(UserType userType)
           throws MappingException

Throws:

MappingException

CustomType

public CustomType(UserType userType,
                  java.lang.String[] registrationKeys)
           throws MappingException

Throws:

MappingException

Method Detail

getUserType

public UserType getUserType()

getRegistrationKeys

public java.lang.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.

sqlTypes

public int[] sqlTypes(Mapping pi)

Description copied from interface: Type

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

NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping).

Specified by:

sqlTypes in interface Type

Parameters:

pi - The mapping object :/

Returns:

The JDBC type codes.

dictatedSizes

public Size[] dictatedSizes(Mapping mapping)
                     throws MappingException

Description copied from interface: Type

Return the column sizes dictated by this type. For example, the mapping for a char/Character would have a dictated length limit of 1; for a string-based UUID would have a size limit of 36; etc.

NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping).

Specified by:

dictatedSizes in interface Type

Parameters:

mapping - The mapping object :/

Returns:

The dictated sizes.

Throws:

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

defaultSizes

public Size[] defaultSizes(Mapping mapping)
                    throws MappingException

Description copied from interface: Type

Defines the column sizes to use according to this type if the user did not explicitly say (and if no Type.dictatedSizes(org.hibernate.engine.spi.Mapping) were given).

NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping).

Specified by:

defaultSizes in interface Type

Parameters:

mapping - The mapping object :/

Returns:

The default sizes.

Throws:

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

getColumnSpan

public int getColumnSpan(Mapping session)

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:

session - The mapping object :/

Returns:

The number of columns

getReturnedClass

public java.lang.Class getReturnedClass()

Description copied from interface: Type

The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SharedSessionContractImplementor, 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.

isEqual

public boolean isEqual(java.lang.Object x,
                       java.lang.Object y)
                throws HibernateException

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

Overrides:

isEqual in class AbstractType

Parameters:

x - The first value

y - The second value

Returns:

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

Throws:

HibernateException - A problem occurred performing the comparison

getHashCode

public int getHashCode(java.lang.Object x)

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

Overrides:

getHashCode in class AbstractType

Parameters:

x - The value for which to retrieve a hash code

Returns:

The hash code

nullSafeGet

public java.lang.Object nullSafeGet(java.sql.ResultSet rs,
                                    java.lang.String[] names,
                                    SharedSessionContractImplementor session,
                                    java.lang.Object owner)
                             throws java.sql.SQLException

Description copied from interface: Type

Extract a value of the mapped class from the JDBC result set. Implementors should handle possibility of null values.

Specified by:

nullSafeGet in interface Type

Parameters:

rs - The result set from which to extract value.

names - the column names making up this type value (use to read from result set)

session - The originating session

owner - the parent entity

Returns:

The extracted value

Throws:

java.sql.SQLException - An error from the JDBC driver

See Also:

alternative, 2-phase property initialization

nullSafeGet

public java.lang.Object nullSafeGet(java.sql.ResultSet rs,
                                    java.lang.String columnName,
                                    SharedSessionContractImplementor session,
                                    java.lang.Object owner)
                             throws java.sql.SQLException

Description copied from interface: Type

Extract a value of the mapped class from the JDBC result set. Implementors should handle possibility of null values. This form might be called if the type is known to be a single-column type.

Specified by:

nullSafeGet in interface Type

Parameters:

rs - The result set from which to extract value.

columnName - the column name making up this type value (use to read from result set)

session - The originating session

owner - the parent entity

Returns:

The extracted value

Throws:

java.sql.SQLException - An error from the JDBC driver

assemble

public java.lang.Object assemble(java.io.Serializable cached,
                                 SharedSessionContractImplementor session,
                                 java.lang.Object owner)

Description copied from interface: Type

Reconstruct the object from its disassembled state. This method is the reciprocal of Type.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)

Specified by:

assemble in interface Type

Overrides:

assemble in class AbstractType

Parameters:

cached - the disassembled state from the cache

session - the originating session

owner - the parent entity object

Returns:

the (re)assembled object

disassemble

public java.io.Serializable disassemble(java.lang.Object value,
                                        SharedSessionContractImplementor session,
                                        java.lang.Object owner)

Description copied from interface: Type

Return a disassembled representation of the object. This is the value Hibernate will use in second level caching, so care should be taken to break values down to their simplest forms; for entities especially, this means breaking them down into their constituent parts.

Specified by:

disassemble in interface Type

Overrides:

disassemble in class AbstractType

Parameters:

value - the value to cache

session - the originating session

owner - optional parent entity object (needed for collections)

Returns:

the disassembled, deep cloned state

replace

public java.lang.Object replace(java.lang.Object original,
                                java.lang.Object target,
                                SharedSessionContractImplementor session,
                                java.lang.Object owner,
                                java.util.Map copyCache)
                         throws HibernateException

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

session - The originating session

owner - The owner of the value

copyCache - The cache of already copied/replaced values

Returns:

the value to be merged

Throws:

HibernateException - An error from Hibernate

nullSafeSet

public void nullSafeSet(java.sql.PreparedStatement st,
                        java.lang.Object value,
                        int index,
                        boolean[] settable,
                        SharedSessionContractImplementor session)
                 throws java.sql.SQLException

Description copied from interface: Type

Bind a value represented by an instance of the mapped class to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the possibility of null values. A multi-column type should bind parameters starting from index.

Specified by:

nullSafeSet in interface Type

Parameters:

st - The JDBC prepared statement to which to bind

value - the object to write

index - starting parameter bind index

settable - an array indicating which columns to bind/ignore

session - The originating session

Throws:

java.sql.SQLException - An error from the JDBC driver

nullSafeSet

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

Description copied from interface: Type

Bind a value represented by an instance of the mapped class to the JDBC prepared statement. Implementors should handle possibility of null values. A multi-column type should bind parameters starting from index.

Specified by:

nullSafeSet in interface Type

Parameters:

st - The JDBC prepared statement to which to bind

value - the object to write

index - starting parameter bind index

session - The originating session

Throws:

java.sql.SQLException - An error from the JDBC driver

toXMLString

public java.lang.String toXMLString(java.lang.Object value,
                                    SessionFactoryImplementor factory)

fromXMLString

public java.lang.Object fromXMLString(java.lang.String xml,
                                      Mapping factory)

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

deepCopy

public java.lang.Object deepCopy(java.lang.Object value,
                                 SessionFactoryImplementor factory)
                          throws HibernateException

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 - The value to be copied

factory - The session factory

Returns:

The deep copy

Throws:

HibernateException - An error from Hibernate

isMutable

public 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

stringToObject

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

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:

The converted value of the string representation.

objectToSQLString

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

Description copied from interface: LiteralType

Convert the value into a string representation, suitable for embedding in an SQL statement as a literal.

Specified by:

objectToSQLString in interface LiteralType

Parameters:

value - The value to convert

dialect - The SQL dialect

Returns:

The value's string representation

Throws:

java.lang.Exception - Indicates an issue converting the value to literal string.

getComparator

public java.util.Comparator getComparator()

Description copied from interface: VersionType

Get a comparator for version values.

Specified by:

getComparator in interface VersionType

Returns:

The comparator to use to compare different version values.

next

public java.lang.Object next(java.lang.Object current,
                             SharedSessionContractImplementor session)

Description copied from interface: VersionType

Increment the version.

Specified by:

next in interface VersionType

Parameters:

current - the current version

session - The session from which this request originates.

Returns:

an instance of the type

seed

public java.lang.Object seed(SharedSessionContractImplementor session)

Description copied from interface: VersionType

Generate an initial version.

Specified by:

seed in interface VersionType

Parameters:

session - The session from which this request originates.

Returns:

an instance of the type

toLoggableString

public java.lang.String toLoggableString(java.lang.Object value,
                                         SessionFactoryImplementor factory)
                                  throws HibernateException

Description copied from interface: Type

Generate a representation of the value for logging purposes.

Specified by:

toLoggableString in interface Type

Parameters:

value - The value to be logged

factory - The session factory

Returns:

The loggable representation

Throws:

HibernateException - An error from Hibernate

toColumnNullness

public boolean[] toColumnNullness(java.lang.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

mapping - The mapping abstraction

Returns:

array indicating column nullness for a value instance

isDirty

public boolean isDirty(java.lang.Object old,
                       java.lang.Object current,
                       boolean[] checkable,
                       SharedSessionContractImplementor session)
                throws HibernateException

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

Throws:

HibernateException - A problem occurred performing the checking

toString

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

Description copied from interface: StringRepresentableType

Render the value to the string representation.

Specified by:

toString in interface StringRepresentableType

Parameters:

value - The value to render to string.

Returns:

The string representation

Throws:

HibernateException - Problem rendering

fromStringValue

public java.lang.Object fromStringValue(java.lang.String string)
                                 throws HibernateException

Description copied from interface: StringRepresentableType

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

Specified by:

fromStringValue in interface StringRepresentableType

Parameters:

string - The string representation to be consumed.

Returns:

The java type representation

Throws:

HibernateException - Problem consuming

canDoSetting

public boolean canDoSetting()

Description copied from interface: ProcedureParameterNamedBinder

Can the given instance of this type actually set the parameter value by name

Specified by:

canDoSetting in interface ProcedureParameterNamedBinder

Returns:

true indicates that @{link #nullSafeSet} calls will not fail

nullSafeSet

public void nullSafeSet(java.sql.CallableStatement statement,
                        java.lang.Object value,
                        java.lang.String name,
                        SharedSessionContractImplementor session)
                 throws java.sql.SQLException

Description copied from interface: ProcedureParameterNamedBinder

Bind a value to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the possibility of null values. Does not support multi-column type

Specified by:

nullSafeSet in interface ProcedureParameterNamedBinder

Parameters:

statement - The CallableStatement to which to bind

value - the object to write

name - parameter bind name

session - The originating session

Throws:

java.sql.SQLException - An error from the JDBC driver

canDoExtraction

public boolean canDoExtraction()

Description copied from interface: ProcedureParameterExtractionAware

Can the given instance of this type actually perform the parameter value extractions?

Specified by:

canDoExtraction in interface ProcedureParameterExtractionAware

Returns:

true indicates that @{link #extract} calls will not fail due to IllegalStateException.

extract

public java.lang.Object extract(java.sql.CallableStatement statement,
                                int startIndex,
                                SharedSessionContractImplementor session)
                         throws java.sql.SQLException

Description copied from interface: ProcedureParameterExtractionAware

Perform the extraction

Specified by:

extract in interface ProcedureParameterExtractionAware

Parameters:

statement - The CallableStatement from which to extract the parameter value(s).

startIndex - The parameter index from which to start extracting; assumes the values (if multiple) are contiguous

session - The originating session

Returns:

The extracted value.

Throws:

java.sql.SQLException - Indicates an issue calling into the CallableStatement

extract

public java.lang.Object extract(java.sql.CallableStatement statement,
                                java.lang.String[] paramNames,
                                SharedSessionContractImplementor session)
                         throws java.sql.SQLException

Description copied from interface: ProcedureParameterExtractionAware

Perform the extraction

Specified by:

extract in interface ProcedureParameterExtractionAware

Parameters:

statement - The CallableStatement from which to extract the parameter value(s).

paramNames - The parameter names.

session - The originating session

Returns:

The extracted value.

Throws:

java.sql.SQLException - Indicates an issue calling into the CallableStatement

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object