Package org.hibernate.boot.model.source.spi

Interface AttributeSource

All Superinterfaces:
ToolingHintContextContainer
All Known Subinterfaces:
IndexedPluralAttributeSource, PluralAttributeSource, PluralAttributeSourceArray, SingularAttributeSource, SingularAttributeSourceAny, SingularAttributeSourceBasic, SingularAttributeSourceEmbedded, SingularAttributeSourceManyToOne, SingularAttributeSourceOneToOne, SingularAttributeSourceToOne, VersionAttributeSource
All Known Implementing Classes:
AbstractPluralAttributeSourceImpl, AbstractSingularAttributeSourceEmbeddedImpl, AbstractToOneAttributeSourceImpl, CompositeIdentifierSingularAttributeSourceBasicImpl, CompositeIdentifierSingularAttributeSourceManyToOneImpl, PluralAttributeSourceArrayImpl, PluralAttributeSourceBagImpl, PluralAttributeSourceIdBagImpl, PluralAttributeSourceListImpl, PluralAttributeSourceMapImpl, PluralAttributeSourcePrimitiveArrayImpl, PluralAttributeSourceSetImpl, SingularAttributeSourceAnyImpl
public interface AttributeSource extends ToolingHintContextContainer
Contract for sources of persistent attribute descriptions.

These values are used to build Property instances.

  • Method Details

    • getSourceType

      XmlElementMetadata getSourceType()

    • getName

      String getName()
      Obtain the attribute name.
      Returns:
      The attribute name. null is NOT allowed!

    • isSingular

      boolean isSingular()
      Attributes are (coarsely speaking) either singular or plural.
      Returns:
      true indicates the attribute is singular (and therefore castable to SingularAttributeSource); false indicates it is plural (and therefore castable to PluralAttributeSource).

    • getXmlNodeName

      String 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:
      The xml node name

    • getAttributePath

      AttributePath getAttributePath()

    • getAttributeRole

      AttributeRole getAttributeRole()

    • getTypeInformation

      HibernateTypeSource getTypeInformation()
      Obtain information about the Hibernate type (Type) for this attribute.
      Returns:
      The Hibernate type information

    • getPropertyAccessorName

      String getPropertyAccessorName()
      Obtain the name of the property accessor style used to access this attribute.
      Returns:
      The property accessor style for this attribute.
      See Also:

    • isIncludedInOptimisticLocking

      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?
      Returns:
      true indicates it should be included; false, it should not.