Package org.gcube.informationsystem.resourceregistry.queries.json.base

Class JsonQueryERElement

java.lang.Object

org.gcube.informationsystem.resourceregistry.queries.json.base.JsonQueryElement

org.gcube.informationsystem.resourceregistry.queries.json.base.JsonQueryERElement

Direct Known Subclasses:

JsonQueryEntity, JsonQueryRelation

public abstract class JsonQueryERElement
extends JsonQueryElement

Base class for JSON query elements that participate in graph relation traversal (Resources, Facets, IsRelatedTo, ConsistsOf), adding an edge direction and back-reference traverseBack on top of the generic JsonQueryElement translation machinery.

Flat, standalone collections with no relations to traverse (e.g. QueryTemplate, Context) extend JsonQueryElement directly instead — they are never an ER (Entity-Relation) element.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
protected org.gcube.informationsystem.base.reference.Direction	direction	The relation graph traversal direction.
protected boolean	traverseBack	Whether to traverse backwards through relations.

Fields inherited from class org.gcube.informationsystem.resourceregistry.queries.json.base.JsonQueryElement

accessType, alias, BACKEND_LINK_FIELD_PREFIXES, BACKEND_LINK_FIELDS, BACKEND_TYPE_NAME_FIELD, breadcrumb, CREATED_BY_PATH, declaredPropertyResolver, ELEMENT_INDEX_PATTERN, encryptedTypeParameters, entryPoint, FALSE_CONDITION, FIELD_NAME_PATTERN, fieldNamesToRemove, fieldsToEmit, IS_NULL, jsonNode, LAST_UPDATE_BY_PATH, logger, maskMetadata, objectMapper, operandValidator, OPERATOR_PREFIX, polymorphic, position, projection, queryParameterIndex, queryParameters, RECORD_ATTRIBUTE_PREFIX, size, type, unqueryableFields

Constructor Summary

Constructors

Constructor	Description
JsonQueryERElement(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonQuery, org.gcube.informationsystem.base.reference.AccessType accessType)	Creates a new JsonQueryERElement instance for the specified JSON query subtree.

Method Summary

Modifier and Type	Method	Description
org.gcube.informationsystem.base.reference.Direction	getDirection()	Returns the relation graph traversal direction of this element.
boolean	isTraverseBack()	Returns whether to traverse backwards through relations.
void	setDirection(org.gcube.informationsystem.base.reference.Direction direction)	Sets the relation graph traversal direction of this element.
void	setEntryPoint(boolean entryPoint)	Sets whether this query element represents the root entry point of the query.
void	setTraverseBack(boolean traverseBack)	Sets whether to traverse backwards through relations.

Methods inherited from class org.gcube.informationsystem.resourceregistry.queries.json.base.JsonQueryElement

addComparisonConstraint, addConstraints, addFieldToEmit, addLogicalConstraints, createMatchQuery, createQuery, evaluateNode, excludeEncrypted, generateAlias, getAlias, getAlias, getBreadcrumb, getChildrenBreadcrumb, getFieldOperand, getFieldReference, getKey, getPosition, getPropertyDomain, getQueryParameters, getRequiredType, getScalarValue, getScalarValue, getSpecificMatchQuery, getType, getValue, isEntryPoint, isProjection, isSensitiveField, resolveFieldName, setBreadcrumb, setMaskMetadata, setPolymorphic, setPosition, setProjection, validateEmittedField, validateLogicalCondition, validateType, wrapMatchQuery

Methods inherited from class java.lang.Object

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

Field Details

direction

protected org.gcube.informationsystem.base.reference.Direction direction

The relation graph traversal direction.

traverseBack

protected boolean traverseBack

Whether to traverse backwards through relations.

Constructor Details

JsonQueryERElement

public JsonQueryERElement(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonQuery,
 org.gcube.informationsystem.base.reference.AccessType accessType)
                   throws org.gcube.informationsystem.resourceregistry.api.exceptions.types.SchemaException,
org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Creates a new JsonQueryERElement instance for the specified JSON query subtree.

Parameters:

jsonQuery - the JSON query node representing this element

accessType - the access type category

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.types.SchemaException - if schema validation fails

org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException - on database or lookup error

Method Details

getDirection

public org.gcube.informationsystem.base.reference.Direction getDirection()

Returns the relation graph traversal direction of this element.

Returns:

the relation direction

setDirection

public void setDirection(org.gcube.informationsystem.base.reference.Direction direction)

Sets the relation graph traversal direction of this element.

Parameters:

direction - the relation direction to set

setEntryPoint

public void setEntryPoint(boolean entryPoint)

Description copied from class: JsonQueryElement

Sets whether this query element represents the root entry point of the query.

Overrides:

setEntryPoint in class JsonQueryElement

Parameters:

entryPoint - true if this is the entry point, false otherwise

isTraverseBack

public boolean isTraverseBack()

Returns whether to traverse backwards through relations.

Returns:

true to traverse back, false otherwise

setTraverseBack

public void setTraverseBack(boolean traverseBack)

Sets whether to traverse backwards through relations.

Parameters:

traverseBack - true to traverse back, false otherwise