org.hibernate.type

Class ComponentType

Implemented Interfaces:
AbstractComponentType, Serializable, Type
Known Direct Subclasses:
EmbeddedComponentType

public class ComponentType
extends AbstractType
implements AbstractComponentType

Handles "component" mappings
Author:
Gavin King

Field Summary

protected int
propertySpan
protected EntityModeToTuplizerMapping
tuplizerMapping

Constructor Summary

ComponentType(ComponentMetamodel metamodel)

Method Summary

Object
assemble(Serializable object, SessionImplementor session, Object owner)
Reconstruct the object from its cached "disassembled" state.
int
compare(Object x, Object y, EntityMode entityMode)
compare two instances of the type
Object
deepCopy(Object component, 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"
int
getHashCode(Object x, EntityMode entityMode, SessionFactoryImplementor factory)
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, EntityMode entityMode)
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()
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.
Object
instantiate(Object parent, SessionImplementor session)
Object
instantiate(EntityMode entityMode)
This method does not populate the component parent
boolean
isComponentType()
Is this type a component type.
boolean
isDirty(Object x, Object y, boolean[] checkable, SessionImplementor session)
Should the parent be considered dirty, given both the old and current field or element value?
boolean
isDirty(Object x, Object y, 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
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
isMethodOf(Method method)
boolean
isModified(Object old, Object current, boolean[] checkable, SessionImplementor session)
Has the parent object been modified, compared to the current database state?
boolean
isMutable()
Are objects of this type mutable.
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 name, 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 begin, 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 begin, 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.
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
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

Field Details

propertySpan

protected final int propertySpan

tuplizerMapping

protected final EntityModeToTuplizerMapping tuplizerMapping

Constructor Details

ComponentType

public ComponentType(ComponentMetamodel metamodel)

Method Details

assemble

public Object assemble(Serializable object,
                       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:
session - the session
owner - the parent entity object
Returns:
the the object

compare

public int compare(Object x,
                   Object y,
                   EntityMode entityMode)
compare two instances of the type
Specified by:
compare in interface Type
Overrides:
compare in interface AbstractType
Parameters:
entityMode -

deepCopy

public Object deepCopy(Object component,
                       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:
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

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 -

getHashCode

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

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,
                               EntityMode entityMode)
            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

hydrate

public Object hydrate(ResultSet rs,
                      String[] names,
                      SessionImplementor session,
                      Object owner)
            throws HibernateException,
                   SQLException
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
Overrides:
hydrate in interface AbstractType
Parameters:
rs -
names - the column names
session - the session
owner - the parent entity
Returns:
Object an identifier or actual value

instantiate

public Object instantiate(Object parent,
                          SessionImplementor session)
            throws HibernateException

instantiate

public Object instantiate(EntityMode entityMode)
            throws HibernateException
This method does not populate the component parent

isComponentType

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

isDirty

public boolean isDirty(Object x,
                       Object y,
                       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:
checkable - which columns are actually updatable
session -
Returns:
true if the field is dirty

isDirty

public boolean isDirty(Object x,
                       Object y,
                       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
Overrides:
isDirty in interface AbstractType
Parameters:
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

isEqual

public boolean isEqual(Object x,
                       Object y,
                       EntityMode entityMode,
                       SessionFactoryImplementor factory)
            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

isMethodOf

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

isModified

public boolean isModified(Object old,
                          Object current,
                          boolean[] checkable,
                          SessionImplementor session)
            throws HibernateException
Has the parent object been modified, compared to the current database state?
Specified by:
isModified in interface Type
Overrides:
isModified in interface AbstractType
Parameters:
checkable - which columns are actually updatable
session -
Returns:
true if the field has been modified

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

isSame

public boolean isSame(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 - taking a shortcut for entity references.
Specified by:
isSame in interface Type
Overrides:
isSame in interface AbstractType
Parameters:
x -
y -
entityMode -
Returns:
boolean

isXMLElement

public boolean isXMLElement()
Specified by:
isXMLElement in interface Type
Overrides:
isXMLElement in interface AbstractType

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String name,
                          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 -
name - the column name
session -
owner - the parent entity
Returns:
Object

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

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int begin,
                        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
settable - an array indicating which columns to ignore
session -

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int begin,
                        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
session -

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

replace

public Object replace(Object original,
                      Object target,
                      SessionImplementor session,
                      Object owner,
                      Map copyCache,
                      ForeignKeyDirection foreignKeyDirection)
            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
Overrides:
replace in interface AbstractType
Parameters:
original - the value from the detached entity being merged
target - the value in the managed entity
Returns:
the value to be merged

resolve

public Object resolve(Object value,
                      SessionImplementor session,
                      Object owner)
            throws HibernateException
Map identifiers to entities or collections. This is the second phase of 2-phase property initialization.
Specified by:
resolve in interface Type
Overrides:
resolve in interface AbstractType
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

semiResolve

public Object semiResolve(Object value,
                          SessionImplementor session,
                          Object owner)
            throws HibernateException
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
Specified by:
semiResolve in interface Type
Overrides:
semiResolve in interface AbstractType

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 -

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