Top Description Inners Methods
org.hibernate.metamodel.mapping

public Interface CollectionPart

extends ValuedModelPart, Fetchable, JavaTypedExpressible
Known Direct Subinterfaces
org.hibernate.metamodel.mapping.internal.EntityCollectionPart, org.hibernate.metamodel.mapping.CollectionIdentifierDescriptor
Known Direct Implementers
org.hibernate.metamodel.mapping.internal.BasicValuedCollectionPart, org.hibernate.metamodel.mapping.internal.DiscriminatedCollectionPart, org.hibernate.metamodel.mapping.internal.EmbeddedCollectionPart
Imports
org.hibernate.sql.results.graph.Fetchable, org.hibernate.type.descriptor.java.JavaTypedExpressible
Hibernate understands mapping a collection into 4 parts
  1. The key - the foreign-key defining the association to the owner
  2. The element - for Maps this is analogous to the value
  3. The index - the List/array index or Map key
  4. The collection-id - this is only relevant for id-bag mappings
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
CollectionPart.Nature

Method Summary

Modifier and TypeMethod and Description
public default ModelPart
getInclusionCheckPart()

public CollectionPart.Nature
getNature()

public default String
getPartName()

Implements org.hibernate.metamodel.mapping.ModelPart.getPartName.

The local part name, which is generally the unqualified role name
Inherited from org.hibernate.metamodel.mapping.ValuedModelPart:
forEachInsertableforEachNonFormulaforEachSelectableforEachSelectableforEachUpdatablegetContainingTableExpressiongetJdbcTypeCountgetSingleJdbcMapping
Inherited from org.hibernate.sql.results.graph.Fetchable:
asAttributeMappinggenerateFetchgetFetchableKeygetFetchableNamegetMappedFetchOptionsincrementFetchDepthisSelectableresolveCircularFetch
Inherited from org.hibernate.type.descriptor.java.JavaTypedExpressible:
addToCacheKeygetExpressibleJavaType

Method Detail

getInclusionCheckPartback to summary
public default ModelPart getInclusionCheckPart()
getNatureback to summary
public CollectionPart.Nature getNature()
getPartNameback to summary
public default String getPartName()

Implements org.hibernate.metamodel.mapping.ModelPart.getPartName.

Doc from org.hibernate.metamodel.mapping.ModelPart.getPartName.

The local part name, which is generally the unqualified role name

Annotations
@Override
org.hibernate.metamodel.mapping back to summary

public final Enum CollectionPart.Nature

extends Enum<CollectionPart.Nature>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final CollectionPart.Nature
ELEMENT

The Collection element or Map element

public static final CollectionPart.Nature
ID

The identifier for

public static final CollectionPart.Nature
INDEX

The List index or Map key

private final String
name

Hides java.lang.Enum.name.

Constructor Summary

AccessConstructor and Description
private
Nature(String name)

Method Summary

Modifier and TypeMethod and Description
public static CollectionPart.Nature
fromName(String name)

public static CollectionPart.Nature
fromNameExact(String name)

public String
getName()

public static CollectionPart.Nature
valueOf(String name)

public static CollectionPart.Nature[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ELEMENTback to summary
public static final CollectionPart.Nature ELEMENT

The Collection element or Map element

IDback to summary
public static final CollectionPart.Nature ID

The identifier for

INDEXback to summary
public static final CollectionPart.Nature INDEX

The List index or Map key

nameback to summary
private final String name

Hides java.lang.Enum.name.

Constructor Detail

Natureback to summary
private Nature(String name)

Method Detail

fromNameback to summary
public static CollectionPart.Nature fromName(String name)
fromNameExactback to summary
public static CollectionPart.Nature fromNameExact(String name)
getNameback to summary
public String getName()
valueOfback to summary
public static CollectionPart.Nature valueOf(String name)
valuesback to summary
public static CollectionPart.Nature[] values()