org.hibernate.type

Class CompositeCustomType

java.lang.Object

org.hibernate.type.AbstractType

org.hibernate.type.CompositeCustomType

All Implemented Interfaces:

Serializable, BasicType, CompositeType, Type

public class CompositeCustomType
extends AbstractType
implements CompositeType, BasicType

Adapts CompositeUserType to the Type interface

See Also:

Serialized Form

Property Summary

Type	Property and Description
boolean	hasNotNull Convenience method to quickly check CompositeType.getPropertyNullability() for any non-nullable sub-properties.

Field Summary

Fields inherited from class org.hibernate.type.AbstractType

LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE

Constructor Summary

Constructors

Constructor and Description
CompositeCustomType(CompositeUserType userType)
CompositeCustomType(CompositeUserType userType, String[] registrationKeys)

Method Summary

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() The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object) methods.
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.

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

Property Detail

hasNotNull

public boolean hasNotNullProperty

Specified by:

hasNotNullProperty in interface CompositeType

Returns:

true if any of the properties are not-nullable as indicated by CompositeType.getPropertyNullability(), false otherwise.

Constructor Detail

CompositeCustomType

public CompositeCustomType(CompositeUserType userType)

CompositeCustomType

public CompositeCustomType(CompositeUserType userType,
                           String[] registrationKeys)

Method Detail

getName

public String getName()

Description copied from interface: Type

Returns the abbreviated name of the type.

Specified by:

getName in interface Type

Returns:

String the Hibernate type name

getReturnedClass

public Class getReturnedClass()

Description copied from interface: 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.

Specified by:

getReturnedClass in interface Type

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

Specified by:

isMutable in interface Type

Returns:

boolean

getRegistrationKeys

public 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 interface BasicType

Returns:

The keys under which to register this type.

getUserType

public CompositeUserType getUserType()

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

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

Returns:

The component property types.

getPropertyNames

public String[] getPropertyNames()

Description copied from interface: CompositeType

Get the names of the component properties

Specified by:

getPropertyNames in interface CompositeType

Returns:

The component property names

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

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

Parameters:

component - The component instance

session - 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. <p/> An optional operation

Specified by:

getPropertyValues in interface CompositeType

Parameters:

component - The component instance

entityMode - 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 <p/> An optional operation

Specified by:

setPropertyValues in interface CompositeType

Parameters:

component - The component instance

values - The values to inject

entityMode - The entity mode

Throws:

HibernateException - Indicates an issue performing the injection

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

Parameters:

component - The component instance

i - The index of the property whose value is to be extracted

session - 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)
                        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 interface CompositeType

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

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

Specified by:

isComponentType in interface Type

Overrides:

isComponentType in class AbstractType

Returns:

True if this type is also a CompositeType implementor; false otherwise.

deepCopy

public Object deepCopy(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 interface Type

Parameters:

value - The value to be copied

factory - The session factory

Returns:

The deep copy

Throws:

HibernateException - An error from Hibernate

assemble

public Object assemble(Serializable cached,
                       SharedSessionContractImplementor session,
                       Object owner)
                throws HibernateException

Description copied from interface: 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)

Specified by:

assemble in interface Type

Overrides:

assemble in class AbstractType

Parameters:

cached - the disassembled state from the cache

session - the originating session

owner - the parent entity object

Returns:

the (re)assembled object

Throws:

HibernateException - An error from Hibernate

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

Overrides:

disassemble in class AbstractType

Parameters:

value - the value to cache

session - the originating session

owner - optional parent entity object (needed for collections)

Returns:

the disassembled, deep cloned state

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

Parameters:

original - the value from the detached entity being merged

target - the value in the managed entity

session - The originating session

owner - The owner of the value

copyCache - The cache of already copied/replaced values

Returns:

the value to be merged

Throws:

HibernateException - An error from Hibernate

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

Specified by:

isEqual in interface Type

Overrides:

isEqual in class AbstractType

Parameters:

x - The first value

y - 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(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’s hashCode.

Specified by:

getHashCode in interface Type

Overrides:

getHashCode in class AbstractType

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 as sqlTypes(mapping).length

Specified by:

getColumnSpan in interface Type

Parameters:

mapping - The mapping object :/

Returns:

The number of columns

Throws:

MappingException - Generally indicates an issue accessing the passed mapping object.

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String columnName,
                          SharedSessionContractImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException

Description copied from interface: 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.

Specified by:

nullSafeGet in interface Type

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 session

owner - the parent entity

Returns:

The extracted value

Throws:

HibernateException - An error from Hibernate

SQLException - An error from the JDBC driver

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String[] names,
                          SharedSessionContractImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException

Description copied from interface: Type

Extract a value of the mapped class from the JDBC result set. Implementors should handle possibility of null values.

Specified by:

nullSafeGet in interface Type

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 session

owner - the parent entity

Returns:

The extracted value

Throws:

HibernateException - An error from Hibernate

SQLException - An error from the JDBC driver

See Also:

alternative, 2-phase property initialization

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        SharedSessionContractImplementor session)
                 throws HibernateException,
                        SQLException

Description copied from interface: 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>.

Specified by:

nullSafeSet in interface Type

Parameters:

st - The JDBC prepared statement to which to bind

value - the object to write

index - starting parameter bind index

session - The originating session

Throws:

HibernateException - An error from Hibernate

SQLException - An error from the JDBC driver

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        boolean[] settable,
                        SharedSessionContractImplementor session)
                 throws HibernateException,
                        SQLException

Description copied from interface: 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>.

Specified by:

nullSafeSet in interface Type

Parameters:

st - The JDBC prepared statement to which to bind

value - the object to write

index - starting parameter bind index

settable - an array indicating which columns to bind/ignore

session - The originating session

Throws:

HibernateException - An error from Hibernate

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 (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).

Specified by:

sqlTypes in interface Type

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

Specified by:

dictatedSizes in interface Type

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

Specified by:

defaultSizes in interface Type

Parameters:

mapping - The mapping object :/

Returns:

The default sizes.

Throws:

MappingException - Generally indicates an issue accessing the passed mapping object.

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

Parameters:

value - The value to be logged

factory - 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. <p/> An optional operation

Specified by:

getPropertyNullability in interface CompositeType

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

Parameters:

value - an instance of the type

mapping - The mapping abstraction

Returns:

array indicating column nullness for a value instance

isDirty

public boolean isDirty(Object old,
                       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 interface Type

Parameters:

old - the old value

current - the current value

checkable - An array of booleans indicating which columns making up the value are actually checkable

session - 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 interface CompositeType

Returns:

True if this component is embedded; false otherwise.

hasNotNullProperty

public boolean hasNotNullProperty()

Description copied from interface: CompositeType

Convenience method to quickly check CompositeType.getPropertyNullability() for any non-nullable sub-properties.

Specified by:

hasNotNullProperty in interface CompositeType

Returns:

true if any of the properties are not-nullable as indicated by CompositeType.getPropertyNullability(), false otherwise.