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:

  • Method Details

    • 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

      Object[] getPropertyValuesToInsert(Object entity, Map mergeMap, SessionImplementor session) throws HibernateException
      Return the values of the mapped properties of the object
      Throws:
      HibernateException

    • getMappedClass

      Class getMappedClass(EntityMode entityMode)
      The persistent class, or null

    • instantiate

      Object instantiate(Serializable id, EntityMode entityMode) throws HibernateException
      Deprecated.
      Use instantiate(Serializable, SessionImplementor) instead
      Create a class instance initialized with the given identifier
      Throws:
      HibernateException

    • instantiate

      Object instantiate(Serializable id, SessionImplementor 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, EntityMode entityMode) throws HibernateException
      Get the value of a particular (named) property
      Throws:
      HibernateException

    • getPropertyValues

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

    • setPropertyValue

      void setPropertyValue(Object object, String propertyName, Object value, EntityMode entityMode) throws HibernateException
      Set the value of a particular (named) property
      Throws:
      HibernateException

    • setPropertyValues

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

    • getIdentifier

      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)
      Throws:
      HibernateException

    • getIdentifier

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

    • setIdentifier

      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 - The entity to inject with the identifier value.
      id - The value to be injected as the identifier.
      entityMode - The entity mode
      Throws:
      HibernateException

    • setIdentifier

      void setIdentifier(Object entity, Serializable id, SessionImplementor 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(EntityMode entityMode)
      Does the class implement the Lifecycle interface?

    • implementsValidatable

      boolean implementsValidatable(EntityMode entityMode)
      Does the class implement the Validatable interface?

    • getVersion

      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)
      Throws:
      HibernateException