Package org.hibernate.metadata
Interface ClassMetadata
-
- All Known Implementing Classes:
AbstractEntityPersister
,JoinedSubclassEntityPersister
,SingleTableEntityPersister
,UnionSubclassEntityPersister
public interface ClassMetadata
Exposes entity class metadata to the application- See Also:
SessionFactory.getClassMetadata(Class)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description String
getEntityName()
The name of the entitySerializable
getIdentifier(Object object)
Deprecated.default Serializable
getIdentifier(Object entity, SessionImplementor session)
Deprecated.Serializable
getIdentifier(Object entity, SharedSessionContractImplementor session)
Get the identifier of an instance (throw an exception if no identifier property)String
getIdentifierPropertyName()
Get the name of the identifier property (or return null)Type
getIdentifierType()
Get the identifier Hibernate typeClass
getMappedClass()
The persistent class, or nullint[]
getNaturalIdentifierProperties()
Which properties hold the natural id?boolean[]
getPropertyLaziness()
Get the "laziness" of the properties of this classString[]
getPropertyNames()
Get the names of the class' persistent propertiesboolean[]
getPropertyNullability()
Get the nullability of the class' persistent propertiesType
getPropertyType(String propertyName)
Get the type of a particular (named) propertyType[]
getPropertyTypes()
Get the Hibernate types of the class propertiesObject
getPropertyValue(Object object, String propertyName)
Get the value of a particular (named) propertyObject[]
getPropertyValues(Object entity)
Extract the property values from the given entity.default Object[]
getPropertyValuesToInsert(Object entity, Map mergeMap, SessionImplementor session)
Deprecated.(since 5.3) Use the form accepting SharedSessionContractImplementor insteadObject[]
getPropertyValuesToInsert(Object entity, Map mergeMap, SharedSessionContractImplementor session)
Return the values of the mapped properties of the objectObject
getVersion(Object object)
Get the version number (or timestamp) from the object's version property (or return null if not versioned)int
getVersionProperty()
Get the index of the version propertyboolean
hasIdentifierProperty()
Does this class have an identifier property?boolean
hasNaturalIdentifier()
Does this entity declare a natural id?boolean
hasProxy()
Does this class support dynamic proxies?boolean
hasSubclasses()
Does this entity have mapped subclasses?boolean
implementsLifecycle()
Does the class implement the Lifecycle interface?default Object
instantiate(Serializable id, SessionImplementor session)
Deprecated.(since 5.3) Use the form accepting SharedSessionContractImplementor insteadObject
instantiate(Serializable id, SharedSessionContractImplementor session)
Create a class instance initialized with the given identifierboolean
isInherited()
Does this entity extend a mapped superclass?boolean
isMutable()
Are instances of this class mutable?boolean
isVersioned()
Are instances of this class versioned by a timestamp or version number column?default void
setIdentifier(Object entity, Serializable id, SessionImplementor session)
Deprecated.void
setIdentifier(Object entity, Serializable id, SharedSessionContractImplementor session)
Inject the identifier value into the given entity.void
setPropertyValue(Object object, String propertyName, Object value)
Set the value of a particular (named) propertyvoid
setPropertyValues(Object object, Object[] values)
Set the given values to the mapped properties of the given object
-
-
-
Method Detail
-
getEntityName
String getEntityName()
The name of the entity
-
getIdentifierPropertyName
String getIdentifierPropertyName()
Get the name of the identifier property (or return null)
-
getPropertyNames
String[] getPropertyNames()
Get the names of the class' persistent properties
-
getIdentifierType
Type getIdentifierType()
Get the identifier Hibernate type
-
getPropertyTypes
Type[] getPropertyTypes()
Get the Hibernate types of the class properties
-
getPropertyType
Type getPropertyType(String propertyName) throws HibernateException
Get the type of a particular (named) property- Throws:
HibernateException
-
hasProxy
boolean hasProxy()
Does this class support dynamic proxies?
-
isMutable
boolean isMutable()
Are instances of this class mutable?
-
isVersioned
boolean isVersioned()
Are instances of this class versioned by a timestamp or version number column?
-
getVersionProperty
int getVersionProperty()
Get the index of the version property
-
getPropertyNullability
boolean[] getPropertyNullability()
Get the nullability of the class' persistent properties
-
getPropertyLaziness
boolean[] getPropertyLaziness()
Get the "laziness" of the properties of this class
-
hasIdentifierProperty
boolean hasIdentifierProperty()
Does this class have an identifier property?
-
hasNaturalIdentifier
boolean hasNaturalIdentifier()
Does this entity declare a natural id?
-
getNaturalIdentifierProperties
int[] getNaturalIdentifierProperties()
Which properties hold the natural id?
-
hasSubclasses
boolean hasSubclasses()
Does this entity have mapped subclasses?
-
isInherited
boolean isInherited()
Does this entity extend a mapped superclass?
-
getPropertyValuesToInsert
@Deprecated default Object[] getPropertyValuesToInsert(Object entity, Map mergeMap, SessionImplementor session) throws HibernateException
Deprecated.(since 5.3) Use the form accepting SharedSessionContractImplementor insteadReturn the values of the mapped properties of the object- Throws:
HibernateException
-
getPropertyValuesToInsert
Object[] getPropertyValuesToInsert(Object entity, Map mergeMap, SharedSessionContractImplementor session) throws HibernateException
Return the values of the mapped properties of the object- Throws:
HibernateException
-
getMappedClass
Class getMappedClass()
The persistent class, or null
-
instantiate
@Deprecated default Object instantiate(Serializable id, SessionImplementor session)
Deprecated.(since 5.3) Use the form accepting SharedSessionContractImplementor insteadCreate a class instance initialized with the given identifier- Parameters:
id
- The identifier value to use (may be null to represent no value)session
- The session from which the request originated.- Returns:
- The instantiated entity.
-
instantiate
Object instantiate(Serializable id, SharedSessionContractImplementor session)
Create a class instance initialized with the given identifier- Parameters:
id
- The identifier value to use (may be null to represent no value)session
- The session from which the request originated.- Returns:
- The instantiated entity.
-
getPropertyValue
Object getPropertyValue(Object object, String propertyName) throws HibernateException
Get the value of a particular (named) property- Throws:
HibernateException
-
getPropertyValues
Object[] getPropertyValues(Object entity) throws HibernateException
Extract the property values from the given entity.- Parameters:
entity
- The entity from which to extract the property values.- Returns:
- The property values.
- Throws:
HibernateException
-
setPropertyValue
void setPropertyValue(Object object, String propertyName, Object value) throws HibernateException
Set the value of a particular (named) property- Throws:
HibernateException
-
setPropertyValues
void setPropertyValues(Object object, Object[] values) throws HibernateException
Set the given values to the mapped properties of the given object- Throws:
HibernateException
-
getIdentifier
@Deprecated Serializable getIdentifier(Object object) throws HibernateException
Deprecated.Get the identifier of an instance (throw an exception if no identifier property)- Throws:
HibernateException
-
getIdentifier
@Deprecated default Serializable getIdentifier(Object entity, SessionImplementor session)
Deprecated.Get the identifier of an instance (throw an exception if no identifier property)- Parameters:
entity
- The entity for which to get the identifiersession
- The session from which the request originated- Returns:
- The identifier
-
getIdentifier
Serializable getIdentifier(Object entity, SharedSessionContractImplementor session)
Get the identifier of an instance (throw an exception if no identifier property)- Parameters:
entity
- The entity for which to get the identifiersession
- The session from which the request originated- Returns:
- The identifier
-
setIdentifier
@Deprecated default void setIdentifier(Object entity, Serializable id, SessionImplementor session)
Deprecated.Inject the identifier value into the given entity.- Parameters:
entity
- The entity to inject with the identifier value.id
- The value to be injected as the identifier.session
- The session from which is requests originates
-
setIdentifier
void setIdentifier(Object entity, Serializable id, SharedSessionContractImplementor session)
Inject the identifier value into the given entity.- Parameters:
entity
- The entity to inject with the identifier value.id
- The value to be injected as the identifier.session
- The session from which is requests originates
-
implementsLifecycle
boolean implementsLifecycle()
Does the class implement the Lifecycle interface?
-
getVersion
Object getVersion(Object object) throws HibernateException
Get the version number (or timestamp) from the object's version property (or return null if not versioned)- Throws:
HibernateException
-
-