Package org.hibernate.type
Class ComponentType
- java.lang.Object
-
- org.hibernate.type.AbstractType
-
- org.hibernate.type.ComponentType
-
- All Implemented Interfaces:
Serializable
,CompositeType
,ProcedureParameterExtractionAware
,Type
- Direct Known Subclasses:
EmbeddedComponentType
public class ComponentType extends AbstractType implements CompositeType, ProcedureParameterExtractionAware
Handles "component" mappings- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected ComponentTuplizer
componentTuplizer
protected EntityMode
entityMode
protected int
propertySpan
-
Fields inherited from class org.hibernate.type.AbstractType
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE
-
-
Constructor Summary
Constructors Constructor Description ComponentType(ComponentMetamodel metamodel)
ComponentType(TypeFactory.TypeScope typeScope, ComponentMetamodel metamodel)
Deprecated.Use the other constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
assemble(Serializable object, SharedSessionContractImplementor session, Object owner)
Reconstruct the object from its disassembled state.boolean
canDoExtraction()
Can the given instance of this type actually perform the parameter value extractions?int
compare(Object x, Object y)
Perform aComparator
style comparison between valuesObject
deepCopy(Object component, 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 noType.dictatedSizes(org.hibernate.engine.spi.Mapping)
were given).Size[]
dictatedSizes(Mapping mapping)
Return the column sizes dictated by this type.Serializable
disassemble(Object value, SharedSessionContractImplementor session, Object owner)
Return a disassembled representation of the object.Object
extract(CallableStatement statement, int startIndex, SharedSessionContractImplementor session)
Perform the extractionObject
extract(CallableStatement statement, String[] paramNames, SharedSessionContractImplementor session)
Perform the extractionCascadeStyle
getCascadeStyle(int i)
Retrieve the cascade style of the indicated component property.int
getColumnSpan(Mapping mapping)
How many columns are used to persist this type.ComponentTuplizer
getComponentTuplizer()
EntityMode
getEntityMode()
FetchMode
getFetchMode(int i)
Retrieve the fetch mode of the indicated component property.int
getHashCode(Object x)
Get a hash code, consistent with persistence "equality".int
getHashCode(Object x, SessionFactoryImplementor factory)
Get a hash code, consistent with persistence "equality".String
getName()
Returns the abbreviated name of the type.int
getPropertyIndex(String name)
Convenience method for locating the property index for a given property name.String[]
getPropertyNames()
Get the names of the component propertiesboolean[]
getPropertyNullability()
Retrieve the indicators regarding which component properties are nullable.Object
getPropertyValue(Object component, int i)
Object
getPropertyValue(Object component, int i, SharedSessionContractImplementor session)
Extract a particular component property value indicated by index.Object
getPropertyValue(Object component, int i, EntityMode entityMode)
ValueGeneration[]
getPropertyValueGenerationStrategies()
Object[]
getPropertyValues(Object component, SharedSessionContractImplementor session)
Extract the values of the component properties from the given component instanceObject[]
getPropertyValues(Object component, EntityMode entityMode)
Extract the values of the component properties from the given component instance without access to the session.Class
getReturnedClass()
Type[]
getSubtypes()
Get the types of the component propertiesboolean
hasNotNullProperty()
Convenience method to quickly checkCompositeType.getPropertyNullability()
for any non-nullable sub-properties.Object
hydrate(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner)
Extract a value from the JDBC result set.Object
instantiate(Object parent, SharedSessionContractImplementor session)
Object
instantiate(EntityMode entityMode)
This method does not populate the component parentboolean
isComponentType()
Return true if the implementation is castable toCompositeType
.boolean
isDirty(Object x, Object y, boolean[] checkable, SharedSessionContractImplementor session)
Should the parent be considered dirty, given both the old and current value?boolean
isDirty(Object x, Object y, SharedSessionContractImplementor session)
Should the parent be considered dirty, given both the old and current value?boolean
isEmbedded()
Is this component embedded? "embedded" indicates that the component is "virtual", that its properties are "flattened" onto its ownerboolean
isEqual(Object x, Object y)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).boolean
isEqual(Object x, Object y, SessionFactoryImplementor factory)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).boolean
isKey()
boolean
isMethodOf(Method method)
Is the given method a member of this component's class?boolean
isModified(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session)
Has the value been modified compared to the current database state? The difference between this and theType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)
methods is that here we need to account for "partially" built values.boolean
isMutable()
Are objects of this type mutable.boolean
isSame(Object x, Object y)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references.Object
nullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner)
Extract a value of themapped class
from the JDBC result set.Object
nullSafeGet(ResultSet rs, String name, SharedSessionContractImplementor session, Object owner)
Extract a value of themapped class
from the JDBC result set.void
nullSafeSet(PreparedStatement st, Object value, int begin, boolean[] settable, SharedSessionContractImplementor session)
Bind a value represented by an instance of themapped class
to the JDBC prepared statement, ignoring some columns as dictated by the 'settable' parameter.void
nullSafeSet(PreparedStatement st, Object value, int begin, SharedSessionContractImplementor session)
Bind a value represented by an instance of themapped class
to the JDBC prepared statement.Object
replace(Object original, Object target, SharedSessionContractImplementor 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, SharedSessionContractImplementor 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, SharedSessionContractImplementor session, Object owner)
Object
semiResolve(Object value, SharedSessionContractImplementor 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)
Inject property values onto the given component instanceint[]
sqlTypes(Mapping mapping)
Return the JDBC types codes (perTypes
) 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)
Generate a representation of the value for logging purposes.-
Methods inherited from class org.hibernate.type.AbstractType
beforeAssemble, getSemiResolvedType, isAnyType, isAssociationType, isCollectionType, isEntityType
-
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, getSemiResolvedType, isAnyType, isAssociationType, isCollectionType, isEntityType, resolve
-
-
-
-
Field Detail
-
propertySpan
protected final int propertySpan
-
entityMode
protected final EntityMode entityMode
-
componentTuplizer
protected final ComponentTuplizer componentTuplizer
-
-
Constructor Detail
-
ComponentType
@Deprecated public ComponentType(TypeFactory.TypeScope typeScope, ComponentMetamodel metamodel)
Deprecated.Use the other constructor
-
ComponentType
public ComponentType(ComponentMetamodel metamodel)
-
-
Method Detail
-
isKey
public boolean isKey()
-
getEntityMode
public EntityMode getEntityMode()
-
getComponentTuplizer
public ComponentTuplizer getComponentTuplizer()
-
getColumnSpan
public int getColumnSpan(Mapping mapping) throws MappingException
Description copied from interface:Type
How many columns are used to persist this type. Always the same assqlTypes(mapping).length
- Specified by:
getColumnSpan
in interfaceType
- Parameters:
mapping
- The mapping object :/- Returns:
- The number of columns
- Throws:
MappingException
- Generally indicates an issue accessing the passed mapping object.
-
sqlTypes
public int[] sqlTypes(Mapping mapping) throws MappingException
Description copied from interface:Type
Return the JDBC types codes (perTypes
) for the columns mapped by this type. NOTE: The number of elements in this array matches the return fromType.getColumnSpan(org.hibernate.engine.spi.Mapping)
.- Specified by:
sqlTypes
in interfaceType
- Parameters:
mapping
- The mapping object :/- Returns:
- The JDBC type codes.
- Throws:
MappingException
- Generally indicates an issue accessing the passed mapping object.
-
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 achar
/Character
would have a dictated length limit of 1; for a string-basedUUID
would have a size limit of 36; etc. NOTE: The number of elements in this array matches the return fromType.getColumnSpan(org.hibernate.engine.spi.Mapping)
.- Specified by:
dictatedSizes
in interfaceType
- 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 noType.dictatedSizes(org.hibernate.engine.spi.Mapping)
were given). NOTE: The number of elements in this array matches the return fromType.getColumnSpan(org.hibernate.engine.spi.Mapping)
.- Specified by:
defaultSizes
in interfaceType
- Parameters:
mapping
- The mapping object :/- Returns:
- The default sizes.
- Throws:
MappingException
- Generally indicates an issue accessing the passed mapping object.
-
isComponentType
public final boolean isComponentType()
Description copied from interface:Type
Return true if the implementation is castable toCompositeType
. Essentially a polymorphic version of(type instanceof CompositeType.class)
. A component type may own collections or associations and hence must provide certain extra functionality.- Specified by:
isComponentType
in interfaceType
- Overrides:
isComponentType
in classAbstractType
- Returns:
- True if this type is also a
CompositeType
implementor; false otherwise.
-
getReturnedClass
public Class getReturnedClass()
Description copied from interface:Type
The class returned byType.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 interfaceType
- Returns:
- The java type class handled by this type.
-
isSame
public boolean isSame(Object x, 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) taking a shortcut for entity references. For most types this should equate to anequals
check on the values. For associations the implication is a bit different. For most types it is conceivable to simply delegate toType.isEqual(java.lang.Object, java.lang.Object)
- Specified by:
isSame
in interfaceType
- Overrides:
isSame
in classAbstractType
- Parameters:
x
- The first valuey
- The second value- Returns:
- True if there are considered the same (see discussion above).
- Throws:
HibernateException
- A problem occurred performing the comparison
-
isEqual
public boolean isEqual(Object x, 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 interfaceType
- Overrides:
isEqual
in classAbstractType
- Parameters:
x
- The first valuey
- The second value- Returns:
- True if there are considered equal (see discussion above).
- Throws:
HibernateException
- A problem occurred performing the comparison
-
isEqual
public boolean isEqual(Object x, Object y, SessionFactoryImplementor factory) 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 interfaceType
- Overrides:
isEqual
in classAbstractType
- Parameters:
x
- The first valuey
- The second valuefactory
- The session factory- Returns:
- True if there are considered equal (see discussion above).
- Throws:
HibernateException
- A problem occurred performing the comparison
-
compare
public int compare(Object x, Object y)
Description copied from interface:Type
Perform aComparator
style comparison between values- Specified by:
compare
in interfaceType
- Overrides:
compare
in classAbstractType
- Parameters:
x
- The first valuey
- The second value- Returns:
- The comparison result. See
Comparator.compare(T, T)
for a discussion.
-
isMethodOf
public boolean isMethodOf(Method method)
Description copied from interface:CompositeType
Is the given method a member of this component's class?- Specified by:
isMethodOf
in interfaceCompositeType
- Parameters:
method
- The method to check- Returns:
- True if the method is a member; false otherwise.
-
getHashCode
public int getHashCode(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'shashCode
.- Specified by:
getHashCode
in interfaceType
- Overrides:
getHashCode
in classAbstractType
- Parameters:
x
- The value for which to retrieve a hash code- Returns:
- The hash code
-
getHashCode
public int getHashCode(Object x, SessionFactoryImplementor factory)
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'shashCode
.- Specified by:
getHashCode
in interfaceType
- Overrides:
getHashCode
in classAbstractType
- Parameters:
x
- The value for which to retrieve a hash codefactory
- The session factory- Returns:
- The hash code
-
isDirty
public boolean isDirty(Object x, Object y, 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 interfaceType
- Overrides:
isDirty
in classAbstractType
- Parameters:
x
- the old valuey
- the current valuesession
- The session from which the request originated.- Returns:
- true if the field is dirty
- Throws:
HibernateException
- A problem occurred performing the checking
-
isDirty
public boolean isDirty(Object x, Object y, 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 interfaceType
- Parameters:
x
- the old valuey
- the current valuecheckable
- An array of booleans indicating which columns making up the value are actually checkablesession
- The session from which the request originated.- Returns:
- true if the field is dirty
- Throws:
HibernateException
- A problem occurred performing the checking
-
isModified
public boolean isModified(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
Description copied from interface:Type
Has the value been modified compared to the current database state? The difference between this and theType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)
methods is that here we need to account for "partially" built values. This is really only an issue with association types. For most type implementations it is enough to simply delegate toType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)
here/- Specified by:
isModified
in interfaceType
- Overrides:
isModified
in classAbstractType
- Parameters:
old
- the database state, in a "hydrated" form, with identifiers unresolvedcurrent
- the current state of the objectcheckable
- which columns are actually checkablesession
- The session from which the request originated.- Returns:
- true if the field has been modified
- Throws:
HibernateException
- A problem occurred performing the checking
-
nullSafeGet
public Object nullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
Description copied from interface:Type
Extract a value of themapped class
from the JDBC result set. Implementors should handle possibility of null values.- Specified by:
nullSafeGet
in interfaceType
- 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 sessionowner
- the parent entity- Returns:
- The extracted value
- Throws:
HibernateException
- An error from HibernateSQLException
- An error from the JDBC driver- See Also:
alternative, 2-phase property initialization
-
nullSafeSet
public void nullSafeSet(PreparedStatement st, Object value, int begin, SharedSessionContractImplementor session) throws HibernateException, SQLException
Description copied from interface:Type
Bind a value represented by an instance of themapped 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 interfaceType
- Parameters:
st
- The JDBC prepared statement to which to bindvalue
- the object to writebegin
- starting parameter bind indexsession
- The originating session- Throws:
HibernateException
- An error from HibernateSQLException
- An error from the JDBC driver
-
nullSafeSet
public void nullSafeSet(PreparedStatement st, Object value, int begin, boolean[] settable, SharedSessionContractImplementor session) throws HibernateException, SQLException
Description copied from interface:Type
Bind a value represented by an instance of themapped 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 interfaceType
- Parameters:
st
- The JDBC prepared statement to which to bindvalue
- the object to writebegin
- starting parameter bind indexsettable
- an array indicating which columns to bind/ignoresession
- The originating session- Throws:
HibernateException
- An error from HibernateSQLException
- An error from the JDBC driver
-
nullSafeGet
public Object nullSafeGet(ResultSet rs, String name, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
Description copied from interface:Type
Extract a value of themapped 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 interfaceType
- Parameters:
rs
- The result set from which to extract value.name
- the column name making up this type value (use to read from result set)session
- The originating sessionowner
- the parent entity- Returns:
- The extracted value
- Throws:
HibernateException
- An error from HibernateSQLException
- An error from the JDBC driver
-
getPropertyValue
public Object getPropertyValue(Object component, int i, SharedSessionContractImplementor session) throws HibernateException
Description copied from interface:CompositeType
Extract a particular component property value indicated by index.- Specified by:
getPropertyValue
in interfaceCompositeType
- Parameters:
component
- The component instancei
- The index of the property whose value is to be extractedsession
- The session from which the request originates.- Returns:
- The extracted component property value
- Throws:
HibernateException
- Indicates a problem access the property value.
-
getPropertyValue
public Object getPropertyValue(Object component, int i, EntityMode entityMode) throws HibernateException
- Throws:
HibernateException
-
getPropertyValue
public Object getPropertyValue(Object component, int i) throws HibernateException
- Throws:
HibernateException
-
getPropertyValues
public Object[] getPropertyValues(Object component, SharedSessionContractImplementor session) throws HibernateException
Description copied from interface:CompositeType
Extract the values of the component properties from the given component instance- Specified by:
getPropertyValues
in interfaceCompositeType
- Parameters:
component
- The component instancesession
- The session from which the request originates- Returns:
- The property values
- Throws:
HibernateException
- Indicates a problem access the property values.
-
getPropertyValues
public Object[] getPropertyValues(Object component, EntityMode entityMode) throws HibernateException
Description copied from interface:CompositeType
Extract the values of the component properties from the given component instance without access to the session. An optional operation- Specified by:
getPropertyValues
in interfaceCompositeType
- Parameters:
component
- The component instanceentityMode
- The entity mode- Returns:
- The property values
- Throws:
HibernateException
- Indicates a problem access the property values.
-
setPropertyValues
public void setPropertyValues(Object component, Object[] values, EntityMode entityMode) throws HibernateException
Description copied from interface:CompositeType
Inject property values onto the given component instance An optional operation- Specified by:
setPropertyValues
in interfaceCompositeType
- Parameters:
component
- The component instancevalues
- The values to injectentityMode
- The entity mode- Throws:
HibernateException
- Indicates an issue performing the injection
-
getSubtypes
public Type[] getSubtypes()
Description copied from interface:CompositeType
Get the types of the component properties- Specified by:
getSubtypes
in interfaceCompositeType
- Returns:
- The component property types.
-
getPropertyValueGenerationStrategies
public ValueGeneration[] getPropertyValueGenerationStrategies()
-
getName
public String getName()
Description copied from interface:Type
Returns the abbreviated name of the type.
-
toLoggableString
public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
Description copied from interface:Type
Generate a representation of the value for logging purposes.- Specified by:
toLoggableString
in interfaceType
- Parameters:
value
- The value to be loggedfactory
- The session factory- Returns:
- The loggable representation
- Throws:
HibernateException
- An error from Hibernate
-
getPropertyNames
public String[] getPropertyNames()
Description copied from interface:CompositeType
Get the names of the component properties- Specified by:
getPropertyNames
in interfaceCompositeType
- Returns:
- The component property names
-
deepCopy
public Object deepCopy(Object component, 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 interfaceType
- Parameters:
component
- The value to be copiedfactory
- The session factory- Returns:
- The deep copy
- Throws:
HibernateException
- An error from Hibernate
-
replace
public Object replace(Object original, Object target, SharedSessionContractImplementor 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 interfaceType
- Parameters:
original
- the value from the detached entity being mergedtarget
- the value in the managed entitysession
- The originating sessionowner
- The owner of the valuecopyCache
- The cache of already copied/replaced values- Returns:
- the value to be merged
- Throws:
HibernateException
- An error from Hibernate
-
replace
public Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection) 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 interfaceType
- Overrides:
replace
in classAbstractType
- Parameters:
original
- the value from the detached entity being mergedtarget
- the value in the managed entitysession
- The originating sessionowner
- The owner of the valuecopyCache
- The cache of already copied/replaced valuesforeignKeyDirection
- For associations, which direction does the foreign key point?- Returns:
- the value to be merged
- Throws:
HibernateException
- An error from Hibernate
-
instantiate
public Object instantiate(EntityMode entityMode) throws HibernateException
This method does not populate the component parent- Throws:
HibernateException
-
instantiate
public Object instantiate(Object parent, SharedSessionContractImplementor session) throws HibernateException
- Throws:
HibernateException
-
getCascadeStyle
public CascadeStyle getCascadeStyle(int i)
Description copied from interface:CompositeType
Retrieve the cascade style of the indicated component property.- Specified by:
getCascadeStyle
in interfaceCompositeType
- Parameters:
i
- The property index,- Returns:
- The cascade style.
-
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.)
-
disassemble
public Serializable disassemble(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
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 interfaceType
- Overrides:
disassemble
in classAbstractType
- Parameters:
value
- the value to cachesession
- the originating sessionowner
- optional parent entity object (needed for collections)- Returns:
- the disassembled, deep cloned state
- Throws:
HibernateException
- An error from Hibernate
-
assemble
public Object assemble(Serializable object, SharedSessionContractImplementor session, Object owner) throws HibernateException
Description copied from interface:Type
Reconstruct the object from its disassembled state. This method is the reciprocal ofType.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
- Specified by:
assemble
in interfaceType
- Overrides:
assemble
in classAbstractType
- Parameters:
object
- the disassembled state from the cachesession
- the originating sessionowner
- the parent entity object- Returns:
- the (re)assembled object
- Throws:
HibernateException
- An error from Hibernate
-
getFetchMode
public FetchMode getFetchMode(int i)
Description copied from interface:CompositeType
Retrieve the fetch mode of the indicated component property.- Specified by:
getFetchMode
in interfaceCompositeType
- Parameters:
i
- The property index,- Returns:
- The fetch mode
-
hydrate
public Object hydrate(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
Description copied from interface:Type
Extract a value from the JDBC result set. This is useful for 2-phase property initialization - the second phase is a call toType.resolve(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
This hydrated value will be either:- in the case of an entity or collection type, the key
- otherwise, the value itself
- Specified by:
hydrate
in interfaceType
- Overrides:
hydrate
in classAbstractType
- Parameters:
rs
- The JDBC result setnames
- the column names making up this type value (use to read from result set)session
- The originating sessionowner
- the parent entity- Returns:
- An entity or collection key, or an actual value.
- Throws:
HibernateException
- An error from HibernateSQLException
- An error from the JDBC driver- See Also:
Type.resolve(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
-
resolve
public Object resolve(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
- Specified by:
resolve
in interfaceType
- Overrides:
resolve
in classAbstractType
- Throws:
HibernateException
- See Also:
Type.resolve(Object, SharedSessionContractImplementor, Object, Boolean)
-
semiResolve
public Object semiResolve(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
Description copied from interface:Type
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.- Specified by:
semiResolve
in interfaceType
- Overrides:
semiResolve
in classAbstractType
- Parameters:
value
- The unresolved, hydrated valuesession
- THe originating sessionowner
- The value owner- Returns:
- The semi-resolved value
- Throws:
HibernateException
- An error from Hibernate
-
getPropertyNullability
public boolean[] getPropertyNullability()
Description copied from interface:CompositeType
Retrieve the indicators regarding which component properties are nullable. An optional operation- Specified by:
getPropertyNullability
in interfaceCompositeType
- Returns:
- nullability of component properties
-
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 interfaceType
- Parameters:
value
- an instance of the typemapping
- The mapping abstraction- Returns:
- array indicating column nullness for a value instance
-
isEmbedded
public boolean isEmbedded()
Description copied from interface:CompositeType
Is this component embedded? "embedded" indicates that the component is "virtual", that its properties are "flattened" onto its owner- Specified by:
isEmbedded
in interfaceCompositeType
- Returns:
- True if this component is embedded; false otherwise.
-
getPropertyIndex
public int getPropertyIndex(String name)
Description copied from interface:CompositeType
Convenience method for locating the property index for a given property name.- Specified by:
getPropertyIndex
in interfaceCompositeType
- Parameters:
name
- The (sub-)property name to find.- Returns:
- The (sub-)property index, relative to all the array-valued method returns defined on this contract.
-
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 interfaceProcedureParameterExtractionAware
- Returns:
true
indicates that @{link #extract} calls will not fail due toIllegalStateException
.
-
extract
public Object extract(CallableStatement statement, int startIndex, SharedSessionContractImplementor session) throws SQLException
Description copied from interface:ProcedureParameterExtractionAware
Perform the extraction- Specified by:
extract
in interfaceProcedureParameterExtractionAware
- 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 contiguoussession
- The originating session- Returns:
- The extracted value.
- Throws:
SQLException
- Indicates an issue calling into the CallableStatement
-
extract
public Object extract(CallableStatement statement, String[] paramNames, SharedSessionContractImplementor session) throws SQLException
Description copied from interface:ProcedureParameterExtractionAware
Perform the extraction- Specified by:
extract
in interfaceProcedureParameterExtractionAware
- 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:
SQLException
- Indicates an issue calling into the CallableStatement
-
hasNotNullProperty
public boolean hasNotNullProperty()
Description copied from interface:CompositeType
Convenience method to quickly checkCompositeType.getPropertyNullability()
for any non-nullable sub-properties.- Specified by:
hasNotNullProperty
in interfaceCompositeType
- Returns:
true
if any of the properties are not-nullable as indicated byCompositeType.getPropertyNullability()
,false
otherwise.
-
-