Interface PropertyHolder
- All Known Implementing Classes:
AbstractPropertyHolder,ClassPropertyHolder,CollectionPropertyHolder,ComponentPropertyHolder
public interface PropertyHolder
Property holder abstract property containers from their direct implementation
- Author:
- Emmanuel Bernard
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddProperty(Property prop, XClass declaringClass) voidaddProperty(Property prop, AnnotatedColumns columns, XClass declaringClass) getJoinTable(XProperty property) return - null if no join table is present, - the join table if not overridden, - the overridden join table otherwiseColumn[]getOverriddenColumn(String propertyName) return null if the column is not overridden, or an array of column if truegetOverriddenColumnTransformer(String logicalColumnName) default ForeignKeygetOverriddenForeignKey(String propertyName) return null if hte foreign key is not overridden, or the foreign key if truegetOverriddenJoinColumn(String propertyName) return null if the column is not overridden, or an array of column if truegetPath()getTable()booleanbooleanisEntity()booleanbooleanReturn true if this component is or is embedded in a @EmbeddedIdbooleanReturn true if this component is within an @ElementCollection.resolveAttributeConverterDescriptor(XProperty property) Determine the AttributeConverter to use for the given property.voidsetInIdClass(Boolean isInIdClass) voidsetParentProperty(String parentProperty) voidstartingProperty(XProperty property) Called during binding to allow the PropertyHolder to inspect its discovered properties.
-
Method Details
-
getClassName
String getClassName() -
getEntityOwnerClassName
String getEntityOwnerClassName() -
getTable
Table getTable() -
addProperty
-
addProperty
-
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
-
getPath
String getPath() -
getOverriddenColumn
return null if the column is not overridden, or an array of column if true -
getOverriddenJoinColumn
return null if the column is not overridden, or an array of column if true -
getOverriddenForeignKey
return null if hte foreign key is not overridden, or the foreign key if true -
getOverriddenColumnTransformer
-
getJoinTable
return - null if no join table is present, - the join table if not overridden, - the overridden join table otherwise -
getEntityName
String getEntityName() -
addJoin
-
addJoin
-
isInIdClass
boolean isInIdClass() -
setInIdClass
-
startingProperty
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
Determine the AttributeConverter to use for the given property.- Returns:
- The ConverterDescriptor
-