CustomType (Hibernate Core Aggregator 3.6.10.Final API)

java.lang.Object
- org.hibernate.type.AbstractType
- - org.hibernate.type.CustomType

All Implemented Interfaces:

Serializable, BasicType, DiscriminatorType, IdentifierType, LiteralType, Type, VersionType
```
public class CustomType
extends AbstractType
implements IdentifierType, DiscriminatorType, VersionType, BasicType
```
Adapts UserType to the generic Type interface, in order to isolate user code from changes in the internal Type contracts.

Author:

Gavin King, Steve Ebersole

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

CustomType(UserType userType)

CustomType(UserType userType, String[] registrationKeys)

Constructors
Constructor and Description
`CustomType(UserType userType)`
`CustomType(UserType userType, String[] registrationKeys)`

Method Summary

Methods
Modifier and Type	Method and Description
`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(org.dom4j.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 `Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.SessionImplementor, java.lang.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)` Are the two version values considered equal?
`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`	`isMutable()` Are objects of this type mutable.
`Object`	`next(Object current, SessionImplementor session)` Increment the version.
`Object`	`nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)` Retrieve an instance of the mapped class from a JDBC resultset.
`Object`	`nullSafeGet(ResultSet rs, String columnName, 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)` Convert the value into a string representation, suitable for embedding in an SQL statement as a literal.
`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(org.dom4j.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 `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)`

Methods inherited from class org.hibernate.type.AbstractType
beforeAssemble, compare, 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
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isEntityType, isEqual, isModified, isSame, isXMLElement, replace, resolve, semiResolve

- Constructor Detail
  - CustomType
```
public CustomType(UserType userType)
           throws MappingException
```
    Throws:
    
    MappingException
  - CustomType
```
public CustomType(UserType userType,
          String[] registrationKeys)
           throws MappingException
```
    Throws:
    
    MappingException
- Method Detail
  - getUserType
```
public UserType getUserType()
```
  - 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.
  - 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.
    
    Specified by:
    
    sqlTypes in interface Type
    
    Parameters:
    pi - The mapping object :/
    
    Returns:
    The JDBC type codes.
  - 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 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.
  - isEqual
```
public boolean isEqual(Object x,
              Object y)
                throws HibernateException
```
    Description copied from interface: VersionType
    
    Are the two version values considered equal?
    
    Specified by:
    
    isEqual in interface VersionType
    
    Parameters:
    x - One value to check.
    y - The other value to check.
    
    Returns:
    true if the values are equal, false otherwise.
    
    Throws:
    
    HibernateException
  - isEqual
```
public boolean isEqual(Object x,
              Object y,
              EntityMode entityMode)
                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
    entityMode - The entity mode of the values.
    
    Returns:
    True if there are considered equal (see discussion above).
    
    Throws:
    
    HibernateException - A problem occurred performing the comparison
  - getHashCode
```
public 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
    
    Overrides:
    
    getHashCode in class AbstractType
    
    Parameters:
    x - The value for which to retrieve a hash code
    entityMode - The entity mode of the value.
    
    Returns:
    The hash code
  - nullSafeGet
```
public Object nullSafeGet(ResultSet rs,
                 String[] names,
                 SessionImplementor session,
                 Object owner)
                   throws HibernateException,
                          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:
    
    HibernateException
    
    SQLException
    See Also:
    alternative, 2-phase property initialization
  - nullSafeGet
```
public Object nullSafeGet(ResultSet rs,
                 String columnName,
                 SessionImplementor session,
                 Object owner)
                   throws HibernateException,
                          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
    
    columnName - the column name
    owner - the parent entity
    
    Returns:
    Object
    
    Throws:
    
    HibernateException
    
    SQLException
  - assemble
```
public 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
    
    Overrides:
    
    assemble in class AbstractType
    
    Parameters:
    cached - the disassembled state from the cache
    session - the session
    owner - the parent entity object
    
    Returns:
    the the object
    
    Throws:
    
    HibernateException
  - disassemble
```
public 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
    
    Overrides:
    
    disassemble in class AbstractType
    
    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
  - replace
```
public Object replace(Object original,
             Object target,
             SessionImplementor session,
             Object owner,
             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
    
    Returns:
    the value to be merged
    
    Throws:
    
    HibernateException
  - nullSafeSet
```
public void nullSafeSet(PreparedStatement st,
               Object value,
               int index,
               boolean[] settable,
               SessionImplementor session)
                 throws HibernateException,
                        SQLException
```
    Description copied from interface: Type
    
    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.
    
    Specified by:
    
    nullSafeSet in interface Type
    
    value - the object to write
    index - statement parameter index
    settable - an array indicating which columns to ignore
    
    Throws:
    
    HibernateException
    
    SQLException
  - nullSafeSet
```
public void nullSafeSet(PreparedStatement st,
               Object value,
               int index,
               SessionImplementor session)
                 throws HibernateException,
                        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:
    
    HibernateException
    
    SQLException
  - toXMLString
```
public String toXMLString(Object value,
                 SessionFactoryImplementor factory)
```
  - fromXMLString
```
public Object fromXMLString(String xml,
                   Mapping factory)
```
  - getName
```
public 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 Object deepCopy(Object value,
              EntityMode entityMode,
              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 - generally a collection element or entity field
    
    Returns:
    Object a copy
    
    Throws:
    
    HibernateException
  - 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 Object stringToObject(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 String objectToSQLString(Object value,
                       Dialect dialect)
                         throws 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:
    
    Exception - Indicates an issue converting the value to literal string.
  - getComparator
```
public 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 Object next(Object current,
          SessionImplementor 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 Object seed(SessionImplementor 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
  - fromXMLNode
```
public Object fromXMLNode(org.dom4j.Node xml,
                 Mapping factory)
                   throws HibernateException
```
    Description copied from interface: Type
    
    Parse the XML representation of an instance.
    
    Specified by:
    
    fromXMLNode in interface Type
    
    Returns:
    an instance of the type
    
    Throws:
    
    HibernateException
  - setToXMLNode
```
public void setToXMLNode(org.dom4j.Node node,
                Object value,
                SessionFactoryImplementor factory)
                  throws HibernateException
```
    Description copied from interface: Type
    
    A representation of the value to be embedded in an XML element.
    
    Specified by:
    
    setToXMLNode in interface Type
    
    Throws:
    
    HibernateException
  - toLoggableString
```
public String toLoggableString(Object value,
                      SessionFactoryImplementor factory)
                        throws HibernateException
```
    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
    
    Throws:
    
    HibernateException
  - 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
  - isDirty
```
public boolean isDirty(Object old,
              Object current,
              boolean[] checkable,
              SessionImplementor 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

Class CustomType

Constructor Summary

Method Summary

Methods inherited from class org.hibernate.type.AbstractType

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.type.Type

Constructor Detail

CustomType

CustomType

Method Detail

getUserType

getRegistrationKeys

sqlTypes

getColumnSpan

getReturnedClass

isEqual

isEqual

getHashCode

nullSafeGet

nullSafeGet

assemble

disassemble

replace

nullSafeSet

nullSafeSet

toXMLString

fromXMLString

getName

deepCopy

isMutable

stringToObject

objectToSQLString

getComparator

next

seed

fromXMLNode

setToXMLNode

toLoggableString

toColumnNullness

isDirty