Interface ObstacleQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, Suppliable
public interface ObstacleQuery extends OsidObjectQuery, OsidOperableQuery

This is the query for searching obstacles. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Like all OsidQueries, ObstacleQuery is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • matchPathId

      void matchPathId(Id pathId, boolean match)
      Sets the path Id for this query to match obstacles along the given path.
      Parameters:
      pathId - the path Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - pathId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPathIdTerms

      void clearPathIdTerms()
      Clears the path Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathQuery

      boolean supportsPathQuery()
      Tests if a PathQuery is available.
      Returns:
      true if a path query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPathQuery

      PathQuery getPathQuery()
      Gets the query for a path. Multiple retrievals produce a nested OR term.
      Returns:
      the path query
      Throws:
      UnimplementedException - supportsPathQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPathQuery()} is {@code true}.

    • clearPathTerms

      void clearPathTerms()
      Clears the path query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCoordinate

      void matchCoordinate(Coordinate coordinate, boolean match)
      Matches obstacles overlapping with the specified Coordinate.
      Parameters:
      coordinate - a coordinate
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - coordinate is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCoordinateTerms

      void clearCoordinateTerms()
      Clears the coordinate query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchContainingSpatialUnit

      void matchContainingSpatialUnit(SpatialUnit spatialUnit, boolean match)
      Matches obstacles within the specified SpatialUnit.
      Parameters:
      spatialUnit - a spatial unit
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - spatialUnit is null
      Compliance:
      mandatory - This method must be implemented.

    • clearContainingSpatialUnitTerms

      void clearContainingSpatialUnitTerms()
      Clears the spatial unit terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMapId

      void matchMapId(Id mapId, boolean match)
      Sets the map Id for this query.
      Parameters:
      mapId - the map Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - mapId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearMapIdTerms

      void clearMapIdTerms()
      Clears the map Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsMapQuery

      boolean supportsMapQuery()
      Tests if a MapQuery is available.
      Returns:
      true if a map query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMapQuery

      MapQuery getMapQuery()
      Gets the query for a map. Multiple retrievals produce a nested OR term.
      Returns:
      the map query
      Throws:
      UnimplementedException - supportsMapQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsMapQuery()} is {@code true}.

    • clearMapTerms

      void clearMapTerms()
      Clears the map query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleQueryRecord

      ObstacleQueryRecord getObstacleQueryRecord(Type obstacleRecordType) throws OperationFailedException
      Gets the obstacle query record corresponding to the given Obstacle record Type.Multiple record retrievals produce a nested OR term.
      Parameters:
      obstacleRecordType - an obstacle record type
      Returns:
      the obstacle query record
      Throws:
      NullArgumentException - obstacleRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(obstacleRecordType) is false
      Compliance:
      mandatory - This method must be implemented.