public class

CustomType

extends AbstractType
implements BasicType DiscriminatorType<T> IdentifierType<T> VersionType<T>
java.lang.Object
   ↳ org.hibernate.type.AbstractType
     ↳ org.hibernate.type.CustomType

Class Overview

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

Summary

Public Constructors
CustomType(UserType userType)
CustomType(UserType userType, String[] registrationKeys)
Public Methods
Object assemble(Serializable cached, SessionImplementor session, Object owner)
Reconstruct the object from its cached "disassembled" state.
Object deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections.
Serializable disassemble(Object value, SessionImplementor session, Object owner)
Return a cacheable "disassembled" representation of the object.
Object fromXMLNode(Node xml, Mapping factory)
Parse the XML representation of an instance.
Object fromXMLString(String xml, Mapping factory)
int getColumnSpan(Mapping session)
How many columns are used to persist this type.
Comparator getComparator()
Get a comparator for version values.
int getHashCode(Object x, EntityMode entityMode)
Get a hash code, consistent with persistence "equality".
String getName()
Returns the abbreviated name of the type.
String[] getRegistrationKeys()
Get the names under which this type should be registered in the type registry.
Class getReturnedClass()
The class returned by nullSafeGet(ResultSet, String, SessionImplementor, Object) methods.
UserType getUserType()
boolean isDirty(Object old, Object current, boolean[] checkable, SessionImplementor session)
Should the parent be considered dirty, given both the old and current value?
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)
boolean isMutable()
Are objects of this type mutable.
Object next(Object current, SessionImplementor session)
Object nullSafeGet(ResultSet rs, String columnName, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class from a JDBC resultset.
Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class from a JDBC resultset.
void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session)
Write an instance of the mapped class to a prepared statement, ignoring some columns.
void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session)
Write an instance of the mapped class to a prepared statement.
String objectToSQLString(Object value, Dialect dialect)
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 seed(SessionImplementor session)
Generate an initial version.
void setToXMLNode(Node node, Object value, SessionFactoryImplementor factory)
A representation of the value to be embedded in an XML element.
int[] sqlTypes(Mapping pi)
Return the JDBC types codes (per java.sql.Types) for the columns mapped by this type.
Object stringToObject(String xml)
Convert the value from the mapping file to a Java object.
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 toXMLString(Object value, SessionFactoryImplementor factory)
[Expand]
Inherited Methods
From class org.hibernate.type.AbstractType
From class java.lang.Object
From interface org.hibernate.type.BasicType
From interface org.hibernate.type.IdentifierType
From interface org.hibernate.type.LiteralType
From interface org.hibernate.type.Type
From interface org.hibernate.type.VersionType

Public Constructors

public CustomType (UserType userType)

Throws
MappingException

public CustomType (UserType userType, String[] registrationKeys)

Throws
MappingException

Public Methods

public Object assemble (Serializable cached, SessionImplementor session, Object owner)

Reconstruct the object from its cached "disassembled" state.

Parameters
cached the disassembled state from the cache
session the session
owner the parent entity object
Returns
  • the the object
Throws
HibernateException

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

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

Parameters
value generally a collection element or entity field
Returns
  • Object a copy
Throws
HibernateException

public Serializable disassemble (Object value, SessionImplementor session, Object owner)

Return a cacheable "disassembled" representation of the object.

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

public Object fromXMLNode (Node xml, Mapping factory)

Parse the XML representation of an instance.

Returns
  • an instance of the type
Throws
HibernateException

public Object fromXMLString (String xml, Mapping factory)

public int getColumnSpan (Mapping session)

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

Parameters
session The mapping object :/
Returns
  • The number of columns

public Comparator getComparator ()

Get a comparator for version values.

Returns
  • The comparator to use to compare different version values.

public int getHashCode (Object x, EntityMode entityMode)

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

Parameters
x The value for which to retrieve a hash code
entityMode The entity mode of the value.
Returns
  • The hash code

public String getName ()

Returns the abbreviated name of the type.

Returns
  • String the Hibernate type name

public String[] getRegistrationKeys ()

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

Returns
  • The keys under which to register this type.

public Class getReturnedClass ()

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

Returns
  • The java type class handled by this type.

public UserType getUserType ()

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

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

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

public 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).

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

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).
Throws
HibernateException

public boolean isEqual (Object x, Object y)

Throws
HibernateException

public boolean isMutable ()

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

Returns
  • boolean

public Object next (Object current, SessionImplementor session)

public Object nullSafeGet (ResultSet rs, String columnName, SessionImplementor session, Object owner)

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.

Parameters
columnName the column name
owner the parent entity
Returns
  • Object
Throws
HibernateException
SQLException

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

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

Parameters
names the column names
owner the parent entity
Returns
  • Object
Throws
HibernateException
SQLException

public void nullSafeSet (PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session)

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

Parameters
value the object to write
index statement parameter index
settable an array indicating which columns to ignore
Throws
HibernateException
SQLException

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

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.

Parameters
value the object to write
index statement parameter index
Throws
HibernateException
SQLException

public String objectToSQLString (Object value, Dialect dialect)

Throws
Exception

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

Parameters
original the value from the detached entity being merged
target the value in the managed entity
Returns
  • the value to be merged
Throws
HibernateException

public Object seed (SessionImplementor session)

Generate an initial version.

Parameters
session The session from which this request originates.
Returns
  • an instance of the type

public void setToXMLNode (Node node, Object value, SessionFactoryImplementor factory)

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

Returns
  • String
Throws
HibernateException

public int[] sqlTypes (Mapping pi)

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

Parameters
pi The mapping object :/
Returns
  • The JDBC type codes.

public Object stringToObject (String xml)

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

Parameters
xml the value of discriminator-value or unsaved-value attribute
Returns
  • The converted value of the string representation.

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

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

Parameters
value an instance of the type

public String toLoggableString (Object value, SessionFactoryImplementor factory)

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

Returns
  • String
Throws
HibernateException

public String toXMLString (Object value, SessionFactoryImplementor factory)