Package cz.cvut.kbss.jopa.model.metamodel

Class AbstractQueryAttribute<X,Y>

java.lang.Object

cz.cvut.kbss.jopa.model.metamodel.AbstractQueryAttribute<X,Y>

Type Parameters:

X - The represented type that contains the attribute

Y - The type of the represented attribute

All Implemented Interfaces:

FieldSpecification<X,Y>, QueryAttribute<X,Y>

Direct Known Subclasses:

PluralQueryAttributeImpl, SingularQueryAttributeImpl

public abstract class AbstractQueryAttribute<X,Y>
extends Object
implements QueryAttribute<X,Y>

A common class to all attributes defined by a query

Field Summary

Fields

Modifier and Type	Field	Description
static final String	THIS_PARAMETER	Name of the variable which may be used in the query and would be replaced by the identifier of the entity owning this attribute.

Constructor Summary

Constructors

Constructor	Description
AbstractQueryAttribute(String query, boolean enableReferencingAttributes, Field field, ManagedType<X> declaringType, FetchType fetchType, ParticipationConstraint[] constraints, ConverterWrapper converter)

Method Summary

Modifier and Type	Method	Description
boolean	enableReferencingAttributes()	Whether referencing other entity attributes is enabled.
ParticipationConstraint[]	getConstraints()	Returns participation constraints specified for this attribute.
ConverterWrapper	getConverter()
ManagedType<X>	getDeclaringType()	Return the managed type representing the type in which the attribute was declared.
FetchType	getFetchType()	Whether the association is lazily loaded or must be eagerly fetched.
Field	getJavaField()	Return the java.lang.reflect.Member for the represented attribute.
Member	getJavaMember()	Return the java.lang.reflect.Member for the represented attribute.
String	getName()	Return the name of the attribute.
String	getQuery()	Return the entire query as inserted into Sparql.
boolean	includeExplicit()	A query based attribute always includes explicit.
abstract boolean	isCollection()	Is the attribute collection-valued (represents a Collection, Set, List, or Map).
boolean	isInferred()	A query based attribute is always inferred.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface cz.cvut.kbss.jopa.model.metamodel.FieldSpecification

getJavaType, isMappedAttribute

Field Details

THIS_PARAMETER

public static final String THIS_PARAMETER

Name of the variable which may be used in the query and would be replaced by the identifier of the entity owning this attribute.

See Also:

• Constant Field Values

Constructor Details

AbstractQueryAttribute

public AbstractQueryAttribute(String query,
 boolean enableReferencingAttributes,
 Field field,
 ManagedType<X> declaringType,
 FetchType fetchType,
 ParticipationConstraint[] constraints,
 ConverterWrapper converter)

Method Details

getQuery

public String getQuery()

Description copied from interface: QueryAttribute

Return the entire query as inserted into Sparql.

Specified by:

getQuery in interface QueryAttribute<X,Y>

Returns:

Query defining this attribute

enableReferencingAttributes

public boolean enableReferencingAttributes()

Description copied from interface: QueryAttribute

Whether referencing other entity attributes is enabled.

Specified by:

enableReferencingAttributes in interface QueryAttribute<X,Y>

Returns:

true when other entity attributes may be referenced from the query

getJavaMember

public Member getJavaMember()

Description copied from interface: QueryAttribute

Return the java.lang.reflect.Member for the represented attribute.

Specified by:

getJavaMember in interface QueryAttribute<X,Y>

Returns:

corresponding java.lang.reflect.Member

getConstraints

public ParticipationConstraint[] getConstraints()

Description copied from interface: QueryAttribute

Returns participation constraints specified for this attribute.

Specified by:

getConstraints in interface QueryAttribute<X,Y>

Returns:

Array of participation constraints

getDeclaringType

public ManagedType<X> getDeclaringType()

Description copied from interface: FieldSpecification

Return the managed type representing the type in which the attribute was declared.

Specified by:

getDeclaringType in interface FieldSpecification<X,Y>

Returns:

declaring type

getJavaField

public Field getJavaField()

Description copied from interface: FieldSpecification

Return the java.lang.reflect.Member for the represented attribute.

Specified by:

getJavaField in interface FieldSpecification<X,Y>

Returns:

corresponding java.lang.reflect.Member

getFetchType

public FetchType getFetchType()

Description copied from interface: FieldSpecification

Whether the association is lazily loaded or must be eagerly fetched.

Specified by:

getFetchType in interface FieldSpecification<X,Y>

Returns:

Fetch type of the field specification

isInferred

public boolean isInferred()

A query based attribute is always inferred.

Specified by:

isInferred in interface FieldSpecification<X,Y>

Returns:

always true

See Also:

• FieldSpecification.includeExplicit()

includeExplicit

public boolean includeExplicit()

A query based attribute always includes explicit.

Specified by:

includeExplicit in interface FieldSpecification<X,Y>

Returns:

always true

See Also:

• FieldSpecification.isInferred()

getName

public String getName()

Description copied from interface: FieldSpecification

Return the name of the attribute.

Specified by:

getName in interface FieldSpecification<X,Y>

Returns:

name

isCollection

public abstract boolean isCollection()

Description copied from interface: FieldSpecification

Is the attribute collection-valued (represents a Collection, Set, List, or Map).

Specified by:

isCollection in interface FieldSpecification<X,Y>

Returns:

boolean indicating whether the attribute is collection-valued

getConverter

public ConverterWrapper getConverter()

toString

public String toString()

Overrides:

toString in class Object