Top Description Methods
org.hibernate.cfg

public Interface PropertyHolder

Known Direct Implementers
org.hibernate.cfg.AbstractPropertyHolder
Imports
javax.persistence.Column, .ForeignKey, .JoinColumn, .JoinTable, org.hibernate.annotations.common.reflection.XClass, .XProperty, org.hibernate.boot.model.convert.spi.ConverterDescriptor, org.hibernate.mapping.Join, .KeyValue, .PersistentClass, .Property, .Table

Property holder abstract property containers from their direct implementation
Author
Emmanuel Bernard

Method Summary

Modifier and TypeMethod and Description
public Join
addJoin(JoinTable joinTableAnn, boolean noDelayInPkColumnCreation)

public void
addProperty(Property prop, XClass declaringClass)

public void
addProperty(Property prop, Ejb3Column[] columns, XClass declaringClass)

public String
public String
public String
public KeyValue
public JoinTable
getJoinTable(XProperty property)

return - null if no join table is present, - the join table if not overridden, - the overridden join table otherwise

public Column[]
getOverriddenColumn(String propertyName)

return null if the column is not overridden, or an array of column if true

public default ForeignKey
getOverriddenForeignKey(String propertyName)

return null if hte foreign key is not overridden, or the foreign key if true

public JoinColumn[]
getOverriddenJoinColumn(String propertyName)

return null if the column is not overridden, or an array of column if true

public String
public PersistentClass
public Table
getTable()

Deprecated as a consequence of Table being deprecated.
public boolean
public boolean
public boolean
public boolean
isOrWithinEmbeddedId()

Return true if this component is or is embedded in a @EmbeddedId

public boolean
isWithinElementCollection()

Return true if this component is within an @ElementCollection.

public ConverterDescriptor

Returns:

The ConverterDescriptor
resolveAttributeConverterDescriptor
(XProperty property)

Determine the AttributeConverter to use for the given property.

public void
setInIdClass(Boolean isInIdClass)

public void
setParentProperty(String parentProperty)

public void
startingProperty(XProperty
The property
property
)

Called during binding to allow the PropertyHolder to inspect its discovered properties.

Method Detail

addJoinback to summary
public Join addJoin(JoinTable joinTableAnn, boolean noDelayInPkColumnCreation)
addPropertyback to summary
public void addProperty(Property prop, XClass declaringClass)
addPropertyback to summary
public void addProperty(Property prop, Ejb3Column[] columns, XClass declaringClass)
getClassNameback to summary
public String getClassName()
getEntityNameback to summary
public String getEntityName()
getEntityOwnerClassNameback to summary
public String getEntityOwnerClassName()
getIdentifierback to summary
public KeyValue getIdentifier()
getJoinTableback to summary
public JoinTable getJoinTable(XProperty property)

return - null if no join table is present, - the join table if not overridden, - the overridden join table otherwise

getOverriddenColumnback to summary
public Column[] getOverriddenColumn(String propertyName)

return null if the column is not overridden, or an array of column if true

getOverriddenForeignKeyback to summary
public default ForeignKey getOverriddenForeignKey(String propertyName)

return null if hte foreign key is not overridden, or the foreign key if true

getOverriddenJoinColumnback to summary
public JoinColumn[] getOverriddenJoinColumn(String propertyName)

return null if the column is not overridden, or an array of column if true

getPathback to summary
public String getPath()
getPersistentClassback to summary
public PersistentClass getPersistentClass()
getTableback to summary
public Table getTable()

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

isComponentback to summary
public boolean isComponent()
isEntityback to summary
public boolean isEntity()
isInIdClassback to summary
public boolean isInIdClass()
isOrWithinEmbeddedIdback to summary
public boolean isOrWithinEmbeddedId()

Return true if this component is or is embedded in a @EmbeddedId

isWithinElementCollectionback to summary
public boolean isWithinElementCollection()

Return true if this component is within an @ElementCollection.

resolveAttributeConverterDescriptorback to summary
public ConverterDescriptor resolveAttributeConverterDescriptor(XProperty property)

Determine the AttributeConverter to use for the given property.

Returns:ConverterDescriptor

The ConverterDescriptor

setInIdClassback to summary
public void setInIdClass(Boolean isInIdClass)
setParentPropertyback to summary
public void setParentProperty(String parentProperty)
startingPropertyback to summary
public void startingProperty(XProperty property)

Called during binding to allow the PropertyHolder to inspect its discovered properties. Mainly this is used in collecting attribute conversion declarations (via @Convert/@Converts).

Parameters
property:XProperty

The property