Top Description Methods
org.hibernate.boot.model.source.spi

public Interface AttributeSource

extends ToolingHintContextContainer
Known Direct Subinterfaces
org.hibernate.boot.model.source.spi.PluralAttributeSource, org.hibernate.boot.model.source.spi.SingularAttributeSource
Imports
org.hibernate.boot.model.source.internal.hbm.XmlElementMetadata
Contract for sources of persistent attribute descriptions.

These values are used to build org.hibernate.mapping.Property instances.

Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public AttributePath
getAttributePath()

public AttributeRole
getAttributeRole()

public String

Returns:

The attribute name. null is NOT allowed!
getName()

Obtain the attribute name.

public String

Returns:

The property accessor style for this attribute.
getPropertyAccessorName()

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

public XmlElementMetadata
getSourceType()

public HibernateTypeSource

Returns:

The Hibernate type information
getTypeInformation()

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

public String

Returns:

The xml node name
getXmlNodeName()

This is only useful to log warnings when these deprecated attributes are populated.

public boolean

Returns:

true indicates it should be included; false, it should not.
isIncludedInOptimisticLocking()

If the containing entity is using optimistic locking, should this attribute participate in that locking?

public boolean

Returns:

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

Attributes are (coarsely speaking) either singular or plural.

Inherited from org.hibernate.boot.model.source.spi.ToolingHintContextContainer:
getToolingHintContext

Method Detail

getAttributePathback to summary
public AttributePath getAttributePath()
getAttributeRoleback to summary
public AttributeRole getAttributeRole()
getNameback to summary
public String getName()

Obtain the attribute name.

Returns:String

The attribute name. null is NOT allowed!

getPropertyAccessorNameback to summary
public String getPropertyAccessorName()

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

Returns:String

The property accessor style for this attribute.

See Also
org.hibernate.property.access.spi.PropertyAccessStrategy
getSourceTypeback to summary
public XmlElementMetadata getSourceType()
getTypeInformationback to summary
public HibernateTypeSource getTypeInformation()

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

Returns:HibernateTypeSource

The Hibernate type information

getXmlNodeNameback to summary
public 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:String

The xml node name

isIncludedInOptimisticLockingback to summary
public 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:boolean

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

isSingularback to summary
public boolean 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).