Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.hibernate.type

Class CompositeCustomType

Implemented Interfaces:
AbstractComponentType, Serializable, Type
public class CompositeCustomType
extends AbstractType
implements AbstractComponentType
Adapts CompositeUserType to Type interface
Author:
Gavin King

Constructor Summary

CompositeCustomType(Class userTypeClass, Properties parameters)

Method Summary

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.
CascadeStyle
getCascadeStyle(int i)
int
getColumnSpan(Mapping mapping)
How many columns are used to persist this type.
FetchMode
getFetchMode(int i)
int
getHashCode(Object x, EntityMode entityMode)
Get a hashcode, consistent with persistence "equality"
String
getName()
Returns the abbreviated name of the type.
String[]
getPropertyNames()
boolean[]
getPropertyNullability()
Object
getPropertyValue(Object component, int i)
Object
getPropertyValue(Object component, int i, SessionImplementor session)
Object[]
getPropertyValues(Object component, EntityMode entityMode)
Object[]
getPropertyValues(Object component, SessionImplementor session)
Class
getReturnedClass()
The class returned by nullSafeGet() methods.
Type[]
getSubtypes()
boolean
isComponentType()
Is this type a component type.
boolean
isDirty(Object old, Object current, boolean[] checkable, SessionImplementor session)
Should the parent be considered dirty, given both the old and current field or element value?
boolean
isEmbedded()
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
isMethodOf(Method method)
boolean
isMutable()
Are objects of this type mutable.
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.
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.
void
setPropertyValues(Object component, Object[] values, EntityMode entityMode)
void
setToXMLNode(Node node, Object value, SessionFactoryImplementor factory)
A representation of the value to be embedded in an XML element.
int[]
sqlTypes(Mapping mapping)
Return the SQL type codes 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.

Methods inherited from class org.hibernate.type.AbstractType

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

Constructor Details

CompositeCustomType

public CompositeCustomType(Class userTypeClass,
                           Properties parameters)
            throws MappingException

Method Details

assemble

public Object assemble(Serializable cached,
                       SessionImplementor session,
                       Object owner)
            throws HibernateException
Reconstruct the object from its cached "disassembled" state.
Specified by:
assemble in interface Type
Overrides:
assemble in interface AbstractType
Parameters:
cached - the disassembled state from the cache
session - the session
owner - the parent entity object
Returns:
the the object

deepCopy

public Object deepCopy(Object value,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
            throws HibernateException
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
entityMode -
factory -
Returns:
Object a copy

disassemble

public Serializable disassemble(Object value,
                                SessionImplementor session,
                                Object owner)
            throws HibernateException
Return a cacheable "disassembled" representation of the object.
Specified by:
disassemble in interface Type
Overrides:
disassemble in interface AbstractType
Parameters:
value - the value to cache
session - the session
owner - optional parent entity object (needed for collections)
Returns:
the disassembled, deep cloned state

fromXMLNode

public Object fromXMLNode(Node xml,
                          Mapping factory)
            throws HibernateException
Parse the XML representation of an instance.
Specified by:
fromXMLNode in interface Type
Parameters:
xml -
factory -
Returns:
an instance of the type
Throws:
HibernateException -

getCascadeStyle

public CascadeStyle getCascadeStyle(int i)
Specified by:
getCascadeStyle in interface AbstractComponentType

getColumnSpan

public int getColumnSpan(Mapping mapping)
            throws MappingException
How many columns are used to persist this type.
Specified by:
getColumnSpan in interface Type

getFetchMode

public FetchMode getFetchMode(int i)
Specified by:
getFetchMode in interface AbstractComponentType

getHashCode

public int getHashCode(Object x,
                       EntityMode entityMode)
Get a hashcode, consistent with persistence "equality"
Specified by:
getHashCode in interface Type
Overrides:
getHashCode in interface AbstractType
Parameters:
x -
entityMode -

getName

public String getName()
Returns the abbreviated name of the type.
Specified by:
getName in interface Type
Returns:
String the Hibernate type name

getPropertyNames

public String[] getPropertyNames()
Specified by:
getPropertyNames in interface AbstractComponentType

getPropertyNullability

public boolean[] getPropertyNullability()
Specified by:
getPropertyNullability in interface AbstractComponentType

getPropertyValue

public Object getPropertyValue(Object component,
                               int i)
            throws HibernateException

getPropertyValue

public Object getPropertyValue(Object component,
                               int i,
                               SessionImplementor session)
            throws HibernateException
Specified by:
getPropertyValue in interface AbstractComponentType

getPropertyValues

public Object[] getPropertyValues(Object component,
                                  EntityMode entityMode)
            throws HibernateException
Specified by:
getPropertyValues in interface AbstractComponentType

getPropertyValues

public Object[] getPropertyValues(Object component,
                                  SessionImplementor session)
            throws HibernateException
Specified by:
getPropertyValues in interface AbstractComponentType

getReturnedClass

public Class getReturnedClass()
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

getSubtypes

public Type[] getSubtypes()
Specified by:
getSubtypes in interface AbstractComponentType

isComponentType

public boolean isComponentType()
Is this type a component type. If so, the implementation must be castable to AbstractComponentType. A component type may own collections or associations and hence must provide certain extra functionality.
Specified by:
isComponentType in interface Type
Overrides:
isComponentType in interface AbstractType
Returns:
boolean
See Also:
AbstractComponentType

isDirty

public boolean isDirty(Object old,
                       Object current,
                       boolean[] checkable,
                       SessionImplementor session)
            throws HibernateException
Should the parent be considered dirty, given both the old and current field or element value?
Specified by:
isDirty in interface Type
Parameters:
old - the old value
current - the current value
checkable - which columns are actually updatable
session -
Returns:
true if the field is dirty

isEmbedded

public boolean isEmbedded()
Specified by:
isEmbedded in interface AbstractComponentType

isEqual

public boolean isEqual(Object x,
                       Object y,
                       EntityMode entityMode)
            throws HibernateException
Compare two instances of the class mapped by this type for persistence "equality" - equality of persistent state.
Specified by:
isEqual in interface Type
Overrides:
isEqual in interface AbstractType
Parameters:
x -
y -
entityMode -
Returns:
boolean
Throws:
HibernateException -

isMethodOf

public boolean isMethodOf(Method method)
Specified by:
isMethodOf in interface AbstractComponentType

isMutable

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.)
Specified by:
isMutable in interface Type
Returns:
boolean

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String columnName,
                          SessionImplementor session,
                          Object owner)
            throws HibernateException,
                   SQLException
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
Parameters:
rs -
session -
owner - the parent entity
Returns:
Object
Throws:
HibernateException -

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String[] names,
                          SessionImplementor session,
                          Object owner)
            throws HibernateException,
                   SQLException
Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.
Specified by:
nullSafeGet in interface Type
Parameters:
rs -
names - the column names
session -
owner - the parent entity
Returns:
Object
Throws:
HibernateException -
See Also:
alternative, 2-phase property initialization

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        boolean[] settable,
                        SessionImplementor session)
            throws HibernateException,
                   SQLException
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
Parameters:
st -
value - the object to write
index - statement parameter index
settable - an array indicating which columns to ignore
session -
Throws:
HibernateException -

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        SessionImplementor session)
            throws HibernateException,
                   SQLException
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
Parameters:
st -
value - the object to write
index - statement parameter index
session -
Throws:
HibernateException -

replace

public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner,
                      Map copyCache)
            throws HibernateException
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

setPropertyValues

public void setPropertyValues(Object component,
                              Object[] values,
                              EntityMode entityMode)
            throws HibernateException
Specified by:
setPropertyValues in interface AbstractComponentType

setToXMLNode

public void setToXMLNode(Node node,
                         Object value,
                         SessionFactoryImplementor factory)
            throws HibernateException
A representation of the value to be embedded in an XML element.
Specified by:
setToXMLNode in interface Type
Parameters:
value -
factory -
Throws:
HibernateException -

sqlTypes

public int[] sqlTypes(Mapping mapping)
            throws MappingException
Return the SQL type codes for the columns mapped by this type. The codes are defined on java.sql.Types.
Specified by:
sqlTypes in interface Type
Returns:
the typecodes
Throws:
MappingException -
See Also:
java.sql.Types

toColumnNullness

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.
Specified by:
toColumnNullness in interface Type
Parameters:
value - an instance of the type

toLoggableString

public String toLoggableString(Object value,
                               SessionFactoryImplementor factory)
            throws HibernateException
A representation of the value to be embedded in a log file.
Specified by:
toLoggableString in interface Type
Parameters:
value -
factory -
Returns:
String
Throws:
HibernateException -

Overview Package Tree Index Deprecated About