public class CompositeCustomType extends AbstractType implements CompositeType, BasicType
Adapts CompositeUserType
to the Type
interface
Type | Property and Description |
---|---|
boolean |
hasNotNull
Convenience method to quickly check
CompositeType.getPropertyNullability() for any non-nullable sub-properties. |
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE
Constructor and Description |
---|
CompositeCustomType(CompositeUserType userType) |
CompositeCustomType(CompositeUserType userType,
String[] registrationKeys) |
Modifier and Type | Method and Description |
---|---|
Object |
assemble(Serializable cached,
SharedSessionContractImplementor session,
Object owner)
Reconstruct the object from its disassembled state.
|
Object |
deepCopy(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 no
Type.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.
|
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(Object x)
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 properties
|
boolean[] |
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[] |
getPropertyValues(Object component,
EntityMode entityMode)
Extract the values of the component properties from the given component instance without access to the
session.
|
Object[] |
getPropertyValues(Object component,
SharedSessionContractImplementor session)
Extract the values of the component properties from the given component instance
|
String[] |
getRegistrationKeys()
Get the names under which this type should be registered in the type registry.
|
Class |
getReturnedClass()
|
Type[] |
getSubtypes()
Get the types of the component properties
|
CompositeUserType |
getUserType() |
boolean |
hasNotNullProperty()
Convenience method to quickly check
CompositeType.getPropertyNullability() for any non-nullable sub-properties. |
boolean |
isComponentType()
Return true if the implementation is castable to
CompositeType . |
boolean |
isDirty(Object old,
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 owner
|
boolean |
isEqual(Object x,
Object y)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent
state).
|
boolean |
isMethodOf(Method method)
Is the given method a member of this component’s class?
|
boolean |
isMutable()
Are objects of this type mutable.
|
Object |
nullSafeGet(ResultSet rs,
String[] names,
SharedSessionContractImplementor session,
Object owner)
Extract a value of the
mapped class from the JDBC result set. |
Object |
nullSafeGet(ResultSet rs,
String columnName,
SharedSessionContractImplementor session,
Object owner)
Extract a value of the
mapped class from the JDBC result set. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
boolean[] settable,
SharedSessionContractImplementor session)
Bind a value represented by an instance of the
mapped class to the JDBC prepared
statement, ignoring some columns as dictated by the 'settable' parameter. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int index,
SharedSessionContractImplementor session)
Bind a value represented by an instance of the
mapped 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.
|
void |
setPropertyValues(Object component,
Object[] values,
EntityMode entityMode)
Inject property values onto the given component instance
<p/>
An optional operation
|
int[] |
sqlTypes(Mapping mapping)
Return the JDBC types codes (per
Types ) 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.
|
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, semiResolve
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
beforeAssemble, compare, getHashCode, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isDirty, isEntityType, isEqual, isModified, isSame, replace, resolve, semiResolve
public boolean hasNotNullProperty
hasNotNullProperty
in interface CompositeType
true
if any of the properties are not-nullable as indicated by CompositeType.getPropertyNullability()
,
false
otherwise.public CompositeCustomType(CompositeUserType userType)
public CompositeCustomType(CompositeUserType userType, String[] registrationKeys)
public String getName()
Type
Returns the abbreviated name of the type.
public Class getReturnedClass()
Type
The class returned by Type.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.
getReturnedClass
in interface Type
public boolean isMutable()
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.)
public String[] getRegistrationKeys()
BasicType
Get the names under which this type should be registered in the type registry.
getRegistrationKeys
in interface BasicType
public CompositeUserType getUserType()
public boolean isMethodOf(Method method)
CompositeType
Is the given method a member of this component’s class?
isMethodOf
in interface CompositeType
method
- The method to checkpublic Type[] getSubtypes()
CompositeType
Get the types of the component properties
getSubtypes
in interface CompositeType
public String[] getPropertyNames()
CompositeType
Get the names of the component properties
getPropertyNames
in interface CompositeType
public int getPropertyIndex(String name)
CompositeType
Convenience method for locating the property index for a given property name.
getPropertyIndex
in interface CompositeType
name
- The (sub-)property name to find.public Object[] getPropertyValues(Object component, SharedSessionContractImplementor session) throws HibernateException
CompositeType
Extract the values of the component properties from the given component instance
getPropertyValues
in interface CompositeType
component
- The component instancesession
- The session from which the request originatesHibernateException
- Indicates a problem access the property values.public Object[] getPropertyValues(Object component, EntityMode entityMode) throws HibernateException
CompositeType
Extract the values of the component properties from the given component instance without access to the session. <p/> An optional operation
getPropertyValues
in interface CompositeType
component
- The component instanceentityMode
- The entity modeHibernateException
- Indicates a problem access the property values.public void setPropertyValues(Object component, Object[] values, EntityMode entityMode) throws HibernateException
CompositeType
Inject property values onto the given component instance <p/> An optional operation
setPropertyValues
in interface CompositeType
component
- The component instancevalues
- The values to injectentityMode
- The entity modeHibernateException
- Indicates an issue performing the injectionpublic Object getPropertyValue(Object component, int i, SharedSessionContractImplementor session) throws HibernateException
CompositeType
Extract a particular component property value indicated by index.
getPropertyValue
in interface CompositeType
component
- The component instancei
- The index of the property whose value is to be extractedsession
- The session from which the request originates.HibernateException
- Indicates a problem access the property value.public Object getPropertyValue(Object component, int i) throws HibernateException
HibernateException
public CascadeStyle getCascadeStyle(int i)
CompositeType
Retrieve the cascade style of the indicated component property.
getCascadeStyle
in interface CompositeType
i
- The property index,public FetchMode getFetchMode(int i)
CompositeType
Retrieve the fetch mode of the indicated component property.
getFetchMode
in interface CompositeType
i
- The property index,public boolean isComponentType()
Type
Return true if the implementation is castable to CompositeType
. Essentially a polymorphic
version of (type instanceof CompositeType.class)
. A component type may own collections or
associations and hence must provide certain extra functionality.
isComponentType
in interface Type
isComponentType
in class AbstractType
CompositeType
implementor; false otherwise.public Object deepCopy(Object value, SessionFactoryImplementor factory) throws HibernateException
Type
Return a deep copy of the persistent state, stopping at entities and at collections.
deepCopy
in interface Type
value
- The value to be copiedfactory
- The session factoryHibernateException
- An error from Hibernatepublic Object assemble(Serializable cached, SharedSessionContractImplementor session, Object owner) throws HibernateException
Type
Reconstruct the object from its disassembled state. This method is the reciprocal of Type.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
assemble
in interface Type
assemble
in class AbstractType
cached
- the disassembled state from the cachesession
- the originating sessionowner
- the parent entity objectHibernateException
- An error from Hibernatepublic Serializable disassemble(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
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.
disassemble
in interface Type
disassemble
in class AbstractType
value
- the value to cachesession
- the originating sessionowner
- optional parent entity object (needed for collections)HibernateException
- An error from Hibernatepublic Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map copyCache) throws HibernateException
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.
replace
in interface Type
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 valuesHibernateException
- An error from Hibernatepublic boolean isEqual(Object x, Object y) throws HibernateException
Type
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). <p/> 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).
isEqual
in interface Type
isEqual
in class AbstractType
x
- The first valuey
- The second valueHibernateException
- A problem occurred performing the comparisonpublic int getHashCode(Object x)
Type
Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to
delegate to the value’s hashCode
.
getHashCode
in interface Type
getHashCode
in class AbstractType
x
- The value for which to retrieve a hash codepublic int getColumnSpan(Mapping mapping) throws MappingException
Type
How many columns are used to persist this type. Always the same as sqlTypes(mapping).length
getColumnSpan
in interface Type
mapping
- The mapping object :/MappingException
- Generally indicates an issue accessing the passed mapping object.public Object nullSafeGet(ResultSet rs, String columnName, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
Type
Extract a value of the mapped 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.
nullSafeGet
in interface Type
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 entityHibernateException
- An error from HibernateSQLException
- An error from the JDBC driverpublic Object nullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
Type
Extract a value of the mapped class
from the JDBC result set. Implementors
should handle possibility of null values.
nullSafeGet
in interface Type
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 entityHibernateException
- An error from HibernateSQLException
- An error from the JDBC driveralternative, 2-phase property initialization
public void nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session) throws HibernateException, SQLException
Type
Bind a value represented by an instance of the mapped class
to the JDBC prepared
statement. Implementors should handle possibility of null values. A multi-column type should bind parameters
starting from <tt>index</tt>.
nullSafeSet
in interface Type
st
- The JDBC prepared statement to which to bindvalue
- the object to writeindex
- starting parameter bind indexsession
- The originating sessionHibernateException
- An error from HibernateSQLException
- An error from the JDBC driverpublic void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session) throws HibernateException, SQLException
Type
Bind a value represented by an instance of the mapped 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 <tt>index</tt>.
nullSafeSet
in interface Type
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 sessionHibernateException
- An error from HibernateSQLException
- An error from the JDBC driverpublic int[] sqlTypes(Mapping mapping) throws MappingException
Type
Return the JDBC types codes (per Types
) for the columns mapped by this type.
<p/>
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping)
.
sqlTypes
in interface Type
mapping
- The mapping object :/MappingException
- Generally indicates an issue accessing the passed mapping object.public Size[] dictatedSizes(Mapping mapping) throws MappingException
Type
Return the column sizes dictated by this type. For example, the mapping for a char
/Character
would
have a dictated length limit of 1; for a string-based UUID
would have a size limit of 36; etc.
<p/>
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping)
.
dictatedSizes
in interface Type
mapping
- The mapping object :/MappingException
- Generally indicates an issue accessing the passed mapping object.public Size[] defaultSizes(Mapping mapping) throws MappingException
Type
Defines the column sizes to use according to this type if the user did not explicitly say (and if no
Type.dictatedSizes(org.hibernate.engine.spi.Mapping)
were given).
<p/>
NOTE: The number of elements in this array matches the return from Type.getColumnSpan(org.hibernate.engine.spi.Mapping)
.
defaultSizes
in interface Type
mapping
- The mapping object :/MappingException
- Generally indicates an issue accessing the passed mapping object.public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
Type
Generate a representation of the value for logging purposes.
toLoggableString
in interface Type
value
- The value to be loggedfactory
- The session factoryHibernateException
- An error from Hibernatepublic boolean[] getPropertyNullability()
CompositeType
Retrieve the indicators regarding which component properties are nullable. <p/> An optional operation
getPropertyNullability
in interface CompositeType
public boolean[] toColumnNullness(Object value, Mapping mapping)
Type
Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.
toColumnNullness
in interface Type
value
- an instance of the typemapping
- The mapping abstractionpublic boolean isDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
Type
Should the parent be considered dirty, given both the old and current value?
isDirty
in interface Type
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.HibernateException
- A problem occurred performing the checkingpublic boolean isEmbedded()
CompositeType
Is this component embedded? "embedded" indicates that the component is "virtual", that its properties are "flattened" onto its owner
isEmbedded
in interface CompositeType
public boolean hasNotNullProperty()
CompositeType
Convenience method to quickly check CompositeType.getPropertyNullability()
for any non-nullable sub-properties.
hasNotNullProperty
in interface CompositeType
true
if any of the properties are not-nullable as indicated by CompositeType.getPropertyNullability()
,
false
otherwise.Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.