Top Description Fields Constructors Methods
org.hibernate.mapping

public abstract Class Collection

extends Object
implements Fetchable, Value, Filterable, SoftDeletable
Class Inheritance
All Implemented Interfaces
org.hibernate.mapping.SoftDeletable, org.hibernate.mapping.Filterable, org.hibernate.mapping.Value, java.io.Serializable, org.hibernate.mapping.Fetchable
Known Direct Subclasses
org.hibernate.mapping.IdentifierCollection, org.hibernate.mapping.IndexedCollection, org.hibernate.mapping.Set, org.hibernate.mapping.Bag
Imports
java.util.ArrayList, .Collections, .Comparator, .HashSet, .Iterator, .List, .Objects, .Properties, java.util.function.Supplier, org.hibernate.FetchMode, .MappingException, org.hibernate.boot.registry.classloading.spi.ClassLoaderService, org.hibernate.boot.spi.MetadataBuildingContext, .MetadataImplementor, org.hibernate.collection.internal.CustomCollectionTypeSemantics, org.hibernate.collection.spi.CollectionSemantics, org.hibernate.engine.spi.ExecuteUpdateResultCheckStyle, .Mapping, org.hibernate.internal.FilterConfiguration, org.hibernate.internal.util.StringHelper, org.hibernate.internal.util.collections.ArrayHelper, org.hibernate.persister.collection.CollectionPersister, org.hibernate.resource.beans.spi.ManagedBean, org.hibernate.service.ServiceRegistry, org.hibernate.type.CollectionType, .CustomCollectionType, .Type, org.hibernate.usertype.UserCollectionType
A mapping model object representing a collection. Subclasses specialize to particular kinds of collection.
Author
Gavin King

Field Summary

Modifier and TypeField and Description
private int
batchSize

private final MetadataBuildingContext
buildingContext

private String
cacheConcurrencyStrategy

private CollectionSemantics<?, ?>
cachedCollectionSemantics

private CollectionType
cachedCollectionType

private String
cacheRegionName

private Class<? extends CollectionPersister>
collectionPersisterClass

private Table
collectionTable

private Comparator<?>
comparator

private String
comparatorClassName

private boolean
customDeleteAllCallable

private boolean
customDeleteCallable

private boolean
customInsertCallable

private String
customSQLDelete

private String
customSQLDeleteAll

private String
customSQLInsert

private String
customSQLUpdate

private Supplier<ManagedBean<? extends UserCollectionType>>
customTypeBeanResolver

private boolean
customUpdateCallable

public static final String
DEFAULT_ELEMENT_COLUMN_NAME

public static final String
DEFAULT_KEY_COLUMN_NAME

private ExecuteUpdateResultCheckStyle
deleteAllCheckStyle

private ExecuteUpdateResultCheckStyle
deleteCheckStyle

private Value
element

private boolean
extraLazy

private FetchMode
fetchMode

private final List<FilterConfiguration>
filters

private ExecuteUpdateResultCheckStyle
insertCheckStyle

private boolean
inverse

private KeyValue
key

private boolean
lazy

private String
loaderName

private final List<FilterConfiguration>
manyToManyFilters

private String
manyToManyOrderBy

private String
manyToManyWhere

private String
mappedByProperty

private boolean
mutable

private boolean
optimisticLocked

private String
orderBy

private boolean
orphanDelete

private final PersistentClass
owner

private String
referencedPropertyName

private String
role

private Column
softDeleteColumn

private boolean
sorted

private boolean
subselectLoadable

private final Set<String>
synchronizedTables

private String
typeName

private Properties
typeParameters

private ExecuteUpdateResultCheckStyle
updateCheckStyle

private String
where

Constructor Summary

AccessConstructor and Description
protected
Collection(MetadataBuildingContext buildingContext, PersistentClass owner)

hbm.xml binding

protected
Collection(Supplier<ManagedBean<? extends UserCollectionType>> customTypeBeanResolver, PersistentClass owner, MetadataBuildingContext buildingContext)

Annotation binding

protected
Collection(Collection original)

Method Summary

Modifier and TypeMethod and Description
public void
addFilter(String name, String condition, boolean autoAliasInjection, Map<String, String> aliasTableMap, Map<String, String> aliasEntityMap)

Implements org.hibernate.mapping.Filterable.addFilter.

public void
addManyToManyFilter(String name, String condition, boolean autoAliasInjection, Map<String, String> aliasTableMap, Map<String, String> aliasEntityMap)

public void
addSynchronizedTable(String table)

private void
checkColumnDuplication()

public void
createAllKeys()

public void
createForeignKey()

Implements org.hibernate.mapping.Value.createForeignKey.

private void
createForeignKeys()

pack-priv abstract void
createPrimaryKey()

public void
createUniqueKey()

Implements org.hibernate.mapping.Value.createUniqueKey.

public void
enableSoftDelete(Column indicatorColumn)

Implements org.hibernate.mapping.SoftDeletable.enableSoftDelete.

public int
getBatchSize()

public MetadataBuildingContext
getBuildingContext()

Overrides default org.hibernate.mapping.Value.getBuildingContext.

public String
getCacheConcurrencyStrategy()

public String
getCacheRegionName()

public Class<? extends CollectionPersister>
getCollectionPersisterClass()

public CollectionSemantics<?, ?>
getCollectionSemantics()

public Table
getCollectionTable()

public CollectionType
getCollectionType()

public boolean[]
getColumnInsertability()

Implements org.hibernate.mapping.Value.getColumnInsertability.

public List<Column>
getColumns()

Implements org.hibernate.mapping.Value.getColumns.

If the mapping involves only columns, return them.
public int
getColumnSpan()

Implements org.hibernate.mapping.Value.getColumnSpan.

The number of columns and formulas in the mapping.
public boolean[]
getColumnUpdateability()

Implements org.hibernate.mapping.Value.getColumnUpdateability.

public Comparator<?>
getComparator()

public String
getComparatorClassName()

public String
getCustomSQLDelete()

public String
getCustomSQLDeleteAll()

public ExecuteUpdateResultCheckStyle
getCustomSQLDeleteAllCheckStyle()

public ExecuteUpdateResultCheckStyle
getCustomSQLDeleteCheckStyle()

public String
getCustomSQLInsert()

public ExecuteUpdateResultCheckStyle
getCustomSQLInsertCheckStyle()

public String
getCustomSQLUpdate()

public ExecuteUpdateResultCheckStyle
getCustomSQLUpdateCheckStyle()

public abstract CollectionType
getDefaultCollectionType()

public Value
getElement()

public FetchMode
getFetchMode()

Implements org.hibernate.mapping.Fetchable.getFetchMode, org.hibernate.mapping.Value.getFetchMode.

public List<FilterConfiguration>
getFilters()

Implements org.hibernate.mapping.Filterable.getFilters.

public KeyValue
getKey()

public String
getLoaderName()

public List<FilterConfiguration>
getManyToManyFilters()

public String
getManyToManyOrdering()

public String
getManyToManyWhere()

public String
getMappedByProperty()

public MetadataImplementor
getMetadata()

Deprecated as a consequence of MetadataImplementor being deprecated.
public String
getOrderBy()

public PersistentClass
getOwner()

public String
getOwnerEntityName()

public String
getReferencedPropertyName()

public String
getRole()

public List<Selectable>
getSelectables()

Implements org.hibernate.mapping.Value.getSelectables.

The mapping to columns and formulas.
public ServiceRegistry
getServiceRegistry()

Implements org.hibernate.mapping.Value.getServiceRegistry.

public Column
getSoftDeleteColumn()

Implements org.hibernate.mapping.SoftDeletable.getSoftDeleteColumn.

public Set<String>
getSynchronizedTables()

public Table
getTable()

Implements org.hibernate.mapping.Value.getTable.

public Type
getType()

Implements org.hibernate.mapping.Value.getType.

public String
getTypeName()

public Properties
getTypeParameters()

public String
getWhere()

public boolean
hasAnyInsertableColumns()

Implements org.hibernate.mapping.Value.hasAnyInsertableColumns.

public boolean
hasAnyUpdatableColumns()

Implements org.hibernate.mapping.Value.hasAnyUpdatableColumns.

public boolean
hasFormula()

Implements org.hibernate.mapping.Value.hasFormula.

public boolean
hasOrder()

public boolean
hasOrphanDelete()

public boolean
isAlternateUniqueKey()

Implements org.hibernate.mapping.Value.isAlternateUniqueKey.

public boolean
isArray()

public boolean
isColumnInsertable(int index)

Implements org.hibernate.mapping.Value.isColumnInsertable.

public boolean
isColumnUpdateable(int index)

Implements org.hibernate.mapping.Value.isColumnUpdateable.

public boolean
isCustomDeleteAllCallable()

public boolean
isCustomDeleteCallable()

public boolean
isCustomInsertCallable()

public boolean
isCustomUpdateCallable()

public boolean
isExtraLazy()

public boolean
isIdentified()

public boolean
isIndexed()

public boolean
isInverse()

public boolean
isLazy()

Implements org.hibernate.mapping.Fetchable.isLazy.

public boolean
isMap()

public boolean
isMutable()

public boolean
isNullable()

Implements org.hibernate.mapping.Value.isNullable.

public boolean
isOneToMany()

public boolean
isOptimisticLocked()

public boolean
isPrimitiveArray()

public boolean
isSame(Value other)

Implements org.hibernate.mapping.Value.isSame.

protected static boolean
isSame(Value v1, Value v2)

public boolean
isSame(Collection other)

public boolean
isSet()

public boolean
isSimpleValue()

Implements org.hibernate.mapping.Value.isSimpleValue.

public boolean
isSorted()

public boolean
isSubselectLoadable()

public boolean
isValid(Mapping mapping)

Implements org.hibernate.mapping.Value.isValid.

Deprecated as a consequence of Mapping being deprecated.
private CollectionSemantics<?, ?>
resolveCollectionSemantics()

private CollectionType
resolveCollectionType()

public void
setBatchSize(int i)

public void
setCacheConcurrencyStrategy(String cacheConcurrencyStrategy)

public void
setCacheRegionName(String cacheRegionName)

public void
setCollectionPersisterClass(Class<? extends CollectionPersister> persister)

public void
setCollectionTable(Table table)

public void
setComparator(Comparator<T> comparator)

public void
setComparatorClassName(String comparatorClassName)

public void
setCustomSQLDelete(String customSQLDelete, boolean callable, ExecuteUpdateResultCheckStyle checkStyle)

public void
setCustomSQLDeleteAll(String customSQLDeleteAll, boolean callable, ExecuteUpdateResultCheckStyle checkStyle)

public void
setCustomSQLInsert(String customSQLInsert, boolean callable, ExecuteUpdateResultCheckStyle checkStyle)

public void
setCustomSQLUpdate(String customSQLUpdate, boolean callable, ExecuteUpdateResultCheckStyle checkStyle)

public void
setElement(Value element)

public void
setExtraLazy(boolean extraLazy)

public void
setFetchMode(FetchMode fetchMode)

Implements org.hibernate.mapping.Fetchable.setFetchMode.

public void
setInverse(boolean inverse)

public void
setKey(KeyValue key)

public void
setLazy(boolean lazy)

Implements org.hibernate.mapping.Fetchable.setLazy.

public void
setLoaderName(String name)

public void
setManyToManyOrdering(String orderFragment)

public void
setManyToManyWhere(String manyToManyWhere)

public void
setMappedByProperty(String mappedByProperty)

public void
setMutable(boolean mutable)

public void
setOptimisticLocked(boolean optimisticLocked)

public void
setOrderBy(String orderBy)

public void
setOrphanDelete(boolean orphanDelete)

public void
setReferencedPropertyName(String propertyRef)

public void
setRole(String role)

public void
setSorted(boolean sorted)

public void
setSubselectLoadable(boolean subqueryLoadable)

public void
setTypeName(String typeName)

public void
setTypeParameters(Properties parameterMap)

public void
setTypeParameters(Map<K, V> parameterMap)

public void
setTypeUsingReflection(String className, String propertyName)

Implements org.hibernate.mapping.Value.setTypeUsingReflection.

public void
setWhere(String where)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public void
validate(Mapping mapping)

Deprecated as a consequence of Mapping being deprecated.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait