Attribute (requery API)

Type Parameters:

T - entity type

V - value type

All Known Subinterfaces:

QueryAttribute<T,V>

All Known Implementing Classes:

AttributeBuilder, CollectionAttributeBuilder, ListAttributeBuilder, MapAttributeBuilder, ResultAttributeBuilder, SetAttributeBuilder
```
public interface Attribute<T,V>
```
Represents information about an attribute on a specific Type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Property<?,V>`	`getBuilderProperty()`
`Cardinality`	`getCardinality()`
`Set<CascadeAction>`	`getCascadeActions()`
`Class<V>`	`getClassType()`
`String`	`getCollate()`
`Converter<V,?>`	`getConverter()`
`Type<T>`	`getDeclaringType()`
`String`	`getDefaultValue()`
`String`	`getDefinition()`
`ReferentialAction`	`getDeleteAction()`
`Class<?>`	`getElementClass()`
`Set<String>`	`getIndexNames()`
`Initializer<T,V>`	`getInitializer()`
`Integer`	`getLength()`
`Class<?>`	`getMapKeyClass()`
`Supplier<Attribute>`	`getMappedAttribute()`
`String`	`getName()`
`Supplier<Attribute>`	`getOrderByAttribute()`
`Order`	`getOrderByDirection()`
`PrimitiveKind`	`getPrimitiveKind()`
`Property<T,V>`	`getProperty()`
`String`	`getPropertyName()`
`Property<T,PropertyState>`	`getPropertyState()`
`Supplier<Attribute>`	`getReferencedAttribute()`
`Class<?>`	`getReferencedClass()`
`ReferentialAction`	`getUpdateAction()`
`boolean`	`isAssociation()`
`boolean`	`isForeignKey()`
`boolean`	`isGenerated()`
`boolean`	`isIndexed()`
`boolean`	`isKey()`
`boolean`	`isLazy()`
`boolean`	`isNullable()`
`boolean`	`isUnique()`
`boolean`	`isVersion()`

- Method Detail
  - getBuilderProperty
```
Property<?,V> getBuilderProperty()
```
    Returns:
    
    Property used to apply the attribute a builder instance for the type.
  - getClassType
```
Class<V> getClassType()
```
    Returns:
    
    the type of Class this attribute holds.
  - getCollate
```
String getCollate()
```
    Returns:
    
    the collation for the attribute, defaults to null
  - getCardinality
```
Cardinality getCardinality()
```
    Returns:
    
    For a isAssociation() true attribute the type of relation being represented.
  - getCascadeActions
```
Set<CascadeAction> getCascadeActions()
```
    Returns:
    
    For an associative attribute the action to take when the association is modified.
  - getConverter
```
Converter<V,?> getConverter()
```
    Returns:
    
    the converter instance used to convert the getClassType() to a persisted value and vice versa.
  - getDeclaringType
```
Type<T> getDeclaringType()
```
    Returns:
    
    The Type that contains this attribute.
  - getDefaultValue
```
String getDefaultValue()
```
    Returns:
    
    the default value expression for the column. Used during the table generation phase.
  - getDefinition
```
String getDefinition()
```
    Returns:
    
    optional table column definition Column.definition()
  - getDeleteAction
```
ReferentialAction getDeleteAction()
```
    Returns:
    
    For a isForeignKey() attribute the action to take when the referenced entity is deleted, otherwise null.
  - getElementClass
```
Class<?> getElementClass()
```
    Returns:
    
    For a collection type the class of element in the collection.
  - getIndexNames
```
Set<String> getIndexNames()
```
    Returns:
    
    for an isIndexed() true attribute the index name(s), defaults to empty (auto created).
  - getInitializer
```
Initializer<T,V> getInitializer()
```
    Returns:
    
    Initializer for defining the default value for the property representing the attribute.
  - getLength
```
Integer getLength()
```
    Returns:
    
    for String types the max length of the field in the persistence store or null.
  - getMapKeyClass
```
Class<?> getMapKeyClass()
```
    Returns:
    
    For a map type the class of the key.
  - getMappedAttribute
```
Supplier<Attribute> getMappedAttribute()
```
    Returns:
    
    For a associative relationship the attribute that is the owning side of the relationship. Note returns a provider since attributes may have cyclic dependencies.
  - getName
```
String getName()
```
    Returns:
    
    the type name, not this can be different from the member/field name.
  - getPrimitiveKind
```
PrimitiveKind getPrimitiveKind()
```
    Returns:
    
    PrimitiveKind of this attribute if this attribute is representing a primitive field, returns null otherwise if the field is not primitive (including boxed versions of types)
  - getOrderByAttribute
```
Supplier<Attribute> getOrderByAttribute()
```
    Returns:
    
    For a relationship with a multiple result query the attribute used to order the query.
  - getOrderByDirection
```
Order getOrderByDirection()
```
    Returns:
    
    If getOrderByAttribute() is specified the order direction to use in the generated query.
  - getProperty
```
Property<T,V> getProperty()
```
    Returns:
    
    Property representing access to the field of the entity.
  - getPropertyName
```
String getPropertyName()
```
    Returns:
    
    Name of the source field or method that this attribute is mapped to.
  - getPropertyState
```
Property<T,PropertyState> getPropertyState()
```
    Returns:
    
    Property representing access to the state of the held property.
  - getReferencedAttribute
```
Supplier<Attribute> getReferencedAttribute()
```
    Returns:
    
    For a foreign key relationship the attribute being referenced. Note returns a provider since attributes may have cyclic dependencies.
  - getReferencedClass
```
Class<?> getReferencedClass()
```
    Returns:
    
    For a foreign key relationship the type being referenced.
  - getUpdateAction
```
ReferentialAction getUpdateAction()
```
    Returns:
    
    For a isForeignKey() attribute the action to take when the referenced entity is updated, otherwise null.
  - isAssociation
```
boolean isAssociation()
```
    Returns:
    
    true if this attribute is a link to another entity.
  - isForeignKey
```
boolean isForeignKey()
```
    Returns:
    
    true if this attribute represents a foreign key constraint.
  - isGenerated
```
boolean isGenerated()
```
    Returns:
    
    true if this attribute is generated from the persistent store.
  - isIndexed
```
boolean isIndexed()
```
    Returns:
    
    true if this column is indexed.
  - isKey
```
boolean isKey()
```
    Returns:
    
    true if this attribute is the identity for the type represented, false otherwise.
  - isLazy
```
boolean isLazy()
```
    Returns:
    
    true if this attribute is lazily loaded, false otherwise.
  - isNullable
```
boolean isNullable()
```
    Returns:
    
    true if this attribute is not required to be present in the type, (nullable)
  - isUnique
```
boolean isUnique()
```
    Returns:
    
    true if this attribute is unique for the given Type.
  - isVersion
```
boolean isVersion()
```
    Returns:
    
    true if this attribute is to be used a locking field.

Interface Attribute<T,V>

Method Summary

Method Detail

getBuilderProperty

getClassType

getCollate

getCardinality

getCascadeActions

getConverter

getDeclaringType

getDefaultValue

getDefinition

getDeleteAction

getElementClass

getIndexNames

getInitializer

getLength

getMapKeyClass

getMappedAttribute

getName

getPrimitiveKind

getOrderByAttribute

getOrderByDirection

getProperty

getPropertyName

getPropertyState

getReferencedAttribute

getReferencedClass

getUpdateAction

isAssociation

isForeignKey

isGenerated

isIndexed

isKey

isLazy

isNullable

isUnique

isVersion