Package org.hibernate.type
Class CompositeCustomType
- java.lang.Object
-
- org.hibernate.type.AbstractType
-
- org.hibernate.type.CompositeCustomType
-
- All Implemented Interfaces:
java.io.Serializable
,BasicType
,CompositeType
,Type
public class CompositeCustomType extends AbstractType implements CompositeType, BasicType
AdaptsCompositeUserType
to theType
interface- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.hibernate.type.AbstractType
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE
-
-
Constructor Summary
Constructors Constructor Description CompositeCustomType(CompositeUserType userType)
CompositeCustomType(CompositeUserType userType, java.lang.String[] registrationKeys)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
assemble(java.io.Serializable cached, SharedSessionContractImplementor session, java.lang.Object owner)
Reconstruct the object from its disassembled state.java.lang.Object
deepCopy(java.lang.Object value, 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.java.io.Serializable
disassemble(java.lang.Object value, SharedSessionContractImplementor session, java.lang.Object owner)
Return a disassembled representation of the object.CascadeStyle
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.FetchMode
getFetchMode(int i)
Retrieve the fetch mode of the indicated component property.int
getHashCode(java.lang.Object x)
Get a hash code, consistent with persistence "equality".java.lang.String
getName()
Returns the abbreviated name of the type.int
getPropertyIndex(java.lang.String name)
Convenience method for locating the property index for a given property name.java.lang.String[]
getPropertyNames()
Get the names of the component propertiesboolean[]
getPropertyNullability()
Retrieve the indicators regarding which component properties are nullable.java.lang.Object
getPropertyValue(java.lang.Object component, int i)
java.lang.Object
getPropertyValue(java.lang.Object component, int i, SharedSessionContractImplementor session)
Extract a particular component property value indicated by index.java.lang.Object[]
getPropertyValues(java.lang.Object component, SharedSessionContractImplementor session)
Extract the values of the component properties from the given component instancejava.lang.Object[]
getPropertyValues(java.lang.Object component, EntityMode entityMode)
Extract the values of the component properties from the given component instance without access to the session.java.lang.String[]
getRegistrationKeys()
Get the names under which this type should be registered in the type registry.java.lang.Class
getReturnedClass()
Type[]
getSubtypes()
Get the types of the component propertiesCompositeUserType
getUserType()
boolean
hasNotNullProperty()
Convenience method to quickly checkCompositeType.getPropertyNullability()
for any non-nullable sub-properties.boolean
isComponentType()
Return true if the implementation is castable toCompositeType
.boolean
isDirty(java.lang.Object old, java.lang.Object current, boolean[] checkable, 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(java.lang.Object x, java.lang.Object y)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).boolean
isMethodOf(java.lang.reflect.Method method)
Is the given method a member of this component's class?boolean
isMutable()
Are objects of this type mutable.java.lang.Object
nullSafeGet(java.sql.ResultSet rs, java.lang.String[] names, SharedSessionContractImplementor session, java.lang.Object owner)
Extract a value of themapped class
from the JDBC result set.java.lang.Object
nullSafeGet(java.sql.ResultSet rs, java.lang.String columnName, SharedSessionContractImplementor session, java.lang.Object owner)
Extract a value of themapped class
from the JDBC result set.void
nullSafeSet(java.sql.PreparedStatement st, java.lang.Object value, int index, 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(java.sql.PreparedStatement st, java.lang.Object value, int index, SharedSessionContractImplementor session)
Bind a value represented by an instance of themapped class
to the JDBC prepared statement.java.lang.Object
replace(java.lang.Object original, java.lang.Object target, SharedSessionContractImplementor session, java.lang.Object owner, java.util.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(java.lang.Object component, java.lang.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(java.lang.Object value, Mapping mapping)
Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.java.lang.String
toLoggableString(java.lang.Object value, SessionFactoryImplementor factory)
Generate a representation of the value for logging purposes.-
Methods inherited from class org.hibernate.type.AbstractType
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isDirty, isEntityType, isEqual, isModified, isSame, replace, 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, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, resolve, semiResolve
-
-
-
-
Constructor Detail
-
CompositeCustomType
public CompositeCustomType(CompositeUserType userType)
-
CompositeCustomType
public CompositeCustomType(CompositeUserType userType, java.lang.String[] registrationKeys)
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:Type
Returns the abbreviated name of the type.
-
getReturnedClass
public java.lang.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.
-
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.)
-
getRegistrationKeys
public java.lang.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 interfaceBasicType
- Returns:
- The keys under which to register this type.
-
getUserType
public CompositeUserType getUserType()
-
isMethodOf
public boolean isMethodOf(java.lang.reflect.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.
-
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.
-
getPropertyNames
public java.lang.String[] getPropertyNames()
Description copied from interface:CompositeType
Get the names of the component properties- Specified by:
getPropertyNames
in interfaceCompositeType
- Returns:
- The component property names
-
getPropertyIndex
public int getPropertyIndex(java.lang.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.
-
getPropertyValues
public java.lang.Object[] getPropertyValues(java.lang.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 java.lang.Object[] getPropertyValues(java.lang.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(java.lang.Object component, java.lang.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
-
getPropertyValue
public java.lang.Object getPropertyValue(java.lang.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 java.lang.Object getPropertyValue(java.lang.Object component, int i) 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.
-
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
-
isComponentType
public 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.
-
deepCopy
public java.lang.Object deepCopy(java.lang.Object value, 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:
value
- The value to be copiedfactory
- The session factory- Returns:
- The deep copy
- Throws:
HibernateException
- An error from Hibernate
-
assemble
public java.lang.Object assemble(java.io.Serializable cached, SharedSessionContractImplementor session, java.lang.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:
cached
- the disassembled state from the cachesession
- the originating sessionowner
- the parent entity object- Returns:
- the (re)assembled object
- Throws:
HibernateException
- An error from Hibernate
-
disassemble
public java.io.Serializable disassemble(java.lang.Object value, SharedSessionContractImplementor session, java.lang.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
-
replace
public java.lang.Object replace(java.lang.Object original, java.lang.Object target, SharedSessionContractImplementor session, java.lang.Object owner, java.util.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
-
isEqual
public boolean isEqual(java.lang.Object x, java.lang.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
-
getHashCode
public int getHashCode(java.lang.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
-
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.
-
nullSafeGet
public java.lang.Object nullSafeGet(java.sql.ResultSet rs, java.lang.String columnName, SharedSessionContractImplementor session, java.lang.Object owner) throws HibernateException, java.sql.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.columnName
- 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 Hibernatejava.sql.SQLException
- An error from the JDBC driver
-
nullSafeGet
public java.lang.Object nullSafeGet(java.sql.ResultSet rs, java.lang.String[] names, SharedSessionContractImplementor session, java.lang.Object owner) throws HibernateException, java.sql.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 Hibernatejava.sql.SQLException
- An error from the JDBC driver- See Also:
alternative, 2-phase property initialization
-
nullSafeSet
public void nullSafeSet(java.sql.PreparedStatement st, java.lang.Object value, int index, SharedSessionContractImplementor session) throws HibernateException, java.sql.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 writeindex
- starting parameter bind indexsession
- The originating session- Throws:
HibernateException
- An error from Hibernatejava.sql.SQLException
- An error from the JDBC driver
-
nullSafeSet
public void nullSafeSet(java.sql.PreparedStatement st, java.lang.Object value, int index, boolean[] settable, SharedSessionContractImplementor session) throws HibernateException, java.sql.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 writeindex
- starting parameter bind indexsettable
- an array indicating which columns to bind/ignoresession
- The originating session- Throws:
HibernateException
- An error from Hibernatejava.sql.SQLException
- An error from the JDBC driver
-
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.
-
toLoggableString
public java.lang.String toLoggableString(java.lang.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
-
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(java.lang.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
-
isDirty
public boolean isDirty(java.lang.Object old, java.lang.Object current, 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:
old
- the old valuecurrent
- 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
-
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.
-
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.
-
-