public class AnyType extends AbstractType implements CompositeType, AssociationType
| Type | Property and Description |
|---|---|
boolean |
hasNotNull
Convenience method to quickly check
CompositeType.getPropertyNullability() for any non-nullable sub-properties. |
| Modifier and Type | Class and Description |
|---|---|
static class |
AnyType.ObjectTypeCacheEntry
Used to externalize discrimination per a given identifier.
|
LEGACY_DEFAULT_SIZE, LEGACY_DICTATED_SIZE| Modifier | Constructor and Description |
|---|---|
|
AnyType(TypeFactory.TypeScope scope,
Type discriminatorType,
Type identifierType) |
protected |
AnyType(Type discriminatorType,
Type identifierType)
Intended for use only from legacy
ObjectType type definition |
| Modifier and Type | Method and Description |
|---|---|
Object |
assemble(Serializable cached,
SharedSessionContractImplementor 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 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.
|
String |
getAssociatedEntityName(SessionFactoryImplementor factory)
Get the entity name of the associated entity
|
Joinable |
getAssociatedJoinable(SessionFactoryImplementor factory)
Get the "persister" for this association - a class or
collection persister
|
CascadeStyle |
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 association
|
Type |
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.
|
String |
getOnCondition(String alias,
SessionFactoryImplementor factory,
Map enabledFilters)
Get the "filtering" SQL fragment that is applied in the
SQL on clause, in addition to the usual join condition
|
String |
getOnCondition(String alias,
SessionFactoryImplementor factory,
Map enabledFilters,
Set<String> treatAsDeclarations)
Get the "filtering" SQL fragment that is applied in the
SQL on clause, in addition to the usual join condition
|
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,
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
|
Class |
getReturnedClass()
|
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)
|
Type[] |
getSubtypes()
Get the types of the component properties
|
boolean |
hasNotNullProperty()
Convenience method to quickly check
CompositeType.getPropertyNullability() for any non-nullable sub-properties. |
Object |
hydrate(ResultSet rs,
String[] names,
SharedSessionContractImplementor session,
Object owner)
Extract a value from the JDBC result set.
|
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 to
AnyType. |
boolean |
isAssociationType()
Return true if the implementation is castable to
AssociationType. |
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 |
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 the
Type.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.
|
boolean |
isReferenceToPrimaryKey() |
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.
|
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 name,
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.
|
Object |
resolve(Object value,
SharedSessionContractImplementor session,
Object owner) |
Object |
semiResolve(Object value,
SharedSessionContractImplementor 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
|
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.
|
boolean |
useLHSPrimaryKey()
Is the primary key of the owning entity table
to be used in the join?
|
beforeAssemble, getHashCode, getHashCode, getSemiResolvedType, isCollectionType, isDirty, isEntityType, isEqual, isEqual, replaceclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbeforeAssemble, getHashCode, getHashCode, getSemiResolvedType, isCollectionType, isDirty, isEntityType, isEqual, isEqual, replace, resolvepublic boolean hasNotNullProperty
hasNotNullProperty in interface CompositeTypetrue if any of the properties are not-nullable as indicated by CompositeType.getPropertyNullability(),
false otherwise.protected AnyType(Type discriminatorType, Type identifierType)
ObjectType type definitionpublic AnyType(TypeFactory.TypeScope scope, Type discriminatorType, Type identifierType)
public Type getIdentifierType()
public Type getDiscriminatorType()
public String getName()
Typepublic Class getReturnedClass()
TypeType.nullSafeGet(java.sql.ResultSet, java.lang.String[], org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object) methods. This is used to establish the class of an array of
this type.getReturnedClass in interface Typepublic int[] sqlTypes(Mapping mapping) throws MappingException
TypeTypes) 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 Typemapping - The mapping object :/MappingException - Generally indicates an issue accessing the passed mapping object.public Size[] dictatedSizes(Mapping mapping) throws MappingException
Typechar/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 Typemapping - The mapping object :/MappingException - Generally indicates an issue accessing the passed mapping object.public Size[] defaultSizes(Mapping mapping) throws MappingException
TypeType.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 Typemapping - The mapping object :/MappingException - Generally indicates an issue accessing the passed mapping object.public Object[] getPropertyValues(Object component, EntityMode entityMode)
CompositeTypegetPropertyValues in interface CompositeTypecomponent - The component instanceentityMode - The entity modepublic boolean isAnyType()
TypeAnyType. Essentially a polymorphic
version of (type instanceof AnyType.class).
An AnyType is additionally an AssociationType; so if this method returns true,
Type.isAssociationType() should also return true.isAnyType in interface TypeisAnyType in class AbstractTypeAnyType implementor; false otherwise.public boolean isAssociationType()
TypeAssociationType. This does not necessarily imply that
the type actually represents an association. Essentially a polymorphic version of
(type instanceof AssociationType.class)isAssociationType in interface TypeisAssociationType in class AbstractTypeAssociationType implementor; false otherwise.public boolean isComponentType()
TypeCompositeType. 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 TypeisComponentType in class AbstractTypeCompositeType implementor; false otherwise.public boolean isEmbedded()
CompositeTypeisEmbedded in interface CompositeTypepublic boolean isMutable()
Typepublic Object deepCopy(Object value, SessionFactoryImplementor factory)
Typepublic int compare(Object x, Object y)
TypeComparator style comparison between valuescompare in interface Typecompare in class AbstractTypex - The first valuey - The second valueComparator.compare(T, T) for a discussion.public boolean isSame(Object x, Object y) throws HibernateException
Typeequals 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 TypeisSame in class AbstractTypex - The first valuey - The second valueHibernateException - A problem occurred performing the comparisonpublic boolean isModified(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
TypeType.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 to
Type.isDirty(java.lang.Object, java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor) here/isModified in interface TypeisModified in class AbstractTypeold - 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 boolean[] toColumnNullness(Object value, Mapping mapping)
TypetoColumnNullness in interface Typevalue - an instance of the typemapping - The mapping abstractionpublic boolean isDirty(Object old, Object current, boolean[] checkable, SharedSessionContractImplementor session) throws HibernateException
TypeisDirty in interface Typeold - the old valuecurrent - the current valuecheckable - An array of booleans indicating which columns making up the value are actually checkablesession - The session from which the request originated.HibernateException - A problem occurred performing the checkingpublic int getColumnSpan(Mapping session)
TypesqlTypes(mapping).lengthgetColumnSpan in interface Typesession - The mapping object :/public Object nullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
Typemapped class from the JDBC result set. Implementors
should handle possibility of null values.nullSafeGet in interface Typers - The result set from which to extract value.names - the column names making up this type value (use to read from result set)session - The originating sessionowner - the parent entityHibernateException - An error from HibernateSQLException - An error from the JDBC driveralternative, 2-phase property initializationpublic Object hydrate(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner) throws HibernateException, SQLException
TypeType.resolve(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)
This hydrated value will be either:hydrate in interface Typehydrate in class AbstractTypers - The JDBC result setnames - the column names making up this type value (use to read from result set)session - The originating sessionowner - the parent entityHibernateException - An error from HibernateSQLException - An error from the JDBC driverType.resolve(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)public Object resolve(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
resolve in interface Typeresolve in class AbstractTypeHibernateExceptionType.resolve(Object, SharedSessionContractImplementor, Object, Boolean)public void nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session) throws HibernateException, SQLException
Typemapped 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 Typest - The JDBC prepared statement to which to bindvalue - the object to writeindex - starting parameter bind indexsession - The originating sessionHibernateException - An error from HibernateSQLException - An error from the JDBC driverpublic void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SharedSessionContractImplementor session) throws HibernateException, SQLException
Typemapped 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 Typest - The JDBC prepared statement to which to bindvalue - the object to writeindex - starting parameter bind indexsettable - an array indicating which columns to bind/ignoresession - The originating sessionHibernateException - An error from HibernateSQLException - An error from the JDBC driverpublic String toLoggableString(Object value, SessionFactoryImplementor factory) throws HibernateException
TypetoLoggableString in interface Typevalue - The value to be loggedfactory - The session factoryHibernateException - An error from Hibernatepublic Object assemble(Serializable cached, SharedSessionContractImplementor session, Object owner) throws HibernateException
TypeType.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object)assemble in interface Typeassemble in class AbstractTypecached - the disassembled state from the cachesession - the originating sessionowner - the parent entity objectHibernateException - An error from Hibernatepublic Serializable disassemble(Object value, SharedSessionContractImplementor session, Object owner) throws HibernateException
Typedisassemble in interface Typedisassemble in class AbstractTypevalue - the value to cachesession - the originating sessionowner - optional parent entity object (needed for collections)HibernateException - An error from Hibernatepublic Object replace(Object original, Object target, SharedSessionContractImplementor session, Object owner, Map copyCache) throws HibernateException
Typereplace in interface Typeoriginal - the value from the detached entity being mergedtarget - the value in the managed entitysession - The originating sessionowner - The owner of the valuecopyCache - The cache of already copied/replaced valuesHibernateException - An error from Hibernatepublic Object nullSafeGet(ResultSet rs, String name, SharedSessionContractImplementor session, Object owner)
Typemapped 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 Typers - 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 entitypublic Object semiResolve(Object value, SharedSessionContractImplementor session, Object owner)
TypesemiResolve in interface TypesemiResolve in class AbstractTypevalue - The unresolved, hydrated valuesession - THe originating sessionowner - The value ownerpublic boolean isMethodOf(Method method)
CompositeTypeisMethodOf in interface CompositeTypemethod - The method to checkpublic String[] getPropertyNames()
CompositeTypegetPropertyNames in interface CompositeTypepublic int getPropertyIndex(String name)
CompositeTypegetPropertyIndex in interface CompositeTypename - The (sub-)property name to find.public Object getPropertyValue(Object component, int i, SharedSessionContractImplementor session) throws HibernateException
CompositeTypegetPropertyValue in interface CompositeTypecomponent - 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[] getPropertyValues(Object component, SharedSessionContractImplementor session) throws HibernateException
CompositeTypegetPropertyValues in interface CompositeTypecomponent - The component instancesession - The session from which the request originatesHibernateException - Indicates a problem access the property values.public void setPropertyValues(Object component, Object[] values, EntityMode entityMode)
CompositeTypesetPropertyValues in interface CompositeTypecomponent - The component instancevalues - The values to injectentityMode - The entity modepublic boolean[] getPropertyNullability()
CompositeTypegetPropertyNullability in interface CompositeTypepublic boolean hasNotNullProperty()
CompositeTypeCompositeType.getPropertyNullability() for any non-nullable sub-properties.hasNotNullProperty in interface CompositeTypetrue if any of the properties are not-nullable as indicated by CompositeType.getPropertyNullability(),
false otherwise.public Type[] getSubtypes()
CompositeTypegetSubtypes in interface CompositeTypepublic CascadeStyle getCascadeStyle(int i)
CompositeTypegetCascadeStyle in interface CompositeTypei - The property index,public FetchMode getFetchMode(int i)
CompositeTypegetFetchMode in interface CompositeTypei - The property index,public ForeignKeyDirection getForeignKeyDirection()
AssociationTypegetForeignKeyDirection in interface AssociationTypepublic boolean useLHSPrimaryKey()
AssociationTypeuseLHSPrimaryKey in interface AssociationTypepublic String getLHSPropertyName()
AssociationTypegetLHSPropertyName in interface AssociationTypepublic boolean isReferenceToPrimaryKey()
public String getRHSUniqueKeyPropertyName()
AssociationTypegetRHSUniqueKeyPropertyName in interface AssociationTypepublic boolean isAlwaysDirtyChecked()
AssociationTypeisAlwaysDirtyChecked in interface AssociationTypepublic Joinable getAssociatedJoinable(SessionFactoryImplementor factory)
AssociationTypegetAssociatedJoinable in interface AssociationTypepublic String getAssociatedEntityName(SessionFactoryImplementor factory)
AssociationTypegetAssociatedEntityName in interface AssociationTypepublic String getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters)
AssociationTypegetOnCondition in interface AssociationTypepublic String getOnCondition(String alias, SessionFactoryImplementor factory, Map enabledFilters, Set<String> treatAsDeclarations)
AssociationTypegetOnCondition in interface AssociationTypeCopyright © 2001-2018 Red Hat, Inc. All Rights Reserved.