org.hibernate.boot.model.source.spi

Interface SingularAttributeSource

All Superinterfaces:

AttributeSource, ToolingHintContextContainer

All Known Subinterfaces:

SingularAttributeSourceAny, SingularAttributeSourceBasic, SingularAttributeSourceEmbedded, SingularAttributeSourceManyToOne, SingularAttributeSourceOneToOne, SingularAttributeSourceToOne, VersionAttributeSource

All Known Implementing Classes:

AbstractSingularAttributeSourceEmbeddedImpl, AbstractToOneAttributeSourceImpl, CompositeIdentifierSingularAttributeSourceBasicImpl, CompositeIdentifierSingularAttributeSourceManyToOneImpl, SingularAttributeSourceAnyImpl

public interface SingularAttributeSource
extends AttributeSource

Source-agnostic description of information needed to bind a singular attribute.

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
GenerationTiming	getGenerationTiming() Obtain a description of if/when the attribute value is generated by the database.
NaturalIdMutability	getNaturalIdMutability() Retrieve the natural id mutability
SingularAttributeNature	getSingularAttributeNature() Obtain the nature of this attribute type.
boolean	isBytecodeLazy() Should the attribute be lazily loaded by bytecode enhancement?
Boolean	isInsertable() Did the mapping specify that the given attribute value(s) should be inserted into the database?
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 interface org.hibernate.boot.model.source.spi.AttributeSource

getAttributePath, getAttributeRole, getName, getPropertyAccessorName, getSourceType, getTypeInformation, getXmlNodeName, isIncludedInOptimisticLocking, isSingular

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

getToolingHintContext

Method Detail

isVirtualAttribute

boolean isVirtualAttribute()

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

Returns:

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

getSingularAttributeNature

SingularAttributeNature getSingularAttributeNature()

Obtain the nature of this attribute type.

Returns:

The attribute type nature

getGenerationTiming

GenerationTiming getGenerationTiming()

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

Returns:

The attribute value generation information

isInsertable

Boolean isInsertable()

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

Returns:

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

isUpdatable

Boolean isUpdatable()

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

Returns:

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

isBytecodeLazy

boolean isBytecodeLazy()

Should the attribute be lazily loaded by bytecode enhancement?

Returns:

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

getNaturalIdMutability

NaturalIdMutability getNaturalIdMutability()

Retrieve the natural id mutability

Returns:

The mutability, see enum for meanings