AttributeBuilder (requery API)

java.lang.Object
- io.requery.query.FieldExpression<V>
- - io.requery.meta.AttributeBuilder<T,V>

Type Parameters:

T - entity type

V - value type

All Implemented Interfaces:

Attribute<T,V>, QueryAttribute<T,V>, QueryExpression<V>, Aliasable<Expression<V>>, Conditional<LogicalCondition<? extends Expression<V>,?>,V>, Expression<V>, Functional<V>

Direct Known Subclasses:

CollectionAttributeBuilder, MapAttributeBuilder, ResultAttributeBuilder
```
public class AttributeBuilder<T,V>
extends FieldExpression<V>
```
Builds information about an attribute on a specific Type.

Constructor Summary

Constructors
Constructor and Description

AttributeBuilder(String name, Class<V> type)

Constructors
Constructor and Description
`AttributeBuilder(String name, Class<V> type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryAttribute<T,V>`	`build()`
`boolean`	`equals(Object obj)`
`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()`
`ExpressionType`	`getExpressionType()`
`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()`
`int`	`hashCode()`
`boolean`	`isAssociation()`
`boolean`	`isForeignKey()`
`boolean`	`isGenerated()`
`boolean`	`isIndexed()`
`boolean`	`isKey()`
`boolean`	`isLazy()`
`boolean`	`isNullable()`
`boolean`	`isUnique()`
`boolean`	`isVersion()`
`<B> AttributeBuilder<T,V>`	`setBuilderProperty(Property<B,V> property)`
`AttributeBuilder<T,V>`	`setCardinality(Cardinality cardinality)`
`AttributeBuilder<T,V>`	`setCascadeAction(CascadeAction... actions)`
`AttributeBuilder<T,V>`	`setCollate(String collate)`
`AttributeBuilder<T,V>`	`setConverter(Converter<V,?> converter)`
`void`	`setDeclaringType(Type<T> type)`
`AttributeBuilder<T,V>`	`setDefaultValue(String value)`
`AttributeBuilder<T,V>`	`setDefinition(String definition)`
`AttributeBuilder<T,V>`	`setDeleteAction(ReferentialAction action)`
`AttributeBuilder<T,V>`	`setForeignKey(boolean foreignKey)`
`AttributeBuilder<T,V>`	`setGenerated(boolean generated)`
`AttributeBuilder<T,V>`	`setIndexed(boolean indexed)`
`AttributeBuilder<T,V>`	`setIndexNames(String... names)`
`AttributeBuilder<T,V>`	`setInitializer(Initializer<T,V> initializer)`
`AttributeBuilder<T,V>`	`setKey(boolean key)`
`AttributeBuilder<T,V>`	`setLazy(boolean lazy)`
`AttributeBuilder<T,V>`	`setLength(Integer length)`
`AttributeBuilder<T,V>`	`setMappedAttribute(Supplier<Attribute> attribute)`
`AttributeBuilder<T,V>`	`setNullable(boolean nullable)`
`AttributeBuilder<T,V>`	`setOrderByAttribute(Supplier<Attribute> attribute)`
`AttributeBuilder<T,V>`	`setOrderByDirection(Order order)`
`AttributeBuilder<T,V>`	`setProperty(Property<T,V> property)`
`AttributeBuilder<T,V>`	`setPropertyName(String name)`
`AttributeBuilder<T,V>`	`setPropertyState(Property<T,PropertyState> property)`
`AttributeBuilder<T,V>`	`setReferencedAttribute(Supplier<Attribute> attribute)`
`AttributeBuilder<T,V>`	`setReferencedClass(Class<?> type)`
`AttributeBuilder<T,V>`	`setUnique(boolean unique)`
`AttributeBuilder<T,V>`	`setUpdateAction(ReferentialAction action)`
`AttributeBuilder<T,V>`	`setVersion(boolean version)`
`String`	`toString()`

Methods inherited from class io.requery.query.FieldExpression
abs, as, asc, avg, between, desc, eq, eq, equal, equal, function, getAlias, greaterThan, greaterThan, greaterThanOrEqual, greaterThanOrEqual, gt, gt, gte, gte, in, in, isNull, lessThan, lessThan, lessThanOrEqual, lessThanOrEqual, like, lower, lt, lt, lte, lte, max, min, ne, ne, notEqual, notEqual, notIn, notIn, notLike, notNull, round, round, substr, sum, trim, trim, upper

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.requery.query.Functional
abs, asc, avg, desc, function, lower, max, min, round, round, substr, sum, trim, trim, upper

Methods inherited from interface io.requery.query.Aliasable
as, getAlias

Methods inherited from interface io.requery.query.Conditional
between, eq, eq, equal, equal, greaterThan, greaterThan, greaterThanOrEqual, greaterThanOrEqual, gt, gt, gte, gte, in, in, isNull, lessThan, lessThan, lessThanOrEqual, lessThanOrEqual, like, lt, lt, lte, lte, ne, ne, notEqual, notEqual, notIn, notIn, notLike, notNull

- Constructor Detail
  - AttributeBuilder
```
public AttributeBuilder(String name,
                        Class<V> type)
```
- Method Detail
  - setBuilderProperty
```
public <B> AttributeBuilder<T,V> setBuilderProperty(Property<B,V> property)
```
  - setCardinality
```
public AttributeBuilder<T,V> setCardinality(Cardinality cardinality)
```
  - setCascadeAction
```
public AttributeBuilder<T,V> setCascadeAction(CascadeAction... actions)
```
  - setCollate
```
public AttributeBuilder<T,V> setCollate(String collate)
```
  - setConverter
```
public AttributeBuilder<T,V> setConverter(Converter<V,?> converter)
```
  - setDefaultValue
```
public AttributeBuilder<T,V> setDefaultValue(String value)
```
  - setDefinition
```
public AttributeBuilder<T,V> setDefinition(String definition)
```
  - setDeleteAction
```
public AttributeBuilder<T,V> setDeleteAction(ReferentialAction action)
```
  - setForeignKey
```
public AttributeBuilder<T,V> setForeignKey(boolean foreignKey)
```
  - setGenerated
```
public AttributeBuilder<T,V> setGenerated(boolean generated)
```
  - setIndexed
```
public AttributeBuilder<T,V> setIndexed(boolean indexed)
```
  - setIndexNames
```
public AttributeBuilder<T,V> setIndexNames(String... names)
```
  - setInitializer
```
public AttributeBuilder<T,V> setInitializer(Initializer<T,V> initializer)
```
  - setKey
```
public AttributeBuilder<T,V> setKey(boolean key)
```
  - setLazy
```
public AttributeBuilder<T,V> setLazy(boolean lazy)
```
  - setLength
```
public AttributeBuilder<T,V> setLength(Integer length)
```
  - setMappedAttribute
```
public AttributeBuilder<T,V> setMappedAttribute(Supplier<Attribute> attribute)
```
  - setNullable
```
public AttributeBuilder<T,V> setNullable(boolean nullable)
```
  - setOrderByAttribute
```
public AttributeBuilder<T,V> setOrderByAttribute(Supplier<Attribute> attribute)
```
  - setOrderByDirection
```
public AttributeBuilder<T,V> setOrderByDirection(Order order)
```
  - setProperty
```
public AttributeBuilder<T,V> setProperty(Property<T,V> property)
```
  - setPropertyName
```
public AttributeBuilder<T,V> setPropertyName(String name)
```
  - setPropertyState
```
public AttributeBuilder<T,V> setPropertyState(Property<T,PropertyState> property)
```
  - setReferencedAttribute
```
public AttributeBuilder<T,V> setReferencedAttribute(Supplier<Attribute> attribute)
```
  - setReferencedClass
```
public AttributeBuilder<T,V> setReferencedClass(Class<?> type)
```
  - setUnique
```
public AttributeBuilder<T,V> setUnique(boolean unique)
```
  - setUpdateAction
```
public AttributeBuilder<T,V> setUpdateAction(ReferentialAction action)
```
  - setVersion
```
public AttributeBuilder<T,V> setVersion(boolean version)
```
  - build
```
public QueryAttribute<T,V> build()
```
  - getBuilderProperty
```
public Property<?,V> getBuilderProperty()
```
    Specified by:
    
    getBuilderProperty in interface Attribute<T,V>
    
    Returns:
    
    Property used to apply the attribute a builder instance for the type.
  - getClassType
```
public Class<V> getClassType()
```
    Specified by:
    
    getClassType in interface Attribute<T,V>
    
    Specified by:
    
    getClassType in interface Expression<V>
    
    Specified by:
    
    getClassType in class FieldExpression<V>
    
    Returns:
    
    Class that results when the expression is evaluated
  - getCardinality
```
public Cardinality getCardinality()
```
    Specified by:
    
    getCardinality in interface Attribute<T,V>
    
    Returns:
    
    For a Attribute.isAssociation() true attribute the type of relation being represented.
  - getCascadeActions
```
public Set<CascadeAction> getCascadeActions()
```
    Specified by:
    
    getCascadeActions in interface Attribute<T,V>
    
    Returns:
    
    For an associative attribute the action to take when the association is modified.
  - getCollate
```
public String getCollate()
```
    Specified by:
    
    getCollate in interface Attribute<T,V>
    
    Returns:
    
    the collation for the attribute, defaults to null
  - getConverter
```
public Converter<V,?> getConverter()
```
    Specified by:
    
    getConverter in interface Attribute<T,V>
    
    Returns:
    
    the converter instance used to convert the Attribute.getClassType() to a persisted value and vice versa.
  - getDeclaringType
```
public Type<T> getDeclaringType()
```
    Specified by:
    
    getDeclaringType in interface Attribute<T,V>
    
    Returns:
    
    The Type that contains this attribute.
  - getDefaultValue
```
public String getDefaultValue()
```
    Specified by:
    
    getDefaultValue in interface Attribute<T,V>
    
    Returns:
    
    the default value expression for the column. Used during the table generation phase.
  - getDefinition
```
public String getDefinition()
```
    Specified by:
    
    getDefinition in interface Attribute<T,V>
    
    Returns:
    
    optional table column definition Column.definition()
  - getDeleteAction
```
public ReferentialAction getDeleteAction()
```
    Specified by:
    
    getDeleteAction in interface Attribute<T,V>
    
    Returns:
    
    For a Attribute.isForeignKey() attribute the action to take when the referenced entity is deleted, otherwise null.
  - getElementClass
```
public Class<?> getElementClass()
```
    Specified by:
    
    getElementClass in interface Attribute<T,V>
    
    Returns:
    
    For a collection type the class of element in the collection.
  - getExpressionType
```
public ExpressionType getExpressionType()
```
    Specified by:
    
    getExpressionType in interface Expression<V>
    
    Specified by:
    
    getExpressionType in class FieldExpression<V>
    
    Returns:
    
    type of the expression
  - getIndexNames
```
public Set<String> getIndexNames()
```
    Specified by:
    
    getIndexNames in interface Attribute<T,V>
    
    Returns:
    
    for an Attribute.isIndexed() true attribute the index name(s), defaults to empty (auto created).
  - getInitializer
```
public Initializer<T,V> getInitializer()
```
    Specified by:
    
    getInitializer in interface Attribute<T,V>
    
    Returns:
    
    Initializer for defining the default value for the property representing the attribute.
  - getLength
```
public Integer getLength()
```
    Specified by:
    
    getLength in interface Attribute<T,V>
    
    Returns:
    
    for String types the max length of the field in the persistence store or null.
  - getMapKeyClass
```
public Class<?> getMapKeyClass()
```
    Specified by:
    
    getMapKeyClass in interface Attribute<T,V>
    
    Returns:
    
    For a map type the class of the key.
  - getMappedAttribute
```
public Supplier<Attribute> getMappedAttribute()
```
    Specified by:
    
    getMappedAttribute in interface Attribute<T,V>
    
    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
```
public String getName()
```
    Specified by:
    
    getName in interface Attribute<T,V>
    
    Specified by:
    
    getName in interface Expression<V>
    
    Specified by:
    
    getName in class FieldExpression<V>
    
    Returns:
    
    identifier of the expression
  - getOrderByAttribute
```
public Supplier<Attribute> getOrderByAttribute()
```
    Specified by:
    
    getOrderByAttribute in interface Attribute<T,V>
    
    Returns:
    
    For a relationship with a multiple result query the attribute used to order the query.
  - getOrderByDirection
```
public Order getOrderByDirection()
```
    Specified by:
    
    getOrderByDirection in interface Attribute<T,V>
    
    Returns:
    
    If Attribute.getOrderByAttribute() is specified the order direction to use in the generated query.
  - getPrimitiveKind
```
public PrimitiveKind getPrimitiveKind()
```
    Specified by:
    
    getPrimitiveKind in interface Attribute<T,V>
    
    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)
  - getProperty
```
public Property<T,V> getProperty()
```
    Specified by:
    
    getProperty in interface Attribute<T,V>
    
    Returns:
    
    Property representing access to the field of the entity.
  - getPropertyName
```
public String getPropertyName()
```
    Specified by:
    
    getPropertyName in interface Attribute<T,V>
    
    Returns:
    
    Name of the source field or method that this attribute is mapped to.
  - getPropertyState
```
public Property<T,PropertyState> getPropertyState()
```
    Specified by:
    
    getPropertyState in interface Attribute<T,V>
    
    Returns:
    
    Property representing access to the state of the held property.
  - getReferencedAttribute
```
public Supplier<Attribute> getReferencedAttribute()
```
    Specified by:
    
    getReferencedAttribute in interface Attribute<T,V>
    
    Returns:
    
    For a foreign key relationship the attribute being referenced. Note returns a provider since attributes may have cyclic dependencies.
  - getReferencedClass
```
public Class<?> getReferencedClass()
```
    Specified by:
    
    getReferencedClass in interface Attribute<T,V>
    
    Returns:
    
    For a foreign key relationship the type being referenced.
  - getUpdateAction
```
public ReferentialAction getUpdateAction()
```
    Specified by:
    
    getUpdateAction in interface Attribute<T,V>
    
    Returns:
    
    For a Attribute.isForeignKey() attribute the action to take when the referenced entity is updated, otherwise null.
  - isAssociation
```
public boolean isAssociation()
```
    Specified by:
    
    isAssociation in interface Attribute<T,V>
    
    Returns:
    
    true if this attribute is a link to another entity.
  - isForeignKey
```
public boolean isForeignKey()
```
    Specified by:
    
    isForeignKey in interface Attribute<T,V>
    
    Returns:
    
    true if this attribute represents a foreign key constraint.
  - isGenerated
```
public boolean isGenerated()
```
    Specified by:
    
    isGenerated in interface Attribute<T,V>
    
    Returns:
    
    true if this attribute is generated from the persistent store.
  - isIndexed
```
public boolean isIndexed()
```
    Specified by:
    
    isIndexed in interface Attribute<T,V>
    
    Returns:
    
    true if this column is indexed.
  - isKey
```
public boolean isKey()
```
    Specified by:
    
    isKey in interface Attribute<T,V>
    
    Returns:
    
    true if this attribute is the identity for the type represented, false otherwise.
  - isLazy
```
public boolean isLazy()
```
    Specified by:
    
    isLazy in interface Attribute<T,V>
    
    Returns:
    
    true if this attribute is lazily loaded, false otherwise.
  - isNullable
```
public boolean isNullable()
```
    Specified by:
    
    isNullable in interface Attribute<T,V>
    
    Returns:
    
    true if this attribute is not required to be present in the type, (nullable)
  - isUnique
```
public boolean isUnique()
```
    Specified by:
    
    isUnique in interface Attribute<T,V>
    
    Returns:
    
    true if this attribute is unique for the given Type.
  - isVersion
```
public boolean isVersion()
```
    Specified by:
    
    isVersion in interface Attribute<T,V>
    
    Returns:
    
    true if this attribute is to be used a locking field.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class FieldExpression<V>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class FieldExpression<V>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setDeclaringType
```
public void setDeclaringType(Type<T> type)
```

Class AttributeBuilder<T,V>

Constructor Summary

Method Summary

Methods inherited from class io.requery.query.FieldExpression

Methods inherited from class java.lang.Object

Methods inherited from interface io.requery.query.Functional

Methods inherited from interface io.requery.query.Aliasable

Methods inherited from interface io.requery.query.Conditional

Constructor Detail

AttributeBuilder

Method Detail

setBuilderProperty

setCardinality

setCascadeAction

setCollate

setConverter

setDefaultValue

setDefinition

setDeleteAction

setForeignKey

setGenerated

setIndexed

setIndexNames

setInitializer

setKey

setLazy

setLength

setMappedAttribute

setNullable

setOrderByAttribute

setOrderByDirection

setProperty

setPropertyName

setPropertyState

setReferencedAttribute

setReferencedClass

setUnique

setUpdateAction

setVersion

build

getBuilderProperty

getClassType

getCardinality

getCascadeActions

getCollate

getConverter

getDeclaringType

getDefaultValue

getDefinition

getDeleteAction

getElementClass

getExpressionType

getIndexNames

getInitializer

getLength

getMapKeyClass

getMappedAttribute

getName

getOrderByAttribute

getOrderByDirection

getPrimitiveKind

getProperty

getPropertyName

getPropertyState

getReferencedAttribute

getReferencedClass

getUpdateAction

isAssociation

isForeignKey

isGenerated

isIndexed

isKey

isLazy

isNullable

isUnique

isVersion

equals

hashCode

toString

setDeclaringType