Top Fields Constructors Methods
org.hibernate.cfg

public Class CollectionPropertyHolder

extends AbstractPropertyHolder
Class Inheritance
Imports
java.util.HashMap, .Locale, .Map, javax.persistence.Convert, .Converts, .Enumerated, .JoinTable, .ManyToMany, .MapKeyClass, .MapKeyEnumerated, .MapKeyTemporal, .OneToMany, .Temporal, org.hibernate.AssertionFailure, org.hibernate.annotations.CollectionType, .ManyToAny, .MapKeyType, org.hibernate.annotations.common.reflection.XClass, .XProperty, org.hibernate.boot.model.convert.spi.ConverterDescriptor, org.hibernate.boot.spi.MetadataBuildingContext, org.hibernate.internal.CoreLogging, .CoreMessageLogger, org.hibernate.internal.util.StringHelper, org.hibernate.mapping.Collection, .Join, .KeyValue, .PersistentClass, .Property, .Table
Authors
Emmanuel Bernard, Steve Ebersole

Field Summary

Modifier and TypeField and Description
private boolean
canElementBeConverted

private boolean
canKeyBeConverted

private final Collection
collection

private Map<String, AttributeConversionInfo>
elementAttributeConversionInfoMap

private Map<String, AttributeConversionInfo>
keyAttributeConversionInfoMap

private static final CoreMessageLogger
log

Hides org.hibernate.cfg.AbstractPropertyHolder.log.

pack-priv boolean
prepared

Inherited from org.hibernate.cfg.AbstractPropertyHolder:
parent

Constructor Summary

AccessConstructor and Description
public
CollectionPropertyHolder(Collection collection, String path, XClass clazzToProcess, XProperty property, PropertyHolder parentPropertyHolder, MetadataBuildingContext context)

Method Summary

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

Implements org.hibernate.cfg.PropertyHolder.addJoin.

public void
addProperty(Property prop, XClass declaringClass)

Implements org.hibernate.cfg.PropertyHolder.addProperty.

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

Implements org.hibernate.cfg.PropertyHolder.addProperty.

private void
applyLocalConvert(Convert convertAnnotation, XProperty collectionProperty, Map<String, AttributeConversionInfo> elementAttributeConversionInfoMap, Map<String, AttributeConversionInfo> keyAttributeConversionInfoMap)

private void
buildAttributeConversionInfoMaps(XProperty collectionProperty, Map<String, AttributeConversionInfo> elementAttributeConversionInfoMap, Map<String, AttributeConversionInfo> keyAttributeConversionInfoMap)

public String
getClassName()

Implements org.hibernate.cfg.PropertyHolder.getClassName.

public Collection
getCollectionBinding()

public String
getEntityName()

Implements org.hibernate.cfg.PropertyHolder.getEntityName.

public String
getEntityOwnerClassName()

Implements org.hibernate.cfg.PropertyHolder.getEntityOwnerClassName.

public KeyValue
getIdentifier()

Implements org.hibernate.cfg.PropertyHolder.getIdentifier.

public PersistentClass
getPersistentClass()

Implements org.hibernate.cfg.PropertyHolder.getPersistentClass.

public Table
getTable()

Implements org.hibernate.cfg.PropertyHolder.getTable.

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

Implements org.hibernate.cfg.PropertyHolder.isComponent.

public boolean
isEntity()

Implements org.hibernate.cfg.PropertyHolder.isEntity.

public boolean
isOrWithinEmbeddedId()

Implements org.hibernate.cfg.PropertyHolder.isOrWithinEmbeddedId.

Return true if this component is or is embedded in a @EmbeddedId
public boolean
isWithinElementCollection()

Implements org.hibernate.cfg.PropertyHolder.isWithinElementCollection.

Return true if this component is within an @ElementCollection.
protected AttributeConversionInfo
locateAttributeConversionInfo(XProperty property)

Implements abstract org.hibernate.cfg.AbstractPropertyHolder.locateAttributeConversionInfo.

protected AttributeConversionInfo
locateAttributeConversionInfo(String path)

Implements abstract org.hibernate.cfg.AbstractPropertyHolder.locateAttributeConversionInfo.

public ConverterDescriptor
mapKeyAttributeConverterDescriptor(XProperty mapXProperty, XClass keyXClass)

protected String
normalizeCompositePath(String attributeName)

Implements abstract org.hibernate.cfg.AbstractPropertyHolder.normalizeCompositePath.

protected String
normalizeCompositePathForLogging(String attributeName)

Implements abstract org.hibernate.cfg.AbstractPropertyHolder.normalizeCompositePathForLogging.

public void
prepare(XProperty collectionProperty)

private String

Returns:

Path without prefix, or null, if path did not have the prefix.
removePrefix(String
Path.
path, String
Prefix.
prefix)

Check if path has the given prefix and remove it.

private String
removePrefix(String path, String prefix, String defaultValue)

public ConverterDescriptor
resolveElementAttributeConverterDescriptor(XProperty collectionXProperty, XClass elementXClass)

public void
startingProperty(XProperty
The property
property)

Implements org.hibernate.cfg.PropertyHolder.startingProperty.

Called during binding to allow the PropertyHolder to inspect its discovered properties.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.hibernate.cfg.AbstractPropertyHolder:
buildExceptionFromInstantiationErrorgetContextgetJoinTablegetOverriddenColumngetOverriddenForeignKeygetOverriddenJoinColumngetOverriddenJoinTablegetPathisInIdClassmakeAttributeConverterDescriptorresolveAttributeConverterDescriptorsetCurrentPropertysetInIdClasssetParentProperty

Field Detail

canElementBeConvertedback to summary
private boolean canElementBeConverted
canKeyBeConvertedback to summary
private boolean canKeyBeConverted
collectionback to summary
private final Collection collection
elementAttributeConversionInfoMapback to summary
private Map<String, AttributeConversionInfo> elementAttributeConversionInfoMap
keyAttributeConversionInfoMapback to summary
private Map<String, AttributeConversionInfo> keyAttributeConversionInfoMap
logback to summary
private static final CoreMessageLogger log

Hides org.hibernate.cfg.AbstractPropertyHolder.log.

preparedback to summary
pack-priv boolean prepared

Constructor Detail

CollectionPropertyHolderback to summary
public CollectionPropertyHolder(Collection collection, String path, XClass clazzToProcess, XProperty property, PropertyHolder parentPropertyHolder, MetadataBuildingContext context)

Method Detail

addJoinback to summary
public Join addJoin(JoinTable joinTableAnn, boolean noDelayInPkColumnCreation)

Implements org.hibernate.cfg.PropertyHolder.addJoin.

addPropertyback to summary
public void addProperty(Property prop, XClass declaringClass)

Implements org.hibernate.cfg.PropertyHolder.addProperty.

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

Implements org.hibernate.cfg.PropertyHolder.addProperty.

applyLocalConvertback to summary
private void applyLocalConvert(Convert convertAnnotation, XProperty collectionProperty, Map<String, AttributeConversionInfo> elementAttributeConversionInfoMap, Map<String, AttributeConversionInfo> keyAttributeConversionInfoMap)
buildAttributeConversionInfoMapsback to summary
private void buildAttributeConversionInfoMaps(XProperty collectionProperty, Map<String, AttributeConversionInfo> elementAttributeConversionInfoMap, Map<String, AttributeConversionInfo> keyAttributeConversionInfoMap)
getClassNameback to summary
public String getClassName()

Implements org.hibernate.cfg.PropertyHolder.getClassName.

getCollectionBindingback to summary
public Collection getCollectionBinding()
getEntityNameback to summary
public String getEntityName()

Implements org.hibernate.cfg.PropertyHolder.getEntityName.

getEntityOwnerClassNameback to summary
public String getEntityOwnerClassName()

Implements org.hibernate.cfg.PropertyHolder.getEntityOwnerClassName.

getIdentifierback to summary
public KeyValue getIdentifier()

Implements org.hibernate.cfg.PropertyHolder.getIdentifier.

getPersistentClassback to summary
public PersistentClass getPersistentClass()

Implements org.hibernate.cfg.PropertyHolder.getPersistentClass.

getTableback to summary
public Table getTable()

Implements org.hibernate.cfg.PropertyHolder.getTable.

Deprecated

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

isComponentback to summary
public boolean isComponent()

Implements org.hibernate.cfg.PropertyHolder.isComponent.

isEntityback to summary
public boolean isEntity()

Implements org.hibernate.cfg.PropertyHolder.isEntity.

isOrWithinEmbeddedIdback to summary
public boolean isOrWithinEmbeddedId()

Implements org.hibernate.cfg.PropertyHolder.isOrWithinEmbeddedId.

Doc from org.hibernate.cfg.PropertyHolder.isOrWithinEmbeddedId.

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

isWithinElementCollectionback to summary
public boolean isWithinElementCollection()

Implements org.hibernate.cfg.PropertyHolder.isWithinElementCollection.

Doc from org.hibernate.cfg.PropertyHolder.isWithinElementCollection.

Return true if this component is within an @ElementCollection.

Annotations
@Override
locateAttributeConversionInfoback to summary
protected AttributeConversionInfo locateAttributeConversionInfo(XProperty property)

Implements abstract org.hibernate.cfg.AbstractPropertyHolder.locateAttributeConversionInfo.

Annotations
@Override
locateAttributeConversionInfoback to summary
protected AttributeConversionInfo locateAttributeConversionInfo(String path)

Implements abstract org.hibernate.cfg.AbstractPropertyHolder.locateAttributeConversionInfo.

Annotations
@Override
mapKeyAttributeConverterDescriptorback to summary
public ConverterDescriptor mapKeyAttributeConverterDescriptor(XProperty mapXProperty, XClass keyXClass)
normalizeCompositePathback to summary
protected String normalizeCompositePath(String attributeName)

Implements abstract org.hibernate.cfg.AbstractPropertyHolder.normalizeCompositePath.

Annotations
@Override
normalizeCompositePathForLoggingback to summary
protected String normalizeCompositePathForLogging(String attributeName)

Implements abstract org.hibernate.cfg.AbstractPropertyHolder.normalizeCompositePathForLogging.

Annotations
@Override
prepareback to summary
public void prepare(XProperty collectionProperty)
removePrefixback to summary
private String removePrefix(String path, String prefix)

Check if path has the given prefix and remove it.

Parameters
path:String

Path.

prefix:String

Prefix.

Returns:String

Path without prefix, or null, if path did not have the prefix.

removePrefixback to summary
private String removePrefix(String path, String prefix, String defaultValue)
resolveElementAttributeConverterDescriptorback to summary
public ConverterDescriptor resolveElementAttributeConverterDescriptor(XProperty collectionXProperty, XClass elementXClass)
startingPropertyback to summary
public void startingProperty(XProperty property)

Implements org.hibernate.cfg.PropertyHolder.startingProperty.

Doc from org.hibernate.cfg.PropertyHolder.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:XProperty

The property

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override