Class AnyType
- java.lang.Object
-
- org.hibernate.type.AbstractType
-
- org.hibernate.type.AnyType
-
- All Implemented Interfaces:
Serializable
,AssociationType
,CompositeType
,Type
public class AnyType extends AbstractType implements CompositeType, AssociationType
Handles "any" mappings- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AnyType.ObjectTypeCacheEntry
Used to externalize discrimination per a given identifier.
-
Field Summary
-
Fields inherited from class org.hibernate.type.AbstractType
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE
-
-
Constructor Summary
Constructors Constructor Description AnyType(TypeConfiguration typeConfiguration, Type discriminatorType, Type identifierType, boolean lazy)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
assemble(Serializable cached, SharedSessionContractImplementor session, Object owner)
Reconstruct the object from its disassembled state.int
compare(Object x, Object y)
Perform aComparator
-style comparison of the given values.int
compare(Object x, Object y, SessionFactoryImplementor factory)
Object
deepCopy(Object value, SessionFactoryImplementor factory)
Return a deep copy of the persistent state, stopping at entities and at collections.Serializable
disassemble(Object value, SessionFactoryImplementor sessionFactory)
Return a disassembled representation of the object.Serializable
disassemble(Object value, SharedSessionContractImplementor session, Object owner)
Return a disassembled representation of the object.String
getAssociatedEntityName(SessionFactoryImplementor factory)
Get the entity name of the associated entityJoinable
getAssociatedJoinable(SessionFactoryImplementor factory)
Get the "persister" for this association - a class or collection persisterCascadeStyle
getCascadeStyle(int i)
Retrieve the cascade style of the indicated component property.int
getColumnSpan(Mapping session)
How many columns are used to persist this type?Type
getDiscriminatorType()
FetchMode
getFetchMode(int i)
Retrieve the fetch mode of the indicated component property.ForeignKeyDirection
getForeignKeyDirection()
Get the foreign key directionality of this associationType
getIdentifierType()
String
getLHSPropertyName()
Get the name of a property in the owning entity that provides the join key (null if the identifier)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 propertiesboolean[]
getPropertyNullability()
Retrieve the indicators regarding which component properties are nullable.Object
getPropertyValue(Object component, int i, SharedSessionContractImplementor session)
Extract a particular component property value indicated by index.Object[]
getPropertyValues(Object component)
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 instanceClass<?>
getReturnedClass()
The class handled by this type.String
getRHSUniqueKeyPropertyName()
The name of a unique property of the associated entity that provides the join key (null if the identifier of an entity, or key of a collection)int[]
getSqlTypeCodes(Mapping mapping)
Type[]
getSubtypes()
Get the types of the component propertiesboolean
hasNotNullProperty()
Convenience method to quickly checkCompositeType.getPropertyNullability()
for any non-nullable sub-properties.boolean
hasNullProperty()
Convenience method to quickly check ifCompositeType.getPropertyNullability()
contains a nullable sub-properties.boolean
isAlwaysDirtyChecked()
Do we dirty check this association, even when there are no columns to be updated?boolean
isAnyType()
Return true if the implementation is castable toAnyType
.boolean
isAssociationType()
Return true if the implementation is castable toAssociationType
.boolean
isComponentType()
Return true if the implementation is castable toCompositeType
.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 ownerboolean
isMethodOf(Method method)
Is the given method a member of this component's class?boolean
isModified(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session)
Has the value been modified compared to the current database state? The difference between this and theType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)
methods is that here we need to account for "partially" built values.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.boolean
isReferenceToPrimaryKey()
boolean
isSame(Object x, Object y)
Compare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state, taking a shortcut for entity references.void
nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session)
Bind a value represented by an instance of themapped class
to the given JDBCPreparedStatement
, ignoring some columns as dictated by thesettable
parameter.void
nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session)
Bind a value represented by an instance of themapped class
to the given JDBCPreparedStatement
, ignoring some columns as dictated by thesettable
parameter.Object
replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map<Object,Object> 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)
Inject property values onto the given component instanceboolean[]
toColumnNullness(Object value, Mapping mapping)
Given an instance of the type, return an array ofboolean
values indicating which mapped columns would be null.String
toLoggableString(Object value, SessionFactoryImplementor factory)
Generate a representation of the given value for logging purposes.boolean
useLHSPrimaryKey()
Is the primary key of the owning entity table to be used in the join?-
Methods inherited from class org.hibernate.type.AbstractType
beforeAssemble, getHashCode, getHashCode, isCollectionType, isDirty, isEntityType, isEqual, isEqual, replace
-
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, getHashCode, getHashCode, isCollectionType, isDirty, isEntityType, isEqual, isEqual, replace
-
-
-
-
Constructor Detail
-
AnyType
public AnyType(TypeConfiguration typeConfiguration, Type discriminatorType, Type identifierType, boolean lazy)
-
-
Method Detail
-
getIdentifierType
public Type getIdentifierType()
-
getDiscriminatorType
public Type getDiscriminatorType()
-
getName
public String getName()
Description copied from interface:Type
Returns the abbreviated name of the type.
-
getReturnedClass
public Class<?> getReturnedClass()
Description copied from interface:Type
The class handled by this type.- Specified by:
getReturnedClass
in interfaceType
- Returns:
- The java type class handled by this type.
-
getSqlTypeCodes
public int[] getSqlTypeCodes(Mapping mapping) throws MappingException
Description copied from interface:Type
Return the JDBC types codes as defined byTypes
orSqlTypes
for the columns mapped by this type.The number of elements in this array must match the return from
Type.getColumnSpan(org.hibernate.engine.spi.Mapping)
.- Specified by:
getSqlTypeCodes
in interfaceType
- Parameters:
mapping
- The mapping object :/- Returns:
- The JDBC type codes.
- Throws:
MappingException
- Generally indicates an issue accessing the passed mapping object.
-
getPropertyValues
public Object[] getPropertyValues(Object component)
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 instance- Returns:
- The property values
-
isAnyType
public boolean isAnyType()
Description copied from interface:Type
Return true if the implementation is castable toAnyType
. Shortcut fortype instanceof AnyType
.An
AnyType
is additionally anAssociationType
; so if this method returns true, thenType.isAssociationType()
should also return true.- Specified by:
isAnyType
in interfaceType
- Overrides:
isAnyType
in classAbstractType
- Returns:
- True if this type is also an
AnyType
implementor; false otherwise.
-
isAssociationType
public boolean isAssociationType()
Description copied from interface:Type
Return true if the implementation is castable toAssociationType
. This does not necessarily imply that the type actually represents an association. Shortcut fortype instanceof AssociationType
.- Specified by:
isAssociationType
in interfaceType
- Overrides:
isAssociationType
in classAbstractType
- Returns:
- True if this type is also an
AssociationType
implementor; false otherwise.
-
isComponentType
public boolean isComponentType()
Description copied from interface:Type
Return true if the implementation is castable toCompositeType
. Shortcut fortype instanceof CompositeType
.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.
-
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.
-
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.
-
deepCopy
public Object deepCopy(Object value, SessionFactoryImplementor factory)
Description copied from interface:Type
Return a deep copy of the persistent state, stopping at entities and at collections.
-
compare
public int compare(Object x, Object y)
Description copied from interface:Type
Perform aComparator
-style comparison of the given values.- Specified by:
compare
in interfaceType
- Overrides:
compare
in classAbstractType
- Parameters:
x
- The first valuey
- The second value- Returns:
- The comparison result.
- See Also:
Comparator.compare(Object, Object)
-
compare
public int compare(Object x, Object y, SessionFactoryImplementor factory)
-
isSame
public boolean isSame(Object x, Object y) throws HibernateException
Description copied from interface:Type
Compare two instances of the class mapped by this type for persistence "equality", that is, equality of persistent state, taking a shortcut for entity references.For most types this should boil down to an equality comparison of the given values, and it's reasonable to simply delegate to
Type.isEqual(Object, Object)
. But for associations the semantics are a bit different.- Specified by:
isSame
in interfaceType
- Overrides:
isSame
in classAbstractType
- Parameters:
x
- The first valuey
- The second value- Returns:
- True if there are considered the same (see discussion above).
- Throws:
HibernateException
- A problem occurred performing the comparison
-
isModified
public boolean isModified(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
Description copied from interface:Type
Has the value been modified compared to the current database state? The difference between this and theType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)
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 toType.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor)
.- Specified by:
isModified
in interfaceType
- Overrides:
isModified
in classAbstractType
- Parameters:
old
- the database state, in a "hydrated" form, with identifiers unresolvedcurrent
- the current state of the objectcheckable
- which columns are actually checkablesession
- The session from which the request originated.- Returns:
- true if the field has been modified
- Throws:
HibernateException
- A problem occurred performing the checking
-
toColumnNullness
public boolean[] toColumnNullness(Object value, Mapping mapping)
Description copied from interface:Type
Given an instance of the type, return an array ofboolean
values 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(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 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
-
getColumnSpan
public int getColumnSpan(Mapping session)
Description copied from interface:Type
How many columns are used to persist this type?Always the same as
getSqlTypCodes(mapping).length
.- Specified by:
getColumnSpan
in interfaceType
- Parameters:
session
- The mapping object :/- Returns:
- The number of columns
-
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 themapped class
to the given JDBCPreparedStatement
, ignoring some columns as dictated by thesettable
parameter. Implementors should handle the possibility of null values. A multi-column type should bind parameters starting fromindex
.- 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 HibernateSQLException
- 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 themapped class
to the given JDBCPreparedStatement
, ignoring some columns as dictated by thesettable
parameter. Implementors should handle the possibility of null values. A multi-column type should bind parameters starting fromindex
.- 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 HibernateSQLException
- An error from the JDBC driver
-
toLoggableString
public String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
Description copied from interface:Type
Generate a representation of the given 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
-
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 function is the inverse ofType.disassemble(Object, SharedSessionContractImplementor, 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 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 representation that is stored in the second-level cache.A reference to an associated entity should be disassembled to its primary key value.
- 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
-
disassemble
public Serializable disassemble(Object value, SessionFactoryImplementor sessionFactory) throws HibernateException
Description copied from interface:Type
Return a disassembled representation of the object. This is the representation that is stored in the second-level cache.A reference to an associated entity should be disassembled to its primary key value.
A high-quality implementation of this method should ensure that:
Objects.equals(disassemble(x,s), disassemble(y,s))
== isEqual(x,y,sf)and that:
Objects.equals(x, assemble(disassemble(x,s),s,o))
That is, the implementation must be consistent with
Type.isEqual(Object, Object, SessionFactoryImplementor)
and withType.assemble(Serializable, SharedSessionContractImplementor, Object)
.- Specified by:
disassemble
in interfaceType
- Overrides:
disassemble
in classAbstractType
- Parameters:
value
- the value to cachesessionFactory
- the session factory- 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<Object,Object> 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
-
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 interfaceCompositeType
- Parameters:
method
- The method to check- Returns:
- True if the method is a member; false otherwise.
-
getPropertyNames
public 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(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.
-
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 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.
-
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 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.
-
setPropertyValues
public void setPropertyValues(Object component, Object[] values)
Description copied from interface:CompositeType
Inject property values onto the given component instanceAn optional operation
- Specified by:
setPropertyValues
in interfaceCompositeType
- Parameters:
component
- The component instancevalues
- The values to inject
-
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
-
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.
-
hasNullProperty
public boolean hasNullProperty()
Description copied from interface:CompositeType
Convenience method to quickly check ifCompositeType.getPropertyNullability()
contains a nullable sub-properties.- Specified by:
hasNullProperty
in interfaceCompositeType
- Returns:
true
if any of the properties are nullable as indicated byCompositeType.getPropertyNullability()
,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.
-
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
-
getForeignKeyDirection
public ForeignKeyDirection getForeignKeyDirection()
Description copied from interface:AssociationType
Get the foreign key directionality of this association- Specified by:
getForeignKeyDirection
in interfaceAssociationType
-
useLHSPrimaryKey
public boolean useLHSPrimaryKey()
Description copied from interface:AssociationType
Is the primary key of the owning entity table to be used in the join?- Specified by:
useLHSPrimaryKey
in interfaceAssociationType
-
getLHSPropertyName
public String getLHSPropertyName()
Description copied from interface:AssociationType
Get the name of a property in the owning entity that provides the join key (null if the identifier)- Specified by:
getLHSPropertyName
in interfaceAssociationType
-
isReferenceToPrimaryKey
public boolean isReferenceToPrimaryKey()
-
getRHSUniqueKeyPropertyName
public String getRHSUniqueKeyPropertyName()
Description copied from interface:AssociationType
The name of a unique property of the associated entity that provides the join key (null if the identifier of an entity, or key of a collection)- Specified by:
getRHSUniqueKeyPropertyName
in interfaceAssociationType
-
isAlwaysDirtyChecked
public boolean isAlwaysDirtyChecked()
Description copied from interface:AssociationType
Do we dirty check this association, even when there are no columns to be updated?- Specified by:
isAlwaysDirtyChecked
in interfaceAssociationType
-
getAssociatedJoinable
public Joinable getAssociatedJoinable(SessionFactoryImplementor factory)
Description copied from interface:AssociationType
Get the "persister" for this association - a class or collection persister- Specified by:
getAssociatedJoinable
in interfaceAssociationType
-
getAssociatedEntityName
public String getAssociatedEntityName(SessionFactoryImplementor factory)
Description copied from interface:AssociationType
Get the entity name of the associated entity- Specified by:
getAssociatedEntityName
in interfaceAssociationType
-
-