Package org.gcube.informationsystem.resourceregistry.queries.templates

Record Class TemplateExecutionResult

java.lang.Object
java.lang.Record
org.gcube.informationsystem.resourceregistry.queries.templates.TemplateExecutionResult
Record Components:
json - serialized JSON array of query results
projection - whether the executed query was projection-based (_emit present)
public record TemplateExecutionResult(String json, boolean projection) extends Record
Carries the raw JSON array produced by executing a Query Template together with the one fact about the underlying query that the caller (QueryTemplatePolicyEnforcementPoint) cannot otherwise observe: whether the template's query was projection-based (contained an _emit block). Per the Canonical _emit Precedence Rules (appendix/07-json-query-syntax-reference.md), a projecting query ignores metadataPolicy/includeContexts entirely, and the PEP needs projection to report that back to the client via a QueryParameterWarning.
Author:
Luca Frosini (ISTI - CNR)

  • Constructor Summary

    Constructors
    Constructor
    Description
    TemplateExecutionResult(String json, boolean projection)
    Creates an instance of a TemplateExecutionResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    json()
    Returns the value of the json record component.
    boolean
    projection()
    Returns the value of the projection record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TemplateExecutionResult

      public TemplateExecutionResult(String json, boolean projection)
      Creates an instance of a TemplateExecutionResult record class.
      Parameters:
      json - the value for the json record component
      projection - the value for the projection record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • json

      public String json()
      Returns the value of the json record component.
      Returns:
      the value of the json record component

    • projection

      public boolean projection()
      Returns the value of the projection record component.
      Returns:
      the value of the projection record component