public class

ComponentType

extends AbstractType
implements CompositeType
java.lang.Object
   ↳ org.hibernate.type.AbstractType
     ↳ org.hibernate.type.ComponentType
Known Direct Subclasses

Class Overview

Handles "component" mappings

Summary

Fields
protected final int propertySpan
protected final EntityModeToTuplizerMapping tuplizerMapping
Public Constructors
ComponentType(TypeFactory.TypeScope typeScope, ComponentMetamodel metamodel)
Public Methods
Object assemble(Serializable object, SessionImplementor session, Object owner)
Reconstruct the object from its cached "disassembled" state.
int compare(Object x, Object y, EntityMode entityMode)
Perform a Comparator style comparison between values
Object deepCopy(Object component, EntityMode entityMode, SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections.
Serializable disassemble(Object value, SessionImplementor session, Object owner)
Return a cacheable "disassembled" representation of the object.
Object fromXMLNode(Node xml, Mapping factory)
Parse the XML representation of an instance.
CascadeStyle getCascadeStyle(int i)
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, EntityMode entityMode)
Get a hash code, consistent with persistence "equality".
int getHashCode(Object x, EntityMode entityMode, SessionFactoryImplementor factory)
Get a hash code, consistent with persistence "equality".
String getName()
Returns the abbreviated name of the type.
int getPropertyIndex(String 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, EntityMode entityMode)
Object getPropertyValue(Object component, int i, SessionImplementor session)
Extract a particular component property value indicated by index.
Object[] getPropertyValues(Object component, SessionImplementor session)
Extract the values of the component properties from the given component instance
Object[] 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 properties
EntityModeToTuplizerMapping getTuplizerMapping()
Object hydrate(ResultSet rs, String[] names, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset.
Object instantiate(Object parent, SessionImplementor session)
Object instantiate(EntityMode entityMode)
This method does not populate the component parent
final boolean isComponentType()
Return true if the implementation is castable to CompositeType.
boolean isDirty(Object x, Object y, boolean[] checkable, SessionImplementor session)
Should the parent be considered dirty, given both the old and current value?
boolean isDirty(Object x, Object y, SessionImplementor 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, EntityMode entityMode)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).
boolean isEqual(Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).
boolean isKey()
boolean isMethodOf(Method method)
Is the given method a member of this component's class?
boolean isModified(Object old, Object current, boolean[] checkable, SessionImplementor session)
Has the value been modified compared to the current database state? The difference between this and the isDirty(Object, Object, boolean[], SessionImplementor) 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, EntityMode entityMode)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references.
boolean isXMLElement()
Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class from a JDBC resultset.
Object nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner)
Retrieve an instance of the mapped class from a JDBC resultset.
void nullSafeSet(PreparedStatement st, Object value, int begin, SessionImplementor session)
Write an instance of the mapped class to a prepared statement.
void nullSafeSet(PreparedStatement st, Object value, int begin, boolean[] settable, SessionImplementor session)
Write an instance of the mapped class to a prepared statement, ignoring some columns.
Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache)
During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging.
Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection)
During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging.
Object resolve(Object value, SessionImplementor session, Object owner)
Map identifiers to entities or collections.
Object semiResolve(Object value, SessionImplementor session, Object owner)
Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.
void setPropertyValues(Object component, Object[] values, EntityMode entityMode)
Inject property values onto the given component instance

An optional operation

void setToXMLNode(Node node, Object value, SessionFactoryImplementor factory)
A representation of the value to be embedded in an XML element.
int[] sqlTypes(Mapping mapping)
Return the JDBC types codes (per java.sql.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)
A representation of the value to be embedded in a log file.
[Expand]
Inherited Methods
From class org.hibernate.type.AbstractType
From class java.lang.Object
From interface org.hibernate.type.CompositeType
From interface org.hibernate.type.Type

Fields

protected final int propertySpan

protected final EntityModeToTuplizerMapping tuplizerMapping

Public Constructors

public ComponentType (TypeFactory.TypeScope typeScope, ComponentMetamodel metamodel)

Public Methods

public Object assemble (Serializable object, SessionImplementor session, Object owner)

Reconstruct the object from its cached "disassembled" state.

Parameters
object the disassembled state from the cache
session the session
owner the parent entity object
Returns
  • the the object

public int compare (Object x, Object y, EntityMode entityMode)

Perform a Comparator style comparison between values

Parameters
x The first value
y The second value
entityMode The entity mode of the values.
Returns

public Object deepCopy (Object component, EntityMode entityMode, SessionFactoryImplementor factory)

Return a deep copy of the persistent state, stopping at entities and at collections.

Parameters
component generally a collection element or entity field
Returns
  • Object a copy

public Serializable disassemble (Object value, SessionImplementor session, Object owner)

Return a cacheable "disassembled" representation of the object.

Parameters
value the value to cache
session the session
owner optional parent entity object (needed for collections)
Returns
  • the disassembled, deep cloned state

public Object fromXMLNode (Node xml, Mapping factory)

Parse the XML representation of an instance.

Returns
  • an instance of the type

public CascadeStyle getCascadeStyle (int i)

Retrieve the cascade style of the indicated component property.

Parameters
i The property index,
Returns
  • The cascade style.

public int getColumnSpan (Mapping mapping)

How many columns are used to persist this type. Always the same as sqlTypes(mapping).length

Parameters
mapping The mapping object :/
Returns
  • The number of columns

public FetchMode getFetchMode (int i)

Retrieve the fetch mode of the indicated component property.

Parameters
i The property index,
Returns
  • The fetch mode

public int getHashCode (Object x, EntityMode entityMode)

Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's #hashCode.

Parameters
x The value for which to retrieve a hash code
entityMode The entity mode of the value.
Returns
  • The hash code

public int getHashCode (Object x, EntityMode entityMode, SessionFactoryImplementor factory)

Get a hash code, consistent with persistence "equality". Again for most types the normal usage is to delegate to the value's #hashCode.

Parameters
x The value for which to retrieve a hash code
entityMode The entity mode of the value.
factory The session factory
Returns
  • The hash code

public String getName ()

Returns the abbreviated name of the type.

Returns
  • String the Hibernate type name

public int getPropertyIndex (String name)

public String[] getPropertyNames ()

Get the names of the component properties

Returns
  • The component property names

public boolean[] getPropertyNullability ()

Retrieve the indicators regarding which component properties are nullable.

An optional operation

Returns
  • nullability of component properties

public Object getPropertyValue (Object component, int i, EntityMode entityMode)

public Object getPropertyValue (Object component, int i, SessionImplementor session)

Extract a particular component property value indicated by index.

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

public Object[] getPropertyValues (Object component, SessionImplementor session)

Extract the values of the component properties from the given component instance

Parameters
component The component instance
session The session from which the request originates
Returns
  • The property values

public Object[] getPropertyValues (Object component, EntityMode entityMode)

Extract the values of the component properties from the given component instance without access to the session.

An optional operation

Parameters
component The component instance
entityMode The entity mode
Returns
  • The property values

public Class getReturnedClass ()

The class returned by nullSafeGet(ResultSet, String, SessionImplementor, Object) methods. This is used to establish the class of an array of this type.

Returns
  • The java type class handled by this type.

public Type[] getSubtypes ()

Get the types of the component properties

Returns
  • The component property types.

public EntityModeToTuplizerMapping getTuplizerMapping ()

public Object hydrate (ResultSet rs, String[] names, SessionImplementor session, Object owner)

Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. This is useful for 2-phase property initialization - the second phase is a call to resolveIdentifier().

Parameters
names the column names
session the session
owner the parent entity
Returns
  • Object an identifier or actual value

public Object instantiate (Object parent, SessionImplementor session)

public Object instantiate (EntityMode entityMode)

This method does not populate the component parent

public final boolean isComponentType ()

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.

Returns
  • True if this type is also an CompositeType implementor; false otherwise.

public boolean isDirty (Object x, Object y, boolean[] checkable, SessionImplementor session)

Should the parent be considered dirty, given both the old and current value?

Parameters
x the old value
y 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

public boolean isDirty (Object x, Object y, SessionImplementor session)

Should the parent be considered dirty, given both the old and current value?

Parameters
x the old value
y the current value
session The session from which the request originated.
Returns
  • true if the field is dirty

public boolean isEmbedded ()

Is this component embedded? "embedded" indicates that the component is "virtual", that its properties are "flattened" onto its owner

Returns
  • True if this component is embedded; false otherwise.

public boolean isEqual (Object x, Object y, EntityMode entityMode)

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).

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

Parameters
x The first value
y The second value
entityMode The entity mode of the values.
Returns
  • True if there are considered equal (see discussion above).

public boolean isEqual (Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory)

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state).

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

Parameters
x The first value
y The second value
entityMode The entity mode of the values.
factory The session factory
Returns
  • True if there are considered equal (see discussion above).

public boolean isKey ()

public boolean isMethodOf (Method method)

Is the given method a member of this component's class?

Parameters
method The method to check
Returns
  • True if the method is a member; false otherwise.

public boolean isModified (Object old, Object current, boolean[] checkable, SessionImplementor session)

Has the value been modified compared to the current database state? The difference between this and the isDirty(Object, Object, boolean[], SessionImplementor) 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 to isDirty(Object, Object, boolean[], SessionImplementor) here/

Parameters
old the database state, in a "hydrated" form, with identifiers unresolved
current the current state of the object
checkable which columns are actually updatable
session The session from which the request originated.
Returns
  • true if the field has been modified

public boolean isMutable ()

Are objects of this type mutable. (With respect to the referencing object ... entities and collections are considered immutable because they manage their own internal state.)

Returns
  • boolean

public boolean isSame (Object x, Object y, EntityMode entityMode)

Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references.

For most types this should equate to #equals check on the values. For associations the implication is a bit different. For most types it is conceivable to simply delegate to isEqual(Object, Object, EntityMode)

Parameters
x The first value
y The second value
entityMode The entity mode of the values.
Returns
  • True if there are considered the same (see discussion above).

public boolean isXMLElement ()

public Object nullSafeGet (ResultSet rs, String[] names, SessionImplementor session, Object owner)

Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.

Parameters
names the column names
owner the parent entity
Returns
  • Object

public Object nullSafeGet (ResultSet rs, String name, SessionImplementor session, Object owner)

Retrieve an instance of the mapped class from a JDBC resultset. Implementations should handle possibility of null values. This method might be called if the type is known to be a single-column type.

Parameters
name the column name
owner the parent entity
Returns
  • Object

public void nullSafeSet (PreparedStatement st, Object value, int begin, SessionImplementor session)

Write an instance of the mapped class to a prepared statement. Implementors should handle possibility of null values. A multi-column type should be written to parameters starting from index.

Parameters
value the object to write
begin statement parameter index

public void nullSafeSet (PreparedStatement st, Object value, int begin, boolean[] settable, SessionImplementor session)

Write an instance of the mapped class to a prepared statement, ignoring some columns. Implementors should handle possibility of null values. A multi-column type should be written to parameters starting from index.

Parameters
value the object to write
begin statement parameter index
settable an array indicating which columns to ignore

public Object replace (Object original, Object target, SessionImplementor session, Object owner, Map copyCache)

During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging. 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.

Parameters
original the value from the detached entity being merged
target the value in the managed entity
Returns
  • the value to be merged

public Object replace (Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection)

During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging. 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.

Parameters
original the value from the detached entity being merged
target the value in the managed entity
Returns
  • the value to be merged

public Object resolve (Object value, SessionImplementor session, Object owner)

Map identifiers to entities or collections. This is the second phase of 2-phase property initialization.

Parameters
value an identifier or value returned by hydrate()
session the session
owner the parent entity
Returns
  • the given value, or the value associated with the identifier

public Object semiResolve (Object value, SessionImplementor session, Object owner)

Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations.

public void setPropertyValues (Object component, Object[] values, EntityMode entityMode)

Inject property values onto the given component instance

An optional operation

Parameters
component The component instance
values The values to inject
entityMode The entity mode

public void setToXMLNode (Node node, Object value, SessionFactoryImplementor factory)

A representation of the value to be embedded in an XML element.

Returns
  • String

public int[] sqlTypes (Mapping mapping)

Return the JDBC types codes (per java.sql.Types) for the columns mapped by this type.

Parameters
mapping The mapping object :/
Returns
  • The JDBC type codes.

public boolean[] toColumnNullness (Object value, Mapping mapping)

Given an instance of the type, return an array of boolean, indicating which mapped columns would be null.

Parameters
value an instance of the type

public String toLoggableString (Object value, SessionFactoryImplementor factory)

A representation of the value to be embedded in a log file.

Returns
  • String