Top Description Fields Constructors Methods
org.hibernate.boot.model.source.internal.hbm

pack-priv Class VersionAttributeSourceImpl

extends AbstractHbmSourceNode
implements VersionAttributeSource
Class Inheritance
All Implemented Interfaces
org.hibernate.boot.model.source.spi.VersionAttributeSource, org.hibernate.boot.model.naming.ImplicitBasicColumnNameSource, org.hibernate.boot.model.naming.ImplicitNameSource, org.hibernate.boot.model.source.spi.RelationalValueSourceContainer, org.hibernate.boot.model.source.spi.ColumnBindingDefaults, org.hibernate.boot.model.source.spi.SingularAttributeSource, org.hibernate.boot.model.source.spi.AttributeSource, org.hibernate.boot.model.source.spi.ToolingHintContextContainer
Imports
java.util.List, org.hibernate.boot.jaxb.hbm.spi.JaxbHbmTimestampSourceEnum, .JaxbHbmVersionAttributeType, org.hibernate.boot.model.source.spi.AttributePath, .AttributeRole, .NaturalIdMutability, .RelationalValueSource, .SingularAttributeNature, .ToolingHintContext, .VersionAttributeSource, org.hibernate.boot.spi.MetadataBuildingContext, org.hibernate.tuple.GenerationTiming
Implementation for <version/> mappings
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final AttributePath
attributePath

private final AttributeRole
attributeRole

private final List<RelationalValueSource>
relationalValueSources

private final ToolingHintContext
toolingHints

private final HibernateTypeSourceImpl
typeSource

private final JaxbHbmVersionAttributeType
versionElement

Constructor Summary

AccessConstructor and Description
pack-priv
VersionAttributeSourceImpl(MappingDocument mappingDocument, RootEntitySourceImpl rootEntitySource, JaxbHbmVersionAttributeType versionElement)

Method Summary

Modifier and TypeMethod and Description
public boolean
areValuesIncludedInInsertByDefault()

Implements org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesIncludedInInsertByDefault.

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

Implements org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesIncludedInUpdateByDefault.

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

Implements org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesNullableByDefault.

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

Implements org.hibernate.boot.model.source.spi.AttributeSource.getAttributePath, org.hibernate.boot.model.naming.ImplicitBasicColumnNameSource.getAttributePath.

Access to the AttributePath for the basic value
public AttributeRole
getAttributeRole()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getAttributeRole.

public MetadataBuildingContext
getBuildingContext()

Implements org.hibernate.boot.model.naming.ImplicitNameSource.getBuildingContext.

Access to the current building context.
public GenerationTiming
getGenerationTiming()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.getGenerationTiming.

Deprecated as a consequence of GenerationTiming being deprecated.
Obtain a description of if/when the attribute value is generated by the database.
public String
getName()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getName.

Obtain the attribute name.
public NaturalIdMutability
getNaturalIdMutability()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.getNaturalIdMutability.

Retrieve the natural id mutability
public String
getPropertyAccessorName()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getPropertyAccessorName.

Obtain the name of the property accessor style used to access this attribute.
public List<RelationalValueSource>
getRelationalValueSources()

Implements org.hibernate.boot.model.source.spi.RelationalValueSourceContainer.getRelationalValueSources.

Obtain the contained RelationalValueSource references.
public SingularAttributeNature
getSingularAttributeNature()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.getSingularAttributeNature.

Obtain the nature of this attribute type.
public String
getSource()

Implements org.hibernate.boot.model.source.spi.VersionAttributeSource.getSource.

public XmlElementMetadata
getSourceType()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getSourceType.

public ToolingHintContext
getToolingHintContext()

Implements org.hibernate.boot.model.source.spi.ToolingHintContextContainer.getToolingHintContext.

public HibernateTypeSourceImpl
getTypeInformation()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getTypeInformation.

Obtain information about the Hibernate type (org.hibernate.type.Type) for this attribute.
public String
getUnsavedValue()

Implements org.hibernate.boot.model.source.spi.VersionAttributeSource.getUnsavedValue.

public String
getXmlNodeName()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getXmlNodeName.

This is only useful to log warnings when these deprecated attributes are populated.
public boolean
isBytecodeLazy()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.isBytecodeLazy.

Should the attribute be lazily loaded by bytecode enhancement?
public boolean
isCollectionElement()

Implements org.hibernate.boot.model.naming.ImplicitBasicColumnNameSource.isCollectionElement.

Is the basic column the "element column" for a collection?
public boolean
isIncludedInOptimisticLocking()

Implements org.hibernate.boot.model.source.spi.AttributeSource.isIncludedInOptimisticLocking.

If the containing entity is using optimistic locking, should this attribute participate in that locking?
public Boolean
isInsertable()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.isInsertable.

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

Implements org.hibernate.boot.model.source.spi.AttributeSource.isSingular.

Attributes are (coarsely speaking) either singular or plural.
public Boolean
isUpdatable()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.isUpdatable.

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

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.isVirtualAttribute.

Determine whether this is a virtual attribute or whether it physically exists on the users domain model.
Inherited from org.hibernate.boot.model.source.internal.hbm.AbstractHbmSourceNode:
mappingRootmetadataBuildingContextoriginsourceMappingDocument

Field Detail

attributePathback to summary
private final AttributePath attributePath
attributeRoleback to summary
private final AttributeRole attributeRole
relationalValueSourcesback to summary
private final List<RelationalValueSource> relationalValueSources
toolingHintsback to summary
private final ToolingHintContext toolingHints
typeSourceback to summary
private final HibernateTypeSourceImpl typeSource
versionElementback to summary
private final JaxbHbmVersionAttributeType versionElement

Constructor Detail

VersionAttributeSourceImplback to summary
pack-priv VersionAttributeSourceImpl(MappingDocument mappingDocument, RootEntitySourceImpl rootEntitySource, JaxbHbmVersionAttributeType versionElement)

Method Detail

areValuesIncludedInInsertByDefaultback to summary
public boolean areValuesIncludedInInsertByDefault()

Implements org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesIncludedInInsertByDefault.

Doc from org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesIncludedInInsertByDefault.

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

Returns:boolean

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

Annotations
@Override
areValuesIncludedInUpdateByDefaultback to summary
public boolean areValuesIncludedInUpdateByDefault()

Implements org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesIncludedInUpdateByDefault.

Doc from org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesIncludedInUpdateByDefault.

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

Returns:boolean

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

Annotations
@Override
areValuesNullableByDefaultback to summary
public boolean areValuesNullableByDefault()

Implements org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesNullableByDefault.

Doc from org.hibernate.boot.model.source.spi.ColumnBindingDefaults.areValuesNullableByDefault.

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

Returns:boolean

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

Annotations
@Override
getAttributePathback to summary
public AttributePath getAttributePath()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getAttributePath, org.hibernate.boot.model.naming.ImplicitBasicColumnNameSource.getAttributePath.

Doc from org.hibernate.boot.model.naming.ImplicitBasicColumnNameSource.getAttributePath.

Access to the AttributePath for the basic value

Returns:AttributePath

The AttributePath for the basic value

Annotations
@Override
getAttributeRoleback to summary
public AttributeRole getAttributeRole()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getAttributeRole.

Annotations
@Override
getBuildingContextback to summary
public MetadataBuildingContext getBuildingContext()

Implements org.hibernate.boot.model.naming.ImplicitNameSource.getBuildingContext.

Doc from org.hibernate.boot.model.naming.ImplicitNameSource.getBuildingContext.

Access to the current building context.

Returns:MetadataBuildingContext

The building context

Annotations
@Override
getGenerationTimingback to summary
public GenerationTiming getGenerationTiming()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.getGenerationTiming.

Doc from org.hibernate.boot.model.source.spi.SingularAttributeSource.getGenerationTiming.

Deprecated

as a consequence of GenerationTiming being deprecated. See corresponding docs for further information.

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

Returns:GenerationTiming

The attribute value generation information

Annotations
@Override
getNameback to summary
public String getName()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getName.

Doc from org.hibernate.boot.model.source.spi.AttributeSource.getName.

Obtain the attribute name.

Returns:String

The attribute name. null is NOT allowed!

Annotations
@Override
getNaturalIdMutabilityback to summary
public NaturalIdMutability getNaturalIdMutability()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.getNaturalIdMutability.

Doc from org.hibernate.boot.model.source.spi.SingularAttributeSource.getNaturalIdMutability.

Retrieve the natural id mutability

Returns:NaturalIdMutability

The mutability, see enum for meanings

Annotations
@Override
getPropertyAccessorNameback to summary
public String getPropertyAccessorName()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getPropertyAccessorName.

Doc from org.hibernate.boot.model.source.spi.AttributeSource.getPropertyAccessorName.

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

Returns:String

The property accessor style for this attribute.

Annotations
@Override
getRelationalValueSourcesback to summary
public List<RelationalValueSource> getRelationalValueSources()

Implements org.hibernate.boot.model.source.spi.RelationalValueSourceContainer.getRelationalValueSources.

Doc from org.hibernate.boot.model.source.spi.RelationalValueSourceContainer.getRelationalValueSources.

Obtain the contained RelationalValueSource references.

Returns:List<RelationalValueSource>

The contained RelationalValueSource references.

Annotations
@Override
getSingularAttributeNatureback to summary
public SingularAttributeNature getSingularAttributeNature()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.getSingularAttributeNature.

Doc from org.hibernate.boot.model.source.spi.SingularAttributeSource.getSingularAttributeNature.

Obtain the nature of this attribute type.

Returns:SingularAttributeNature

The attribute type nature

Annotations
@Override
getSourceback to summary
public String getSource()

Implements org.hibernate.boot.model.source.spi.VersionAttributeSource.getSource.

Annotations
@Override
getSourceTypeback to summary
public XmlElementMetadata getSourceType()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getSourceType.

Annotations
@Override
getToolingHintContextback to summary
public ToolingHintContext getToolingHintContext()

Implements org.hibernate.boot.model.source.spi.ToolingHintContextContainer.getToolingHintContext.

Annotations
@Override
getTypeInformationback to summary
public HibernateTypeSourceImpl getTypeInformation()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getTypeInformation.

Doc from org.hibernate.boot.model.source.spi.AttributeSource.getTypeInformation.

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

Returns:HibernateTypeSourceImpl

The Hibernate type information

Annotations
@Override
getUnsavedValueback to summary
public String getUnsavedValue()

Implements org.hibernate.boot.model.source.spi.VersionAttributeSource.getUnsavedValue.

Annotations
@Override
getXmlNodeNameback to summary
public String getXmlNodeName()

Implements org.hibernate.boot.model.source.spi.AttributeSource.getXmlNodeName.

Doc from org.hibernate.boot.model.source.spi.AttributeSource.getXmlNodeName.

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.

Returns:String

The xml node name

Annotations
@Override
isBytecodeLazyback to summary
public boolean isBytecodeLazy()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.isBytecodeLazy.

Doc from org.hibernate.boot.model.source.spi.SingularAttributeSource.isBytecodeLazy.

Should the attribute be lazily loaded by bytecode enhancement?

Returns:boolean

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

Annotations
@Override
isCollectionElementback to summary
public boolean isCollectionElement()

Implements org.hibernate.boot.model.naming.ImplicitBasicColumnNameSource.isCollectionElement.

Doc from org.hibernate.boot.model.naming.ImplicitBasicColumnNameSource.isCollectionElement.

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

Returns:boolean

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

Annotations
@Override
isIncludedInOptimisticLockingback to summary
public boolean isIncludedInOptimisticLocking()

Implements org.hibernate.boot.model.source.spi.AttributeSource.isIncludedInOptimisticLocking.

Doc from org.hibernate.boot.model.source.spi.AttributeSource.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?

Returns:boolean

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

Annotations
@Override
isInsertableback to summary
public Boolean isInsertable()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.isInsertable.

Doc from org.hibernate.boot.model.source.spi.SingularAttributeSource.isInsertable.

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

Returns:Boolean

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

Annotations
@Override
isSingularback to summary
public boolean isSingular()

Implements org.hibernate.boot.model.source.spi.AttributeSource.isSingular.

Doc from org.hibernate.boot.model.source.spi.AttributeSource.isSingular.

Attributes are (coarsely speaking) either singular or plural.

Returns:boolean

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

Annotations
@Override
isUpdatableback to summary
public Boolean isUpdatable()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.isUpdatable.

Doc from org.hibernate.boot.model.source.spi.SingularAttributeSource.isUpdatable.

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

Returns:Boolean

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

Annotations
@Override
isVirtualAttributeback to summary
public boolean isVirtualAttribute()

Implements org.hibernate.boot.model.source.spi.SingularAttributeSource.isVirtualAttribute.

Doc from org.hibernate.boot.model.source.spi.SingularAttributeSource.isVirtualAttribute.

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

Returns:boolean

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

Annotations
@Override