org.hibernate.persister.entity

public Interface PropertyMapping

Known Direct Subinterfaces: org.hibernate.persister.entity.Queryable, org.hibernate.persister.collection.QueryableCollection
Known Direct Implementers: org.hibernate.hql.internal.ast.tree.ComponentJoin.ComponentPropertyMapping, org.hibernate.hql.internal.ast.tree.FromElementType.SpecialManyToManyCollectionPropertyMapping, org.hibernate.loader.plan.build.internal.spaces.CompositePropertyMapping, org.hibernate.persister.collection.CollectionPropertyMapping, org.hibernate.persister.collection.ElementPropertyMapping, org.hibernate.persister.entity.AbstractPropertyMapping
Imports: org.hibernate.QueryException, org.hibernate.type.Type

Contract for all things that know how to map a property to the needed bits of SQL.

The column/formula fragments that represent a property in the table defining the property be obtained by calling either toColumns(String, String) or toColumns(String) to obtain SQL-aliased column/formula fragments aliased or un-aliased, respectively.

Note, the methods here are generally ascribed to accept "property paths". That is a historical necessity because of how Hibernate originally understood composites (embeddables) internally. That is in the process of changing as Hibernate has added org.hibernate.loader.plan.build.internal.spaces.CompositePropertyMapping

Authors: Gavin King, Steve Ebersole

Method Summary

Modifier and Type	Method and Description
public Type	getType() Get the type of the thing containing the properties
public String[]	toColumns(String alias, String propertyName) Obtain aliased column/formula fragments for the specified property path.
public String[]	toColumns(String propertyName) Given a property path, return the corresponding column name(s).
public Type	toType(String propertyName) Given a component path expression, get the type of the property

Method Detail

getType	back to summary
public Type getType() Get the type of the thing containing the properties

toColumns	back to summary
public String[] toColumns(String alias, String propertyName) throws QueryException Obtain aliased column/formula fragments for the specified property path.

toColumns	back to summary
public String[] toColumns(String propertyName) throws QueryException, UnsupportedOperationException Given a property path, return the corresponding column name(s).

toType	back to summary
public Type toType(String propertyName) throws QueryException Given a component path expression, get the type of the property