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

Class CompositeIdentifierSingularAttributeSourceBasicImpl

java.lang.Object

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

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

All Implemented Interfaces:

ImplicitBasicColumnNameSource, ImplicitNameSource, AttributeSource, ColumnBindingDefaults, RelationalValueSourceContainer, SingularAttributeSource, SingularAttributeSourceBasic, ToolingHintContextContainer

public class CompositeIdentifierSingularAttributeSourceBasicImpl
extends AbstractHbmSourceNode
implements SingularAttributeSourceBasic

Descriptor for <key-property/>

Constructor Summary

Constructors

Constructor	Description
CompositeIdentifierSingularAttributeSourceBasicImpl(MappingDocument mappingDocument, AttributeSourceContainer container, JaxbHbmCompositeKeyBasicAttributeType keyPropertyElement)

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.
AttributePath	getAttributePath()	Access to the AttributePath for the basic value
AttributeRole	getAttributeRole()
MetadataBuildingContext	getBuildingContext()	Access to the current building context.
GenerationTiming	getGenerationTiming()	Obtain a description of if/when the attribute value is generated by the database.
String	getName()	Obtain the attribute name.
NaturalIdMutability	getNaturalIdMutability()	Retrieve the natural id mutability
String	getPropertyAccessorName()	Obtain the name of the property accessor style used to access this attribute.
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()	This is only useful to log warnings when these deprecated attributes are populated.
boolean	isBytecodeLazy()	Should the attribute be lazily loaded by bytecode enhancement?
boolean	isCollectionElement()	Is the basic column the "element column" for a collection?
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	isSingular()	Attributes are (coarsely speaking) either singular or plural.
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.AbstractHbmSourceNode

mappingRoot, metadataBuildingContext, origin, sourceMappingDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeIdentifierSingularAttributeSourceBasicImpl

public CompositeIdentifierSingularAttributeSourceBasicImpl(MappingDocument mappingDocument,
                                                           AttributeSourceContainer container,
                                                           JaxbHbmCompositeKeyBasicAttributeType keyPropertyElement)

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

getSourceType

public XmlElementMetadata getSourceType()

Specified by:

getSourceType in interface AttributeSource

isSingular

public boolean isSingular()

Description copied from interface: AttributeSource

Attributes are (coarsely speaking) either singular or plural.

Specified by:

isSingular in interface AttributeSource

Returns:

true indicates the attribute is singular (and therefore castable to SingularAttributeSource); false indicates it is plural (and therefore castable to PluralAttributeSource).

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

This is only useful to log warnings when these deprecated attributes are populated. It was only useful for DOM4J entity-mode, which was removed a long time ago.

Specified by:

getXmlNodeName in interface AttributeSource

Returns:

The xml node name

getAttributePath

public AttributePath getAttributePath()

Description copied from interface: ImplicitBasicColumnNameSource

Access to the AttributePath for the basic value

Specified by:

getAttributePath in interface AttributeSource

Specified by:

getAttributePath in interface ImplicitBasicColumnNameSource

Returns:

The AttributePath for the basic value

isCollectionElement

public boolean isCollectionElement()

Description copied from interface: ImplicitBasicColumnNameSource

Is the basic column the "element column" for a collection?

Historical handling for these in hbm.xml binding was to simply name the column "elt".

Specified by:

isCollectionElement in interface ImplicitBasicColumnNameSource

Returns:

true if the column being named is the collection element column; false otherwise.

getAttributeRole

public AttributeRole getAttributeRole()

Specified by:

getAttributeRole 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

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

Returns:

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

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.

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.

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.

getGenerationTiming

public GenerationTiming getGenerationTiming()

Description copied from interface: SingularAttributeSource

Obtain a description of if/when the attribute value is generated by the database.

Specified by:

getGenerationTiming in interface SingularAttributeSource

Returns:

The attribute value generation information

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?

getNaturalIdMutability

public NaturalIdMutability getNaturalIdMutability()

Description copied from interface: SingularAttributeSource

Retrieve the natural id mutability

Specified by:

getNaturalIdMutability in interface SingularAttributeSource

Returns:

The mutability, see enum for meanings

getToolingHintContext

public ToolingHintContext getToolingHintContext()

Specified by:

getToolingHintContext in interface ToolingHintContextContainer

getBuildingContext

public MetadataBuildingContext getBuildingContext()

Description copied from interface: ImplicitNameSource

Access to the current building context.

Specified by:

getBuildingContext in interface ImplicitNameSource

Returns:

The building context