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

Class CompositeIdentifierSingularAttributeSourceManyToOneImpl

java.lang.Object

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

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

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

All Implemented Interfaces:

AssociationSource, AttributeSource, CascadeStyleSource, ColumnBindingDefaults, FetchableAttributeSource, ForeignKeyContributingSource, RelationalValueSourceContainer, SingularAttributeSource, SingularAttributeSourceManyToOne, SingularAttributeSourceToOne, ToolingHintContextContainer

public class CompositeIdentifierSingularAttributeSourceManyToOneImpl
extends AbstractToOneAttributeSourceImpl
implements SingularAttributeSourceManyToOne, RelationalValueSourceContainer

Descriptor for <key-many-to-one/> mapping

Author:

Steve Ebersole, Gail Badner

Constructor Summary

Constructors

Constructor and Description
CompositeIdentifierSingularAttributeSourceManyToOneImpl(MappingDocument mappingDocument, AttributeSourceContainer container, JaxbHbmCompositeKeyManyToOneType keyManyToOneElement)

Method Summary

Modifier and Type	Method and 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.
AttributePath	getAttributePath()
AttributeRole	getAttributeRole()
String	getCascadeStyleName() Obtain the cascade styles to be applied to this association.
protected String	getClassName()
String	getExplicitForeignKeyName() Retrieve the name of the foreign key as supplied by the user, or null if the user supplied none.
FetchCharacteristicsSingularAssociationImpl	getFetchCharacteristics()
ForeignKeyDirection	getForeignKeyDirection()
String	getName() Obtain the attribute name.
String	getPropertyAccessorName() Obtain the name of the property accessor style used to access this attribute.
String	getReferencedEntityAttributeName()
String	getReferencedEntityName() Obtain the name of the referenced entity.
List<RelationalValueSource>	getRelationalValueSources() Obtain the contained RelationalValueSource references.
SingularAttributeNature	getSingularAttributeNature() Obtain the nature of this attribute type.
XmlElementMetadata	getSourceType()
ToolingHintContext	getToolingHintContext()
HibernateTypeSourceImpl	getTypeInformation() Obtain information about the Hibernate type (Type) for this attribute.
String	getXmlNodeName() Ugh.
boolean	isBytecodeLazy() Should the attribute be lazily loaded by bytecode enhancement?
boolean	isCascadeDeleteEnabled() 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?
Boolean	isEmbedXml()
boolean	isIncludedInOptimisticLocking() If the containing entity is using optimistic locking, should this attribute participate in that locking? Meaning, should changes in the value of this attribute at runtime indicate that the entity is now dirty in terms of optimistic locking?
Boolean	isInsertable() Did the mapping specify that the given attribute value(s) should be inserted into the database?
boolean	isUnique()
Boolean	isUpdatable() Did the mapping specify that the given attribute value(s) should be updated in the database?
boolean	isVirtualAttribute() Determine whether this is a virtual attribute or whether it physically exists on the users domain model.

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

createForeignKeyConstraint, getAttributeSource, getGenerationTiming, getNaturalIdMutability, isIgnoreNotFound, isMappedBy, isSingular

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.SingularAttributeSource

getGenerationTiming, getNaturalIdMutability

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

isSingular

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

createForeignKeyConstraint

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

getAttributeSource, isIgnoreNotFound, isMappedBy

Constructor Detail

CompositeIdentifierSingularAttributeSourceManyToOneImpl

public CompositeIdentifierSingularAttributeSourceManyToOneImpl(MappingDocument mappingDocument,
                                                               AttributeSourceContainer container,
                                                               JaxbHbmCompositeKeyManyToOneType keyManyToOneElement)

Method Detail

getSingularAttributeNature

public SingularAttributeNature getSingularAttributeNature()

Description copied from interface: SingularAttributeSource

Obtain the nature of this attribute type.

Specified by:

getSingularAttributeNature in interface SingularAttributeSource

Returns:

The attribute type nature

isInsertable

public Boolean isInsertable()

Description copied from interface: SingularAttributeSource

Did the mapping specify that the given attribute value(s) should be inserted into the database?

Specified by:

isInsertable in interface SingularAttributeSource

Returns:

true indicates value(s) should be inserted; false indicates not.

isUpdatable

public Boolean isUpdatable()

Description copied from interface: SingularAttributeSource

Did the mapping specify that the given attribute value(s) should be updated in the database?

Specified by:

isUpdatable in interface SingularAttributeSource

Returns:

true indicates value(s) should be updated; false indicates not.

isBytecodeLazy

public boolean isBytecodeLazy()

Description copied from interface: SingularAttributeSource

Should the attribute be lazily loaded by bytecode enhancement?

Specified by:

isBytecodeLazy in interface SingularAttributeSource

Returns:

true to indicate the attribute should be lazily loaded by bytecode enhancement?

getSourceType

public XmlElementMetadata getSourceType()

Specified by:

getSourceType in interface AttributeSource

getName

public String getName()

Description copied from interface: AttributeSource

Obtain the attribute name.

Specified by:

getName in interface AttributeSource

Returns:

The attribute name. null is NOT allowed!

getXmlNodeName

public String getXmlNodeName()

Description copied from interface: AttributeSource

Ugh. This is the deprecated DOM4J entity-mode feature

Specified by:

getXmlNodeName in interface AttributeSource

Returns:

The xml node name

getAttributePath

public AttributePath getAttributePath()

Specified by:

getAttributePath in interface AttributeSource

getTypeInformation

public HibernateTypeSourceImpl getTypeInformation()

Description copied from interface: AttributeSource

Obtain information about the Hibernate type (Type) for this attribute.

Specified by:

getTypeInformation in interface AttributeSource

Returns:

The Hibernate type information

getPropertyAccessorName

public String getPropertyAccessorName()

Description copied from interface: AttributeSource

Obtain the name of the property accessor style used to access this attribute.

Specified by:

getPropertyAccessorName in interface AttributeSource

Returns:

The property accessor style for this attribute.

See Also:

PropertyAccessStrategy

getAttributeRole

public AttributeRole getAttributeRole()

Specified by:

getAttributeRole in interface AttributeSource

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.

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.

isIncludedInOptimisticLocking

public boolean isIncludedInOptimisticLocking()

Description copied from interface: AttributeSource

If the containing entity is using optimistic locking, should this attribute participate in that locking? Meaning, should changes in the value of this attribute at runtime indicate that the entity is now dirty in terms of optimistic locking?

Specified by:

isIncludedInOptimisticLocking in interface AttributeSource

Returns:

true indicates it should be included; false, it should not.

getFetchCharacteristics

public FetchCharacteristicsSingularAssociationImpl getFetchCharacteristics()

Specified by:

getFetchCharacteristics in interface FetchableAttributeSource

Specified by:

getFetchCharacteristics in interface SingularAttributeSourceToOne

isVirtualAttribute

public boolean isVirtualAttribute()

Description copied from interface: SingularAttributeSource

Determine whether this is a virtual attribute or whether it physically exists on the users domain model.

Specified by:

isVirtualAttribute in interface SingularAttributeSource

Overrides:

isVirtualAttribute in class AbstractToOneAttributeSourceImpl

Returns:

true indicates the attribute is virtual, meaning it does NOT exist on the domain model; false indicates the attribute physically exists.

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.

getReferencedEntityAttributeName

public String getReferencedEntityAttributeName()

Specified by:

getReferencedEntityAttributeName in interface SingularAttributeSourceToOne

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 SingularAttributeSourceToOne

Returns:

The name of the referenced entity

isEmbedXml

public Boolean isEmbedXml()

Specified by:

isEmbedXml in interface SingularAttributeSourceToOne

isUnique

public boolean isUnique()

Specified by:

isUnique in interface SingularAttributeSourceToOne

getForeignKeyDirection

public ForeignKeyDirection getForeignKeyDirection()

Specified by:

getForeignKeyDirection in interface SingularAttributeSourceToOne

getCascadeStyleName

public String getCascadeStyleName()

Description copied from interface: CascadeStyleSource

Obtain the cascade styles to be applied to this association.

Specified by:

getCascadeStyleName in interface CascadeStyleSource

Returns:

The cascade styles.

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

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.

getClassName

protected String getClassName()

getToolingHintContext

public ToolingHintContext getToolingHintContext()

Specified by:

getToolingHintContext in interface ToolingHintContextContainer