public abstract class

CollectionBinder

extends Object
java.lang.Object
   ↳ org.hibernate.cfg.annotations.CollectionBinder
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Base class for binding different types of collections to Hibernate configuration objects.

Summary

Fields
protected boolean cascadeDeleteEnabled
protected Collection collection
protected String hqlOrderBy
protected IndexColumn indexColumn
protected Map<XClass, InheritanceState> inheritanceStatePerClass
protected HashMap<String, IdGenerator> localGenerators
protected String mapKeyPropertyName
protected String propertyName
Protected Constructors
CollectionBinder()
CollectionBinder(boolean sorted)
Public Methods
void bind()
static void bindManytoManyInverseFk(PersistentClass referencedEntity, Ejb3JoinColumn[] columns, SimpleValue value, boolean unique, Mappings mappings)
bind the inverse FK of a ManyToMany If we are in a mappedBy case, read the columns from the associated colletion element Otherwise delegates to the usual algorithm
Collection getCollection()
static CollectionBinder getCollectionBinder(String entityName, XProperty property, boolean isIndexed, boolean isHibernateExtensionMapping)
collection binder factory
SecondPass getSecondPass(Ejb3JoinColumn[] fkJoinColumns, Ejb3JoinColumn[] keyColumns, Ejb3JoinColumn[] inverseColumns, Ejb3Column[] elementColumns, Ejb3Column[] mapKeyColumns, Ejb3JoinColumn[] mapKeyManyToManyColumns, boolean isEmbedded, XProperty property, XClass collType, boolean ignoreNotFound, boolean unique, TableBinder assocTableBinder, Mappings mappings)
boolean isMap()
void setAccessType(AccessType accessType)
void setBatchSize(BatchSize batchSize)
void setCache(Cache cacheAnn)
void setCascadeDeleteEnabled(boolean onDeleteCascade)
void setCascadeStrategy(String cascadeStrategy)
void setCollectionType(XClass collectionType)
void setDeclaringClass(XClass declaringClass)
void setEjb3OrderBy(javax.persistence.OrderBy orderByAnn)
void setElementColumns(Ejb3Column[] elementColumns)
void setEmbedded(boolean annotationPresent)
void setExplicitAssociationTable(boolean explicitAssocTable)
void setFkJoinColumns(Ejb3JoinColumn[] ejb3JoinColumns)
void setIgnoreNotFound(boolean ignoreNotFound)
void setIndexColumn(IndexColumn indexColumn)
void setInheritanceStatePerClass(Map<XClass, InheritanceState> inheritanceStatePerClass)
void setInsertable(boolean insertable)
void setInverseJoinColumns(Ejb3JoinColumn[] inverseJoinColumns)
void setIsHibernateExtensionMapping(boolean hibernateExtensionMapping)
void setJoinColumns(Ejb3JoinColumn[] joinColumns)
void setLocalGenerators(HashMap<String, IdGenerator> localGenerators)
void setMapKey(MapKey key)
void setMapKeyColumns(Ejb3Column[] mapKeyColumns)
void setMapKeyManyToManyColumns(Ejb3JoinColumn[] mapJoinColumns)
void setMappedBy(String mappedBy)
void setMappings(Mappings mappings)
void setOneToMany(boolean oneToMany)
void setProperty(XProperty property)
void setPropertyHolder(PropertyHolder propertyHolder)
void setPropertyName(String propertyName)
void setSort(Sort sortAnn)
void setSqlOrderBy(OrderBy orderByAnn)
void setTableBinder(TableBinder tableBinder)
void setTargetEntity(XClass targetEntity)
void setUpdatable(boolean updatable)
Protected Methods
void bindManyToManySecondPass(Collection collValue, Map persistentClasses, Ejb3JoinColumn[] joinColumns, Ejb3JoinColumn[] inverseJoinColumns, Ejb3Column[] elementColumns, boolean isEmbedded, XClass collType, boolean ignoreNotFound, boolean unique, boolean cascadeDeleteEnabled, TableBinder associationTableBinder, XProperty property, PropertyHolder parentPropertyHolder, String hqlOrderBy, Mappings mappings)
void bindOneToManySecondPass(Collection collection, Map persistentClasses, Ejb3JoinColumn[] fkJoinColumns, XClass collectionType, boolean cascadeDeleteEnabled, boolean ignoreNotFound, String hqlOrderBy, Mappings mappings, Map<XClass, InheritanceState> inheritanceStatePerClass)
boolean bindStarToManySecondPass(Map persistentClasses, XClass collType, Ejb3JoinColumn[] fkJoinColumns, Ejb3JoinColumn[] keyColumns, Ejb3JoinColumn[] inverseColumns, Ejb3Column[] elementColumns, boolean isEmbedded, XProperty property, boolean unique, TableBinder associationTableBinder, boolean ignoreNotFound, Mappings mappings)
return true if it's a Fk, false if it's an association table
abstract Collection createCollection(PersistentClass persistentClass)
Mappings getMappings()
boolean isHibernateExtensionMapping()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected boolean cascadeDeleteEnabled

protected Collection collection

protected String hqlOrderBy

protected IndexColumn indexColumn

protected Map<XClass, InheritanceState> inheritanceStatePerClass

protected HashMap<String, IdGenerator> localGenerators

protected String mapKeyPropertyName

protected String propertyName

Protected Constructors

protected CollectionBinder ()

protected CollectionBinder (boolean sorted)

Public Methods

public void bind ()

public static void bindManytoManyInverseFk (PersistentClass referencedEntity, Ejb3JoinColumn[] columns, SimpleValue value, boolean unique, Mappings mappings)

bind the inverse FK of a ManyToMany If we are in a mappedBy case, read the columns from the associated colletion element Otherwise delegates to the usual algorithm

public Collection getCollection ()

public static CollectionBinder getCollectionBinder (String entityName, XProperty property, boolean isIndexed, boolean isHibernateExtensionMapping)

collection binder factory

public SecondPass getSecondPass (Ejb3JoinColumn[] fkJoinColumns, Ejb3JoinColumn[] keyColumns, Ejb3JoinColumn[] inverseColumns, Ejb3Column[] elementColumns, Ejb3Column[] mapKeyColumns, Ejb3JoinColumn[] mapKeyManyToManyColumns, boolean isEmbedded, XProperty property, XClass collType, boolean ignoreNotFound, boolean unique, TableBinder assocTableBinder, Mappings mappings)

public boolean isMap ()

public void setAccessType (AccessType accessType)

public void setBatchSize (BatchSize batchSize)

public void setCache (Cache cacheAnn)

public void setCascadeDeleteEnabled (boolean onDeleteCascade)

public void setCascadeStrategy (String cascadeStrategy)

public void setCollectionType (XClass collectionType)

public void setDeclaringClass (XClass declaringClass)

public void setEjb3OrderBy (javax.persistence.OrderBy orderByAnn)

public void setElementColumns (Ejb3Column[] elementColumns)

public void setEmbedded (boolean annotationPresent)

public void setExplicitAssociationTable (boolean explicitAssocTable)

public void setFkJoinColumns (Ejb3JoinColumn[] ejb3JoinColumns)

public void setIgnoreNotFound (boolean ignoreNotFound)

public void setIndexColumn (IndexColumn indexColumn)

public void setInheritanceStatePerClass (Map<XClass, InheritanceState> inheritanceStatePerClass)

public void setInsertable (boolean insertable)

public void setInverseJoinColumns (Ejb3JoinColumn[] inverseJoinColumns)

public void setIsHibernateExtensionMapping (boolean hibernateExtensionMapping)

public void setJoinColumns (Ejb3JoinColumn[] joinColumns)

public void setLocalGenerators (HashMap<String, IdGenerator> localGenerators)

public void setMapKey (MapKey key)

public void setMapKeyColumns (Ejb3Column[] mapKeyColumns)

public void setMapKeyManyToManyColumns (Ejb3JoinColumn[] mapJoinColumns)

public void setMappedBy (String mappedBy)

public void setMappings (Mappings mappings)

public void setOneToMany (boolean oneToMany)

public void setProperty (XProperty property)

public void setPropertyHolder (PropertyHolder propertyHolder)

public void setPropertyName (String propertyName)

public void setSort (Sort sortAnn)

public void setSqlOrderBy (OrderBy orderByAnn)

public void setTableBinder (TableBinder tableBinder)

public void setTargetEntity (XClass targetEntity)

public void setUpdatable (boolean updatable)

Protected Methods

protected void bindManyToManySecondPass (Collection collValue, Map persistentClasses, Ejb3JoinColumn[] joinColumns, Ejb3JoinColumn[] inverseJoinColumns, Ejb3Column[] elementColumns, boolean isEmbedded, XClass collType, boolean ignoreNotFound, boolean unique, boolean cascadeDeleteEnabled, TableBinder associationTableBinder, XProperty property, PropertyHolder parentPropertyHolder, String hqlOrderBy, Mappings mappings)

Throws
MappingException

protected void bindOneToManySecondPass (Collection collection, Map persistentClasses, Ejb3JoinColumn[] fkJoinColumns, XClass collectionType, boolean cascadeDeleteEnabled, boolean ignoreNotFound, String hqlOrderBy, Mappings mappings, Map<XClass, InheritanceState> inheritanceStatePerClass)

protected boolean bindStarToManySecondPass (Map persistentClasses, XClass collType, Ejb3JoinColumn[] fkJoinColumns, Ejb3JoinColumn[] keyColumns, Ejb3JoinColumn[] inverseColumns, Ejb3Column[] elementColumns, boolean isEmbedded, XProperty property, boolean unique, TableBinder associationTableBinder, boolean ignoreNotFound, Mappings mappings)

return true if it's a Fk, false if it's an association table

protected abstract Collection createCollection (PersistentClass persistentClass)

protected Mappings getMappings ()

protected boolean isHibernateExtensionMapping ()