Package org.hibernate.boot.model.source.internal.hbm

Class PluralAttributeElementSourceManyToManyImpl

java.lang.Object

org.hibernate.boot.model.source.internal.hbm.AbstractHbmSourceNode

org.hibernate.boot.model.source.internal.hbm.AbstractPluralAssociationElementSourceImpl

org.hibernate.boot.model.source.internal.hbm.PluralAttributeElementSourceManyToManyImpl

All Implemented Interfaces:

AssociationSource, ColumnBindingDefaults, ForeignKeyContributingSource, Orderable, PluralAttributeElementSource, PluralAttributeElementSourceAssociation, PluralAttributeElementSourceManyToMany, RelationalValueSourceContainer

public class PluralAttributeElementSourceManyToManyImpl
extends AbstractPluralAssociationElementSourceImpl
implements PluralAttributeElementSourceManyToMany

Author:

Steve Ebersole, Gail Badner

Constructor Summary

Constructors

Constructor	Description
PluralAttributeElementSourceManyToManyImpl(MappingDocument mappingDocument, PluralAttributeSource pluralAttributeSource, JaxbHbmManyToManyCollectionElementType jaxbManyToManyElement)

Method Summary

Modifier and Type	Method	Description
boolean	areValuesIncludedInInsertByDefault()	How should non-specification of value insertion by the individual value sources here be interpreted in terms of defaulting that value.
boolean	areValuesIncludedInUpdateByDefault()	How should non-specification of value updating by the individual value sources here be interpreted in terms of defaulting that value.
boolean	areValuesNullableByDefault()	How should non-specification of value nullability by the individual value sources here be interpreted in terms of defaulting that value.
boolean	createForeignKeyConstraint()	Primarily exists to support JPA's @ForeignKey(NO_CONSTRAINT).
String	getExplicitForeignKeyName()	Retrieve the name of the foreign key as supplied by the user, or null if the user supplied none.
FetchCharacteristics	getFetchCharacteristics()
FilterSource[]	getFilterSources()
PluralAttributeElementNature	getNature()
String	getOrder()	The order by clause used during loading this plural attribute.
String	getReferencedEntityAttributeName()
String	getReferencedEntityName()	Obtain the name of the referenced entity.
List<RelationalValueSource>	getRelationalValueSources()	Obtain the contained RelationalValueSource references.
String	getWhere()
boolean	isCascadeDeleteEnabled()	Is "cascade delete" enabled for the foreign key?
boolean	isIgnoreNotFound()
boolean	isOrdered()	If the source of plural attribute is supposed to be applied the ORDER BY when loading.
boolean	isUnique()

Methods inherited from class org.hibernate.boot.model.source.internal.hbm.AbstractPluralAssociationElementSourceImpl

getAttributeSource, isMappedBy

Methods inherited from class org.hibernate.boot.model.source.internal.hbm.AbstractHbmSourceNode

mappingRoot, metadataBuildingContext, origin, sourceMappingDocument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.boot.model.source.spi.AssociationSource

getAttributeSource, isMappedBy

Constructor Details

PluralAttributeElementSourceManyToManyImpl

public PluralAttributeElementSourceManyToManyImpl(MappingDocument mappingDocument,
 PluralAttributeSource pluralAttributeSource,
 JaxbHbmManyToManyCollectionElementType jaxbManyToManyElement)

Method Details

getNature

public PluralAttributeElementNature getNature()

Specified by:

getNature in interface PluralAttributeElementSource

getReferencedEntityName

public String getReferencedEntityName()

Description copied from interface: AssociationSource

Obtain the name of the referenced entity.

Specified by:

getReferencedEntityName in interface AssociationSource

Specified by:

getReferencedEntityName in interface PluralAttributeElementSourceManyToMany

Returns:

The name of the referenced entity

getFilterSources

public FilterSource[] getFilterSources()

Specified by:

getFilterSources in interface PluralAttributeElementSourceManyToMany

getReferencedEntityAttributeName

public String getReferencedEntityAttributeName()

Specified by:

getReferencedEntityAttributeName in interface PluralAttributeElementSourceManyToMany

getRelationalValueSources

public List<RelationalValueSource> getRelationalValueSources()

Description copied from interface: RelationalValueSourceContainer

Obtain the contained RelationalValueSource references.

Specified by:

getRelationalValueSources in interface RelationalValueSourceContainer

Returns:

The contained RelationalValueSource references.

isIgnoreNotFound

public boolean isIgnoreNotFound()

Specified by:

isIgnoreNotFound in interface AssociationSource

Specified by:

isIgnoreNotFound in interface PluralAttributeElementSourceManyToMany

getExplicitForeignKeyName

public String getExplicitForeignKeyName()

Description copied from interface: ForeignKeyContributingSource

Retrieve the name of the foreign key as supplied by the user, or null if the user supplied none.

Specified by:

getExplicitForeignKeyName in interface ForeignKeyContributingSource

Specified by:

getExplicitForeignKeyName in interface PluralAttributeElementSourceManyToMany

Returns:

The user supplied foreign key name.

isCascadeDeleteEnabled

public boolean isCascadeDeleteEnabled()

Description copied from interface: ForeignKeyContributingSource

Is "cascade delete" enabled for the foreign key? In other words, if a record in the parent (referenced) table is deleted, should the corresponding records in the child table automatically be deleted?

Specified by:

isCascadeDeleteEnabled in interface ForeignKeyContributingSource

Returns:

true, if the cascade delete is enabled; false, otherwise.

isUnique

public boolean isUnique()

Specified by:

isUnique in interface PluralAttributeElementSourceManyToMany

getWhere

public String getWhere()

Specified by:

getWhere in interface PluralAttributeElementSourceManyToMany

getFetchCharacteristics

public FetchCharacteristics getFetchCharacteristics()

Specified by:

getFetchCharacteristics in interface PluralAttributeElementSourceManyToMany

areValuesIncludedInInsertByDefault

public boolean areValuesIncludedInInsertByDefault()

Description copied from interface: ColumnBindingDefaults

How should non-specification of value insertion by the individual value sources here be interpreted in terms of defaulting that value.

Specified by:

areValuesIncludedInInsertByDefault in interface ColumnBindingDefaults

Returns:

true Indicates that insertions are enabled by default for all value sources which do not explicitly specify.

areValuesIncludedInUpdateByDefault

public boolean areValuesIncludedInUpdateByDefault()

Description copied from interface: ColumnBindingDefaults

How should non-specification of value updating by the individual value sources here be interpreted in terms of defaulting that value.

Specified by:

areValuesIncludedInUpdateByDefault in interface ColumnBindingDefaults

Returns:

true Indicates that updates are enabled by default for all value sources which do not explicitly specify.

areValuesNullableByDefault

public boolean areValuesNullableByDefault()

Description copied from interface: ColumnBindingDefaults

How should non-specification of value nullability by the individual value sources here be interpreted in terms of defaulting that value.

Specified by:

areValuesNullableByDefault in interface ColumnBindingDefaults

Returns:

true Indicates that insertions are enabled by default for all value sources which do not explicitly specify.

isOrdered

public boolean isOrdered()

Description copied from interface: Orderable

If the source of plural attribute is supposed to be applied the ORDER BY when loading.

Specified by:

isOrdered in interface Orderable

Returns:

true indicates to apply the ORDER BY; false means not.

getOrder

public String getOrder()

Description copied from interface: Orderable

The order by clause used during loading this plural attribute.

If the ordering element is not specified, ordering by the primary key of the associated entity is assumed

Specified by:

getOrder in interface Orderable

Returns:

The ORDER BY fragment used during loading this plural attribute from DB.

See Also:

• OrderBy.value()

createForeignKeyConstraint

public boolean createForeignKeyConstraint()

Description copied from interface: ForeignKeyContributingSource

Primarily exists to support JPA's @ForeignKey(NO_CONSTRAINT).

Specified by:

createForeignKeyConstraint in interface ForeignKeyContributingSource

Returns:

true if the FK constraint should be created, false if not.