Interface PathQueryInspector

All Superinterfaces:
Extensible, OsidAggregateableQueryInspector, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
public interface PathQueryInspector extends OsidRelationshipQueryInspector, OsidAggregateableQueryInspector

This is the query inspector for examining path queries.

  • Method Details

    • getCompleteTerms

      BooleanTerm[] getCompleteTerms()
      Gets the complete query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getClosedTerms

      BooleanTerm[] getClosedTerms()
      Gets the closed query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getStartingNodeIdTerms

      IdTerm[] getStartingNodeIdTerms()
      Gets the starting node Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getStartingNodeTerms

      NodeQueryInspector[] getStartingNodeTerms()
      Gets the starting node query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEndingNodeIdTerms

      IdTerm[] getEndingNodeIdTerms()
      Gets the ending node Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEndingNodeTerms

      NodeQueryInspector[] getEndingNodeTerms()
      Gets the ending node query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAlongNodeIdsTerms

      IdSetTerm[] getAlongNodeIdsTerms()
      Gets the along node Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getIntersectingPathIdTerms

      IdTerm[] getIntersectingPathIdTerms()
      Gets the intersecting path Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getIntersectingPathTerms

      PathQueryInspector[] getIntersectingPathTerms()
      Gets the intersecting path query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getHopsTerms

      CardinalRangeTerm[] getHopsTerms()
      Gets the hops query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDistanceTerms

      DecimalRangeTerm[] getDistanceTerms()
      Gets the distance query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCostTerms

      DecimalRangeTerm[] getCostTerms()
      Gets the cost query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getNodeIdTerms

      IdTerm[] getNodeIdTerms()
      Gets the node Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getNodeTerms

      NodeQueryInspector[] getNodeTerms()
      Gets the node query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeIdTerms

      IdTerm[] getEdgeIdTerms()
      Gets the edge Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeTerms

      EdgeQueryInspector[] getEdgeTerms()
      Gets the edge query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getGraphIdTerms

      IdTerm[] getGraphIdTerms()
      Gets the graph Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getGraphTerms

      GraphQueryInspector[] getGraphTerms()
      Gets the graph query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPathQueryInspectorRecord

      PathQueryInspectorRecord getPathQueryInspectorRecord(Type pathRecordType) throws OperationFailedException
      Gets the path query inspector record corresponding to the given Path record Type .
      Parameters:
      pathRecordType - a path record type
      Returns:
      the path query inspector record
      Throws:
      NullArgumentException - pathRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(pathRecordType) is false
      Compliance:
      mandatory - This method must be implemented.