Hibernate Core 3.6.10.Final · org.hibernate.metadata.ClassMetadata

Method Summary

Modifier and Type	Method and Description
public String	getEntityName() The name of the entity
public Serializable	getIdentifier(Object object, EntityMode entityMode) Deprecated Use `getIdentifier(Object, SessionImplementor)` instead Get the identifier of an instance (throw an exception if no identifier property)
public Serializable	Returns: The identifier getIdentifier(Object The entity for which to get the identifier entity, SessionImplementor The session from which the request originated session) Get the identifier of an instance (throw an exception if no identifier property)
public String	getIdentifierPropertyName() Get the name of the identifier property (or return null)
public Type	getIdentifierType() Get the identifier Hibernate type
public Class<T>	getMappedClass(EntityMode entityMode) The persistent class, or null
public int[]	getNaturalIdentifierProperties() Which properties hold the natural id?
public boolean[]	getPropertyLaziness() Get the "laziness" of the properties of this class
public String[]	getPropertyNames() Get the names of the class' persistent properties
public boolean[]	getPropertyNullability() Get the nullability of the class' persistent properties
public Type	getPropertyType(String propertyName) Get the type of a particular (named) property
public Type[]	getPropertyTypes() Get the Hibernate types of the class properties
public Object	getPropertyValue(Object object, String propertyName, EntityMode entityMode) Get the value of a particular (named) property
public Object[]	Returns: The property values. getPropertyValues(Object The entity from which to extract the property values. entity, EntityMode The entity-mode of the given entity entityMode) Extract the property values from the given entity.
public Object[]	getPropertyValuesToInsert(Object entity, Map<K, V> mergeMap, SessionImplementor session) Return the values of the mapped properties of the object
public Object	getVersion(Object object, EntityMode entityMode) Get the version number (or timestamp) from the object's version property (or return null if not versioned)
public int	getVersionProperty() Get the index of the version property
public boolean	hasIdentifierProperty() Does this class have an identifier property?
public boolean	hasNaturalIdentifier() Does this entity declare a natural id?
public boolean	hasProxy() Does this class support dynamic proxies?
public boolean	hasSubclasses() Does this entity have mapped subclasses?
public boolean	implementsLifecycle(EntityMode entityMode) Does the class implement the `Lifecycle` interface?
public boolean	implementsValidatable(EntityMode entityMode) Does the class implement the `Validatable` interface?
public Object	instantiate(Serializable id, EntityMode entityMode) Deprecated Use `instantiate(Serializable, SessionImplementor)` instead Create a class instance initialized with the given identifier
public Object	Returns: The instantiated entity. instantiate(Serializable The identifier value to use (may be null to represent no value) id, SessionImplementor The session from which the request originated. session) Create a class instance initialized with the given identifier
public boolean	isInherited() Does this entity extend a mapped superclass?
public boolean	isMutable() Are instances of this class mutable?
public boolean	isVersioned() Are instances of this class versioned by a timestamp or version number column?
public void	setIdentifier(Object The entity to inject with the identifier value. entity, Serializable The value to be injected as the identifier. id, EntityMode The entity mode entityMode) Deprecated Use `setIdentifier(Object, Serializable, SessionImplementor)` instead. Inject the identifier value into the given entity.
public void	setIdentifier(Object The entity to inject with the identifier value. entity, Serializable The value to be injected as the identifier. id, SessionImplementor The session from which is requests originates session) Inject the identifier value into the given entity.
public void	setPropertyValue(Object object, String propertyName, Object value, EntityMode entityMode) Set the value of a particular (named) property
public void	setPropertyValues(Object object, Object[] values, EntityMode entityMode) Set the given values to the mapped properties of the given object

Method Detail

getEntityName	back to summary
public String getEntityName() The name of the entity

getIdentifier	back to summary
public Serializable getIdentifier(Object object, EntityMode entityMode) throws HibernateException Deprecated Use `getIdentifier(Object, SessionImplementor)` instead Get the identifier of an instance (throw an exception if no identifier property)

getIdentifier	back to summary
public Serializable getIdentifier(Object entity, SessionImplementor session) Get the identifier of an instance (throw an exception if no identifier property) Parameters entity:Object The entity for which to get the identifier session:SessionImplementor The session from which the request originated Returns:Serializable The identifier

getIdentifier

back to summary

public Serializable getIdentifier(Object entity, SessionImplementor session)

Get the identifier of an instance (throw an exception if no identifier property)

Parameters

entity:Object: The entity for which to get the identifier
session:SessionImplementor: The session from which the request originated

Returns:Serializable

The identifier

getIdentifierPropertyName	back to summary
public String getIdentifierPropertyName() Get the name of the identifier property (or return null)

getIdentifierType	back to summary
public Type getIdentifierType() Get the identifier Hibernate type

getMappedClass	back to summary
public Class<T> getMappedClass(EntityMode entityMode) The persistent class, or null

getNaturalIdentifierProperties	back to summary
public int[] getNaturalIdentifierProperties() Which properties hold the natural id?

getPropertyLaziness	back to summary
public boolean[] getPropertyLaziness() Get the "laziness" of the properties of this class

getPropertyNames	back to summary
public String[] getPropertyNames() Get the names of the class' persistent properties

getPropertyNullability	back to summary
public boolean[] getPropertyNullability() Get the nullability of the class' persistent properties

getPropertyType	back to summary
public Type getPropertyType(String propertyName) throws HibernateException Get the type of a particular (named) property

getPropertyTypes	back to summary
public Type[] getPropertyTypes() Get the Hibernate types of the class properties

getPropertyValue	back to summary
public Object getPropertyValue(Object object, String propertyName, EntityMode entityMode) throws HibernateException Get the value of a particular (named) property

getPropertyValues	back to summary
public Object[] getPropertyValues(Object entity, EntityMode entityMode) throws HibernateException Extract the property values from the given entity. Parameters entity:Object The entity from which to extract the property values. entityMode:EntityMode The entity-mode of the given entity Returns:Object[] The property values.

getPropertyValues

back to summary

public Object[] getPropertyValues(Object entity, EntityMode entityMode) throws HibernateException

Extract the property values from the given entity.

Parameters

entity:Object: The entity from which to extract the property values.
entityMode:EntityMode: The entity-mode of the given entity

Returns:Object[]

The property values.

getPropertyValuesToInsert	back to summary
public Object[] getPropertyValuesToInsert(Object entity, Map<K, V> mergeMap, SessionImplementor session) throws HibernateException Return the values of the mapped properties of the object

getVersion	back to summary
public Object getVersion(Object object, EntityMode entityMode) throws HibernateException Get the version number (or timestamp) from the object's version property (or return null if not versioned)

getVersionProperty	back to summary
public int getVersionProperty() Get the index of the version property

hasIdentifierProperty	back to summary
public boolean hasIdentifierProperty() Does this class have an identifier property?

hasNaturalIdentifier	back to summary
public boolean hasNaturalIdentifier() Does this entity declare a natural id?

hasProxy	back to summary
public boolean hasProxy() Does this class support dynamic proxies?

hasSubclasses	back to summary
public boolean hasSubclasses() Does this entity have mapped subclasses?

implementsLifecycle	back to summary
public boolean implementsLifecycle(EntityMode entityMode) Does the class implement the `Lifecycle` interface?

implementsValidatable	back to summary
public boolean implementsValidatable(EntityMode entityMode) Does the class implement the `Validatable` interface?

instantiate	back to summary
public Object instantiate(Serializable id, EntityMode entityMode) throws HibernateException Deprecated Use `instantiate(Serializable, SessionImplementor)` instead Create a class instance initialized with the given identifier

instantiate	back to summary
public Object instantiate(Serializable id, SessionImplementor session) Create a class instance initialized with the given identifier Parameters id:Serializable The identifier value to use (may be null to represent no value) session:SessionImplementor The session from which the request originated. Returns:Object The instantiated entity.

instantiate

back to summary

public Object instantiate(Serializable id, SessionImplementor session)

Create a class instance initialized with the given identifier

Parameters

id:Serializable: The identifier value to use (may be null to represent no value)
session:SessionImplementor: The session from which the request originated.

Returns:Object

The instantiated entity.

isInherited	back to summary
public boolean isInherited() Does this entity extend a mapped superclass?

isMutable	back to summary
public boolean isMutable() Are instances of this class mutable?

isVersioned	back to summary
public boolean isVersioned() Are instances of this class versioned by a timestamp or version number column?

setIdentifier back to summary

setIdentifier	back to summary
public void setIdentifier(Object entity, Serializable id, EntityMode entityMode) throws HibernateException Deprecated Use `setIdentifier(Object, Serializable, SessionImplementor)` instead. Inject the identifier value into the given entity. Has no effect if the entity does not define an identifier property Parameters entity:Object The entity to inject with the identifier value. id:Serializable The value to be injected as the identifier. entityMode:EntityMode The entity mode

public void setIdentifier(Object entity, Serializable id, EntityMode entityMode) throws HibernateException

Deprecated

Use setIdentifier(Object, Serializable, SessionImplementor) instead.

Inject the identifier value into the given entity.

Has no effect if the entity does not define an identifier property

Parameters

entity:Object: The entity to inject with the identifier value.
id:Serializable: The value to be injected as the identifier.
entityMode:EntityMode: The entity mode

setIdentifier	back to summary
public void setIdentifier(Object entity, Serializable id, SessionImplementor session) Inject the identifier value into the given entity. Parameters entity:Object The entity to inject with the identifier value. id:Serializable The value to be injected as the identifier. session:SessionImplementor The session from which is requests originates

setIdentifier

back to summary

public void setIdentifier(Object entity, Serializable id, SessionImplementor session)

Inject the identifier value into the given entity.

Parameters

entity:Object: The entity to inject with the identifier value.
id:Serializable: The value to be injected as the identifier.
session:SessionImplementor: The session from which is requests originates

setPropertyValue	back to summary
public void setPropertyValue(Object object, String propertyName, Object value, EntityMode entityMode) throws HibernateException Set the value of a particular (named) property

setPropertyValues	back to summary
public void setPropertyValues(Object object, Object[] values, EntityMode entityMode) throws HibernateException Set the given values to the mapped properties of the given object

public Interface ClassMetadata

Method Summary

Method Detail