Package org.hibernate.cfg

Interface PropertyHolder

All Known Implementing Classes:

AbstractPropertyHolder, ClassPropertyHolder, CollectionPropertyHolder, ComponentPropertyHolder

public interface PropertyHolder

Property holder abstract property containers from their direct implementation

Method Summary

Modifier and Type	Method	Description
Join	addJoin(JoinTable joinTableAnn, boolean noDelayInPkColumnCreation)
void	addProperty(Property prop, org.hibernate.annotations.common.reflection.XClass declaringClass)
void	addProperty(Property prop, Ejb3Column[] columns, org.hibernate.annotations.common.reflection.XClass declaringClass)
String	getClassName()
String	getEntityName()
String	getEntityOwnerClassName()
KeyValue	getIdentifier()
JoinTable	getJoinTable(org.hibernate.annotations.common.reflection.XProperty property)	return - null if no join table is present, - the join table if not overridden, - the overridden join table otherwise
Column[]	getOverriddenColumn(String propertyName)	return null if the column is not overridden, or an array of column if true
default ForeignKey	getOverriddenForeignKey(String propertyName)	return null if hte foreign key is not overridden, or the foreign key if true
JoinColumn[]	getOverriddenJoinColumn(String propertyName)	return null if the column is not overridden, or an array of column if true
String	getPath()
PersistentClass	getPersistentClass()
Table	getTable()
boolean	isComponent()
boolean	isEntity()
boolean	isInIdClass()
boolean	isOrWithinEmbeddedId()	Return true if this component is or is embedded in a @EmbeddedId
boolean	isWithinElementCollection()	Return true if this component is within an @ElementCollection.
ConverterDescriptor	resolveAttributeConverterDescriptor(org.hibernate.annotations.common.reflection.XProperty property)	Determine the AttributeConverter to use for the given property.
void	setInIdClass(Boolean isInIdClass)
void	setParentProperty(String parentProperty)
void	startingProperty(org.hibernate.annotations.common.reflection.XProperty property)	Called during binding to allow the PropertyHolder to inspect its discovered properties.

Method Detail

getClassName

String getClassName()

getEntityOwnerClassName

String getEntityOwnerClassName()

getTable

Table getTable()

addProperty

void addProperty(Property prop,
                 org.hibernate.annotations.common.reflection.XClass declaringClass)

addProperty

void addProperty(Property prop,
                 Ejb3Column[] columns,
                 org.hibernate.annotations.common.reflection.XClass declaringClass)

getIdentifier

KeyValue getIdentifier()

isOrWithinEmbeddedId

boolean isOrWithinEmbeddedId()

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

isWithinElementCollection

boolean isWithinElementCollection()

Return true if this component is within an @ElementCollection.

getPersistentClass

PersistentClass getPersistentClass()

isComponent

boolean isComponent()

isEntity

boolean isEntity()

setParentProperty

void setParentProperty(String parentProperty)

getPath

String getPath()

getOverriddenColumn

Column[] getOverriddenColumn(String propertyName)

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

getOverriddenJoinColumn

JoinColumn[] getOverriddenJoinColumn(String propertyName)

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

getOverriddenForeignKey

default ForeignKey getOverriddenForeignKey(String propertyName)

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

getJoinTable

JoinTable getJoinTable(org.hibernate.annotations.common.reflection.XProperty property)

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

getEntityName

String getEntityName()

addJoin

Join addJoin(JoinTable joinTableAnn,
             boolean noDelayInPkColumnCreation)

isInIdClass

boolean isInIdClass()

setInIdClass

void setInIdClass(Boolean isInIdClass)

startingProperty

void startingProperty(org.hibernate.annotations.common.reflection.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 - The property

resolveAttributeConverterDescriptor

ConverterDescriptor resolveAttributeConverterDescriptor(org.hibernate.annotations.common.reflection.XProperty property)

Determine the AttributeConverter to use for the given property.

Parameters:

property -

Returns:

The ConverterDescriptor