public interface IntersectionQuery extends OsidObjectQuery, OsidAggregateableQuery
This is the query for searching intersections. Each method match
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearContainingSpatialUnitTerms()
Clears the spatial unit terms.
|
void |
clearCoordinateTerms()
Clears the coordinate query terms.
|
void |
clearForkTerms()
Clears the fork query terms.
|
void |
clearMapIdTerms()
Clears the map
Id query terms. |
void |
clearMapTerms()
Clears the map query terms.
|
void |
clearPathIdTerms()
Clears the path
Id query terms. |
void |
clearPathTerms()
Clears the path query terms.
|
void |
clearRotaryTerms()
Clears the rotary query terms.
|
IntersectionQueryRecord |
getIntersectionQueryRecord(Type intersectionRecordType)
Gets the intersection query record corresponding to the given
Intersection record Type. |
MapQuery |
getMapQuery()
Gets the query for a map.
|
PathQuery |
getPathQuery()
Gets the query for a path.
|
void |
matchAnyPath(boolean match)
Matches intersections with any designated path.
|
void |
matchContainingSpatialUnit(SpatialUnit spatialUnit,
boolean match)
Matches intersections within the specified
SpatialUnit. |
void |
matchCoordinate(Coordinate coordinate,
boolean match)
Match intersections overlapping with the given coordinate.
|
void |
matchFork(boolean match)
Matches forks.
|
void |
matchMapId(Id mapId,
boolean match)
Sets the map
Id for this query to match routes assigned
to maps. |
void |
matchPathId(Id pathId,
boolean match)
Sets the path
Id for this query to match routes using a
designated path. |
void |
matchRotary(boolean match)
Matches rotaries.
|
boolean |
supportsMapQuery()
Tests if a
MapQuery is available. |
boolean |
supportsPathQuery()
Tests if a
PathQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchCoordinate(Coordinate coordinate, boolean match)
coordinate
- a coordinatematch
- true
for a positive match, false
for a negative matchNullArgumentException
- coordinate
is
null
mandatory
- This method must be implemented. void clearCoordinateTerms()
mandatory
- This method must be implemented. void matchContainingSpatialUnit(SpatialUnit spatialUnit, boolean match)
SpatialUnit.
spatialUnit
- a spatial unitmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- spatialUnit
is
null
mandatory
- This method must be implemented. void clearContainingSpatialUnitTerms()
mandatory
- This method must be implemented. void matchPathId(Id pathId, boolean match)
Id
for this query to match routes using a
designated path.pathId
- the path Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- pathId
is
null
mandatory
- This method must be implemented. void clearPathIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPathQuery()
PathQuery
is available. true
if a path query is available, false
otherwisemandatory
- This method must be implemented. PathQuery getPathQuery()
OR
term.UnimplementedException
- supportsPathQuery()
is false
optional
- This method must be implemented if
supportsPathQuery()
is true.
void matchAnyPath(boolean match)
match
- true
to match routes with any path,
false
to match routes with no pathmandatory
- This method must be implemented. void clearPathTerms()
mandatory
- This method must be implemented. void matchRotary(boolean match)
match
- true
to match rotaries, false
otherwisemandatory
- This method must be implemented. void clearRotaryTerms()
mandatory
- This method must be implemented. void matchFork(boolean match)
match
- true
to match forks, false
otherwisemandatory
- This method must be implemented. void clearForkTerms()
mandatory
- This method must be implemented. void matchMapId(Id mapId, boolean match)
Id
for this query to match routes assigned
to maps.mapId
- the map Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- mapId
is
null
mandatory
- This method must be implemented. void clearMapIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsMapQuery()
MapQuery
is available. true
if a map query is available, false
otherwisemandatory
- This method must be implemented. MapQuery getMapQuery()
OR
term.UnimplementedException
- supportsMapQuery()
is false
optional
- This method must be implemented if
supportsMapQuery()
is true.
void clearMapTerms()
mandatory
- This method must be implemented. IntersectionQueryRecord getIntersectionQueryRecord(Type intersectionRecordType) throws OperationFailedException
Intersection
record Type.
Multiple record
retrievals produce a nested OR
term.intersectionRecordType
- an intersection record typeNullArgumentException
- intersectionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(intersectionRecordType)
is false
mandatory
- This method must be implemented.