ClassMetadata (Hibernate API Documentation) - Hibernate 3.2.4 正式版 API 英文文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.hibernate.metadata
Interface ClassMetadata

All Known Implementing Classes:: AbstractEntityPersister

public interface ClassMetadata

Exposes entity class metadata to the application

Author:: Gavin King
See Also:: SessionFactory.getClassMetadata(Class)

Method Summary

String getEntityName()
          The name of the entity

Serializable getIdentifier(Object entity, EntityMode entityMode)
          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 type

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

int[] getNaturalIdentifierProperties()
          Which properties hold the natural id?

boolean[] getPropertyLaziness()
          Get the "laziness" of the properties of this class

String[] getPropertyNames()
          Get the names of the class' persistent properties

boolean[] getPropertyNullability()
          Get the nullability of the class' persistent properties

Type getPropertyType(String propertyName)
          Get the type of a particular (named) property

Type[] getPropertyTypes()
          Get the Hibernate types of the class properties

Object getPropertyValue(Object object, String propertyName, EntityMode entityMode)
          Get the value of a particular (named) property

Object[] getPropertyValues(Object entity, EntityMode entityMode)
          Extract the property values from the given entity.

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

Object getVersion(Object object, EntityMode entityMode)
          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 property

boolean 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(EntityMode entityMode)
          Does the class implement the Lifecycle interface?

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

Object instantiate(Serializable id, EntityMode entityMode)
          Create a class instance initialized with the given identifier

boolean 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?

void setIdentifier(Object object, Serializable id, EntityMode entityMode)
          Set the identifier of an instance (or do nothing if no identifier property)

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

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

Method Detail

getEntityName

public String getEntityName()

The name of the entity

getIdentifierPropertyName

public String getIdentifierPropertyName()

Get the name of the identifier property (or return null)

getPropertyNames

public String[] getPropertyNames()

Get the names of the class' persistent properties

getIdentifierType

public Type getIdentifierType()

Get the identifier Hibernate type

getPropertyTypes

public Type[] getPropertyTypes()

Get the Hibernate types of the class properties

getPropertyType

public Type getPropertyType(String propertyName)
                     throws HibernateException

Get the type of a particular (named) property

Throws:: HibernateException

hasProxy

public boolean hasProxy()

Does this class support dynamic proxies?

isMutable

public boolean isMutable()

Are instances of this class mutable?

isVersioned

public boolean isVersioned()

Are instances of this class versioned by a timestamp or version number column?

getVersionProperty

public int getVersionProperty()

Get the index of the version property

getPropertyNullability

public boolean[] getPropertyNullability()

Get the nullability of the class' persistent properties

getPropertyLaziness

public boolean[] getPropertyLaziness()

Get the "laziness" of the properties of this class

hasIdentifierProperty

public boolean hasIdentifierProperty()

Does this class have an identifier property?

hasNaturalIdentifier

public boolean hasNaturalIdentifier()

Does this entity declare a natural id?

getNaturalIdentifierProperties

public int[] getNaturalIdentifierProperties()

Which properties hold the natural id?

hasSubclasses

public boolean hasSubclasses()

Does this entity have mapped subclasses?

isInherited

public boolean isInherited()

Does this entity extend a mapped superclass?

getPropertyValuesToInsert

public Object[] getPropertyValuesToInsert(Object entity,
                                          Map mergeMap,
                                          SessionImplementor session)
                                   throws HibernateException

Return the values of the mapped properties of the object

Throws:: HibernateException

getMappedClass

public Class getMappedClass(EntityMode entityMode)

The persistent class, or null

instantiate

public Object instantiate(Serializable id,
                          EntityMode entityMode)
                   throws HibernateException

Create a class instance initialized with the given identifier

Throws:: HibernateException

getPropertyValue

public Object getPropertyValue(Object object,
                               String propertyName,
                               EntityMode entityMode)
                        throws HibernateException

Get the value of a particular (named) property

Throws:: HibernateException

getPropertyValues

public 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

public void setPropertyValue(Object object,
                             String propertyName,
                             Object value,
                             EntityMode entityMode)
                      throws HibernateException

Set the value of a particular (named) property

Throws:: HibernateException

setPropertyValues

public 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

public Serializable getIdentifier(Object entity,
                                  EntityMode entityMode)
                           throws HibernateException

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

Throws:: HibernateException

setIdentifier

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

Set the identifier of an instance (or do nothing if no identifier property)

Throws:: HibernateException

implementsLifecycle

public boolean implementsLifecycle(EntityMode entityMode)

Does the class implement the Lifecycle interface?

implementsValidatable

public boolean implementsValidatable(EntityMode entityMode)

Does the class implement the Validatable interface?

getVersion

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)

Throws:: HibernateException