io.requery.meta

Class CollectionAttributeBuilder<T,C extends Collection,E>

java.lang.Object

io.requery.query.FieldExpression<V>

io.requery.meta.AttributeBuilder<T,C>

io.requery.meta.CollectionAttributeBuilder<T,C,E>

All Implemented Interfaces:

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

Direct Known Subclasses:

ListAttributeBuilder, SetAttributeBuilder

public class CollectionAttributeBuilder<T,C extends Collection,E>
extends AttributeBuilder<T,C>

Constructor Summary

Constructors

Constructor and Description
CollectionAttributeBuilder(String name, Class<? extends Collection> type, Class<E> elementClass)

Method Summary

Modifier and Type	Method and Description
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()
void	setDeclaringType(Type<T> type)
String	toString()

Methods inherited from class io.requery.meta.AttributeBuilder

build, 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

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

CollectionAttributeBuilder

public CollectionAttributeBuilder(String name,
                                  Class<? extends Collection> type,
                                  Class<E> elementClass)

Method Detail

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)