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

Class JsonQueryIsRelatedTo

java.lang.Object

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

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

org.gcube.informationsystem.resourceregistry.queries.json.base.relations.JsonQueryRelation

org.gcube.informationsystem.resourceregistry.queries.json.base.relations.JsonQueryIsRelatedTo

public class JsonQueryIsRelatedTo
extends JsonQueryRelation

Translates a JSON query subtree representing an IsRelatedTo relation.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	requestedResourceType	The requested resource schema type.

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

direction, traverseBack

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
JsonQueryIsRelatedTo(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonQuery)	Creates a new JsonQueryIsRelatedTo instance for the specified JSON query subtree.

Method Summary

Modifier and Type	Method	Description
String	getRequestedResourceType()	Returns the requested resource schema type.
protected StringBuffer	getSpecificMatchQuery(List<JsonQueryElement> childrenBreadcrumb)	Generates the specific MATCH query snippet for this element's subclass (subclass hook).
void	setDirectionByJson()	Sets the traversal direction of this relation based on the source/target properties in the JSON node.
void	setDirectionByJson(boolean matchQuery)	Sets the traversal direction of this relation based on the source/target properties in the JSON node, optionally taking into account whether it's a MATCH query.
void	setRequestedResourceType(String requestedResourceType)	Sets the requested resource schema type.

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

getDirection, isTraverseBack, setDirection, setEntryPoint, setTraverseBack

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, getFieldReference, getKey, getPosition, getPropertyDomain, getQueryParameters, getRequiredType, getScalarValue, getScalarValue, 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

requestedResourceType

protected String requestedResourceType

The requested resource schema type.

Constructor Details

JsonQueryIsRelatedTo

public JsonQueryIsRelatedTo(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonQuery)
                     throws org.gcube.informationsystem.resourceregistry.api.exceptions.types.SchemaException,
org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

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

Parameters:

jsonQuery - the JSON query node

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

getRequestedResourceType

public String getRequestedResourceType()

Returns the requested resource schema type.

Returns:

the requested resource schema type

setRequestedResourceType

public void setRequestedResourceType(String requestedResourceType)

Sets the requested resource schema type.

Parameters:

requestedResourceType - the requested resource schema type to set

setDirectionByJson

public void setDirectionByJson()
                        throws org.gcube.informationsystem.resourceregistry.api.exceptions.queries.InvalidQueryException

Sets the traversal direction of this relation based on the source/target properties in the JSON node.

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.queries.InvalidQueryException - if the JSON structure is invalid or has contradictory properties

setDirectionByJson

public void setDirectionByJson(boolean matchQuery)
                        throws org.gcube.informationsystem.resourceregistry.api.exceptions.queries.InvalidQueryException

Sets the traversal direction of this relation based on the source/target properties in the JSON node, optionally taking into account whether it's a MATCH query.

Parameters:

matchQuery - true if it is a MATCH query, false otherwise

Throws:

org.gcube.informationsystem.resourceregistry.api.exceptions.queries.InvalidQueryException - if the JSON structure is invalid or has contradictory properties

getSpecificMatchQuery

protected StringBuffer getSpecificMatchQuery(List<JsonQueryElement> childrenBreadcrumb)
                                      throws org.gcube.informationsystem.resourceregistry.api.exceptions.types.SchemaException,
org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException

Description copied from class: JsonQueryElement

Generates the specific MATCH query snippet for this element's subclass (subclass hook).

Specified by:

getSpecificMatchQuery in class JsonQueryElement

Parameters:

childrenBreadcrumb - the list of child query elements visited

Returns:

the MATCH query snippet string buffer

Throws:

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

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