|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.hibernate.type.AbstractType org.hibernate.type.ComponentType
public class ComponentType
Handles "component" mappings
Field Summary | |
---|---|
protected ComponentTuplizer |
componentTuplizer
|
protected EntityMode |
entityMode
|
protected int |
propertySpan
|
Fields inherited from class org.hibernate.type.AbstractType |
---|
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE |
Constructor Summary | |
---|---|
ComponentType(TypeFactory.TypeScope typeScope,
ComponentMetamodel metamodel)
|
Method Summary | |
---|---|
Object |
assemble(Serializable object,
SessionImplementor session,
Object owner)
Reconstruct the object from its disassembled state. |
int |
compare(Object x,
Object y)
Perform a Comparator style comparison between values |
Object |
deepCopy(Object component,
SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections. |
Size[] |
defaultSizes(Mapping mapping)
Defines the column sizes to use according to this type if the user did not explicitly say (and if 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,
SessionImplementor session,
Object owner)
Return a disassembled representation of the object. |
Object |
fromXMLNode(org.dom4j.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. |
ComponentTuplizer |
getComponentTuplizer()
|
EntityMode |
getEntityMode()
|
FetchMode |
getFetchMode(int i)
Retrieve the fetch mode of the indicated component property. |
int |
getHashCode(Object x)
Get a hash code, consistent with persistence "equality". |
int |
getHashCode(Object x,
SessionFactoryImplementor factory)
Get a hash code, consistent with persistence "equality". |
String |
getName()
Returns the abbreviated name of the type. |
int |
getPropertyIndex(String name)
|
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,
EntityMode entityMode)
|
Object |
getPropertyValue(Object component,
int i,
SessionImplementor 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,
SessionImplementor session)
Extract the values of the component properties from the given component instance |
Class |
getReturnedClass()
The class returned by Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SessionImplementor, java.lang.Object) methods. |
Type[] |
getSubtypes()
Get the types of the component properties |
boolean |
hasNotNullProperty()
|
Object |
hydrate(ResultSet rs,
String[] names,
SessionImplementor session,
Object owner)
Extract a value from the JDBC result set. |
Object |
instantiate(EntityMode entityMode)
This method does not populate the component parent |
Object |
instantiate(Object parent,
SessionImplementor session)
|
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)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). |
boolean |
isEqual(Object x,
Object y,
SessionFactoryImplementor factory)
Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). |
boolean |
isKey()
|
boolean |
isMethodOf(Method method)
Is the given method a member of this component's class? |
boolean |
isModified(Object old,
Object current,
boolean[] checkable,
SessionImplementor session)
Has the value been modified compared to the current database state? The difference between this and the Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.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)
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)
Extract a value of the mapped class from the JDBC result set. |
Object |
nullSafeGet(ResultSet rs,
String name,
SessionImplementor session,
Object owner)
Extract a value of the mapped class from the JDBC result set. |
void |
nullSafeSet(PreparedStatement st,
Object value,
int begin,
boolean[] settable,
SessionImplementor 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 begin,
SessionImplementor session)
Bind a value represented by an instance of the mapped class to the JDBC prepared
statement. |
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)
The second phase of 2-phase loading. |
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(org.dom4j.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 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, getSemiResolvedType, isAnyType, isAssociationType, isCollectionType, isEntityType, replaceNode |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.hibernate.type.Type |
---|
beforeAssemble, getSemiResolvedType, isAnyType, isAssociationType, isCollectionType, isEntityType |
Field Detail |
---|
protected final int propertySpan
protected final EntityMode entityMode
protected final ComponentTuplizer componentTuplizer
Constructor Detail |
---|
public ComponentType(TypeFactory.TypeScope typeScope, ComponentMetamodel metamodel)
Method Detail |
---|
public boolean isKey()
public EntityMode getEntityMode()
public ComponentTuplizer getComponentTuplizer()
public int getColumnSpan(Mapping mapping) throws MappingException
Type
sqlTypes(mapping).length
getColumnSpan
in interface Type
mapping
- The mapping object :/
MappingException
- Generally indicates an issue accessing the passed mapping object.public int[] sqlTypes(Mapping mapping) throws MappingException
Type
Types
) for the columns mapped by this type.
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
char
/Character
would
have a dictated length limit of 1; for a string-based UUID
would have a size limit of 36; etc.
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
Type.dictatedSizes(org.hibernate.engine.spi.Mapping)
were given).
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 final boolean isComponentType()
Type
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 Class getReturnedClass()
Type
Type.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
methods. This is used to establish the class of an array of
this type.
getReturnedClass
in interface Type
public boolean isSame(Object x, Object y) throws HibernateException
Type
equals
check on the values. For associations
the implication is a bit different. For most types it is conceivable to simply delegate to Type.isEqual(java.lang.Object, java.lang.Object)
isSame
in interface Type
isSame
in class AbstractType
x
- The first valuey
- The second value
HibernateException
- A problem occurred performing the comparisonpublic boolean isEqual(Object x, Object y) throws HibernateException
Type
isEqual
in interface Type
isEqual
in class AbstractType
x
- The first valuey
- The second value
HibernateException
- A problem occurred performing the comparisonpublic boolean isEqual(Object x, Object y, SessionFactoryImplementor factory) throws HibernateException
Type
isEqual
in interface Type
isEqual
in class AbstractType
x
- The first valuey
- The second valuefactory
- The session factory
HibernateException
- A problem occurred performing the comparisonpublic int compare(Object x, Object y)
Type
Comparator
style comparison between values
compare
in interface Type
compare
in class AbstractType
x
- The first valuey
- The second value
Comparator.compare(T, T)
for a discussion.public boolean isMethodOf(Method method)
CompositeType
isMethodOf
in interface CompositeType
method
- The method to check
public int getHashCode(Object x)
Type
hashCode
.
getHashCode
in interface Type
getHashCode
in class AbstractType
x
- The value for which to retrieve a hash code
public int getHashCode(Object x, SessionFactoryImplementor factory)
Type
hashCode
.
getHashCode
in interface Type
getHashCode
in class AbstractType
x
- The value for which to retrieve a hash codefactory
- The session factory
public boolean isDirty(Object x, Object y, SessionImplementor session) throws HibernateException
Type
isDirty
in interface Type
isDirty
in class AbstractType
x
- the old valuey
- the current valuesession
- The session from which the request originated.
HibernateException
- A problem occurred performing the checkingpublic boolean isDirty(Object x, Object y, boolean[] checkable, SessionImplementor session) throws HibernateException
Type
isDirty
in interface Type
x
- the old valuey
- the current valuecheckable
- An array of booleans indicating which columns making up the value are actually checkablesession
- The session from which the request originated.
HibernateException
- A problem occurred performing the checkingpublic boolean isModified(Object old, Object current, boolean[] checkable, SessionImplementor session) throws HibernateException
Type
Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.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
Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SessionImplementor)
here/
isModified
in interface Type
isModified
in class AbstractType
old
- the database state, in a "hydrated" form, with identifiers unresolvedcurrent
- the current state of the objectcheckable
- which columns are actually updatablesession
- The session from which the request originated.
HibernateException
- A problem occurred performing the checkingpublic Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) throws HibernateException, SQLException
Type
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 entity
HibernateException
- An error from Hibernate
SQLException
- An error from the JDBC driveralternative, 2-phase property initialization
public void nullSafeSet(PreparedStatement st, Object value, int begin, SessionImplementor session) throws HibernateException, SQLException
Type
mapped class
to the JDBC prepared
statement. Implementors should handle possibility of null values. A multi-column type should bind parameters
starting from index.
nullSafeSet
in interface Type
st
- The JDBC prepared statement to which to bindvalue
- the object to writebegin
- starting parameter bind indexsession
- The originating session
HibernateException
- An error from Hibernate
SQLException
- An error from the JDBC driverpublic void nullSafeSet(PreparedStatement st, Object value, int begin, boolean[] settable, SessionImplementor session) throws HibernateException, SQLException
Type
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 index.
nullSafeSet
in interface Type
st
- The JDBC prepared statement to which to bindvalue
- the object to writebegin
- starting parameter bind indexsettable
- an array indicating which columns to bind/ignoresession
- The originating session
HibernateException
- An error from Hibernate
SQLException
- An error from the JDBC driverpublic Object nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner) throws HibernateException, SQLException
Type
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.name
- the column name making up this type value (use to read from result set)session
- The originating sessionowner
- the parent entity
HibernateException
- An error from Hibernate
SQLException
- An error from the JDBC driverpublic Object getPropertyValue(Object component, int i, SessionImplementor session) throws HibernateException
CompositeType
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, EntityMode entityMode) throws HibernateException
HibernateException
public Object getPropertyValue(Object component, int i) throws HibernateException
HibernateException
public Object[] getPropertyValues(Object component, SessionImplementor session) throws HibernateException
CompositeType
getPropertyValues
in interface CompositeType
component
- The component instancesession
- The session from which the request originates
HibernateException
- Indicates a problem access the property values.public Object[] getPropertyValues(Object component, EntityMode entityMode) throws HibernateException
CompositeType
getPropertyValues
in interface CompositeType
component
- The component instanceentityMode
- The entity mode
HibernateException
- Indicates a problem access the property values.public void setPropertyValues(Object component, Object[] values, EntityMode entityMode) throws HibernateException
CompositeType
setPropertyValues
in interface CompositeType
component
- The component instancevalues
- The values to injectentityMode
- The entity mode
HibernateException
- Indicates an issue performing the injectionpublic Type[] getSubtypes()
CompositeType
getSubtypes
in interface CompositeType
public String getName()
Type
getName
in interface Type
public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
Type
toLoggableString
in interface Type
value
- The value to be loggedfactory
- The session factory
HibernateException
- An error from Hibernatepublic String[] getPropertyNames()
CompositeType
getPropertyNames
in interface CompositeType
public Object deepCopy(Object component, SessionFactoryImplementor factory) throws HibernateException
Type
deepCopy
in interface Type
component
- The value to be copiedfactory
- The session factory
HibernateException
- An error from Hibernatepublic Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache) throws HibernateException
Type
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 values
HibernateException
- An error from Hibernatepublic Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection) throws HibernateException
Type
replace
in interface Type
replace
in class AbstractType
original
- the value from the detached entity being mergedtarget
- the value in the managed entitysession
- The originating sessionowner
- The owner of the valuecopyCache
- The cache of already copied/replaced valuesforeignKeyDirection
- For associations, which direction does the foreign key point?
HibernateException
- An error from Hibernatepublic Object instantiate(EntityMode entityMode) throws HibernateException
HibernateException
public Object instantiate(Object parent, SessionImplementor session) throws HibernateException
HibernateException
public CascadeStyle getCascadeStyle(int i)
CompositeType
getCascadeStyle
in interface CompositeType
i
- The property index,
public boolean isMutable()
Type
isMutable
in interface Type
public Serializable disassemble(Object value, SessionImplementor session, Object owner) throws HibernateException
Type
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 assemble(Serializable object, SessionImplementor session, Object owner) throws HibernateException
Type
Type.disassemble(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
assemble
in interface Type
assemble
in class AbstractType
object
- the disassembled state from the cachesession
- the originating sessionowner
- the parent entity object
HibernateException
- An error from Hibernatepublic FetchMode getFetchMode(int i)
CompositeType
getFetchMode
in interface CompositeType
i
- The property index,
public Object hydrate(ResultSet rs, String[] names, SessionImplementor session, Object owner) throws HibernateException, SQLException
Type
Type.resolve(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
This hydrated value will be either:
hydrate
in interface Type
hydrate
in class AbstractType
rs
- The JDBC result setnames
- the column names making up this type value (use to read from result set)session
- The originating sessionowner
- the parent entity
HibernateException
- An error from Hibernate
SQLException
- An error from the JDBC driverType.resolve(java.lang.Object, org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
public Object resolve(Object value, SessionImplementor session, Object owner) throws HibernateException
Type
resolve
in interface Type
resolve
in class AbstractType
value
- an identifier or value returned by hydrate()session
- the sessionowner
- the parent entity
HibernateException
- An error from HibernateType.hydrate(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SessionImplementor, java.lang.Object)
public Object semiResolve(Object value, SessionImplementor session, Object owner) throws HibernateException
Type
semiResolve
in interface Type
semiResolve
in class AbstractType
value
- The unresolved, hydrated valuesession
- THe originating sessionowner
- The value owner
HibernateException
- An error from Hibernatepublic boolean[] getPropertyNullability()
CompositeType
getPropertyNullability
in interface CompositeType
public boolean isXMLElement()
isXMLElement
in interface Type
isXMLElement
in class AbstractType
public Object fromXMLNode(org.dom4j.Node xml, Mapping factory) throws HibernateException
Type
fromXMLNode
in interface Type
xml
- The XML node from which to read the valuefactory
- The session factory
mapped class
HibernateException
- An error from Hibernatepublic void setToXMLNode(org.dom4j.Node node, Object value, SessionFactoryImplementor factory) throws HibernateException
Type
setToXMLNode
in interface Type
node
- The XML node to which to write the valuevalue
- The value to writefactory
- The session factory
HibernateException
- An error from Hibernatepublic boolean[] toColumnNullness(Object value, Mapping mapping)
Type
toColumnNullness
in interface Type
value
- an instance of the typemapping
- The mapping abstraction
public boolean isEmbedded()
CompositeType
isEmbedded
in interface CompositeType
public int getPropertyIndex(String name)
public boolean hasNotNullProperty()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |