public interface LocationQuery extends OsidObjectQuery, OsidFederateableQuery
This is the query for searching locations. 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 |
clearContainedLocationIdTerms()
Clears the contained location
Id query terms. |
void |
clearContainedLocationTerms()
Clears the contained location query terms.
|
void |
clearContainedSpatialUnitTerms()
Clears the spatial unit terms.
|
void |
clearContainingLocationIdTerms()
Clears the pcontaining location
Id query terms. |
void |
clearContainingLocationTerms()
Clears the containing location query terms.
|
void |
clearCoordinateTerms()
Clears the coordinate query terms.
|
void |
clearMapIdTerms()
Clears the map
Id query terms. |
void |
clearMapTerms()
Clears the map query terms.
|
void |
clearOverlappingSpatialUnitTerms()
Clears the overlapping spatial unit terms.
|
void |
clearPathIdTerms()
Clears the path
Id query terms. |
void |
clearPathTerms()
Clears the path query terms.
|
void |
clearRouteIdTerms()
Clears the route
Id query terms. |
void |
clearRouteTerms()
Clears the route query terms.
|
void |
clearSpatialUnitTerms()
Clears the spatial unit query terms.
|
LocationQuery |
getContainedLocationQuery()
Gets the query for a contained location.
|
LocationQuery |
getContainingLocationQuery()
Gets the query for a parent location.
|
LocationQueryRecord |
getLocationQueryRecord(Type locationRecordType)
Gets the location query record corresponding to the given
Location record Type. |
MapQuery |
getMapQuery()
Gets the query for a map.
|
PathQuery |
getPathQuery()
Gets the query for a path.
|
RouteQuery |
getRouteQuery()
Gets the query for a route.
|
void |
matchAnyContainedLocation(boolean match)
Matches locations that have any children.
|
void |
matchAnyContainingLocation(boolean match)
Matches locations that have any ancestor.
|
void |
matchAnyCoordinate(boolean match)
Matches locations that have any coordinate assignment.
|
void |
matchAnyPath(boolean match)
Matches locations that exist along any path.
|
void |
matchAnyRoute(boolean match)
Matches locations that are used on any route.
|
void |
matchAnySpatialUnit(boolean match)
Matches locations that have any spatial unit assignment.
|
void |
matchContainedLocationId(Id locationId,
boolean match)
Sets the location
Id for this query to match locations
containing the given location. |
void |
matchContainedSpatialUnit(SpatialUnit spatialUnit,
boolean match)
Matches locations containing the specified
SpatialUnit. |
void |
matchContainingLocationId(Id locationId,
boolean match)
Sets the location
Id for this query to match locations
contained within the given location. |
void |
matchCoordinate(Coordinate coordinate,
boolean match)
Matches locations at the specified
Coordinate. |
void |
matchMapId(Id mapId,
boolean match)
Sets the map
Id for this query. |
void |
matchOverlappingSpatialUnit(SpatialUnit spatialUnit,
boolean match)
Matches locations overlapping with the specified
SpatialUnit. |
void |
matchPathId(Id pathId,
boolean match)
Sets the path
Id for this query to match locations
along the given path. |
void |
matchRouteId(Id routeId,
boolean match)
Sets the route
Id for this query to match locations
along the given route. |
boolean |
supportsContainedLocationQuery()
Tests if a
LocationQuery is available. |
boolean |
supportsContainingLocationQuery()
Tests if a
LocationQuery is available. |
boolean |
supportsMapQuery()
Tests if a
MapQuery is available. |
boolean |
supportsPathQuery()
Tests if a
PathQuery is available. |
boolean |
supportsRouteQuery()
Tests if a
RouteQuery 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.
coordinate
- a coordinatematch
- true
for a positive match, false
for a negative matchNullArgumentException
- coordinate
is
null
mandatory
- This method must be implemented. void matchAnyCoordinate(boolean match)
match
- true
to match locations with any
coordinate, false
to match locations with no
coordinatesmandatory
- This method must be implemented. void clearCoordinateTerms()
mandatory
- This method must be implemented. void matchContainedSpatialUnit(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 clearContainedSpatialUnitTerms()
mandatory
- This method must be implemented. void matchOverlappingSpatialUnit(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 clearOverlappingSpatialUnitTerms()
mandatory
- This method must be implemented. void matchAnySpatialUnit(boolean match)
match
- true
to match locations with any
boundary, false
to match locations with no
boundariesmandatory
- This method must be implemented. void clearSpatialUnitTerms()
mandatory
- This method must be implemented. void matchRouteId(Id routeId, boolean match)
Id
for this query to match locations
along the given route.routeId
- the route Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- routeId
is
null
mandatory
- This method must be implemented. void clearRouteIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRouteQuery()
RouteQuery
is available. true
if a route query is available,
false
otherwisemandatory
- This method must be implemented. RouteQuery getRouteQuery()
OR
term.UnimplementedException
- supportsRouteQuery()
is false
optional
- This method must be implemented if
supportsRouteQuery()
is true.
void matchAnyRoute(boolean match)
match
- true
to match locations on any route,
false
to match locations on no routesmandatory
- This method must be implemented. void clearRouteTerms()
mandatory
- This method must be implemented. void matchPathId(Id pathId, boolean match)
Id
for this query to match locations
along the given 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 locations on any path,
false
to match locations on no pathmandatory
- This method must be implemented. void clearPathTerms()
mandatory
- This method must be implemented. void matchContainingLocationId(Id locationId, boolean match)
Id
for this query to match locations
contained within the given location.locationId
- a location Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- locationId
is
null
mandatory
- This method must be implemented. void clearContainingLocationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsContainingLocationQuery()
LocationQuery
is available. true
if a location query is available,
false
otherwisemandatory
- This method must be implemented. LocationQuery getContainingLocationQuery()
OR
term.UnimplementedException
-
supportsContainingLocationQuery()
is false
optional
- This method must be implemented if
supportsContainingLocationQuery()
is true.
void matchAnyContainingLocation(boolean match)
match
- true
to match locations with any parent
location, false
to match root locationsmandatory
- This method must be implemented. void clearContainingLocationTerms()
mandatory
- This method must be implemented. void matchContainedLocationId(Id locationId, boolean match)
Id
for this query to match locations
containing the given location.locationId
- a location Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- locationId
is
null
mandatory
- This method must be implemented. void clearContainedLocationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsContainedLocationQuery()
LocationQuery
is available. true
if a location query is available,
false
otherwisemandatory
- This method must be implemented. LocationQuery getContainedLocationQuery()
OR
term.UnimplementedException
-
supportsContainedLocationQuery()
is false
optional
- This method must be implemented if
supportsContainedLocationQuery()
is true.
void matchAnyContainedLocation(boolean match)
match
- true
to match locations containing any
other location, false
to match empty locationsmandatory
- This method must be implemented. void clearContainedLocationTerms()
mandatory
- This method must be implemented. void matchMapId(Id mapId, boolean match)
Id
for this query.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. LocationQueryRecord getLocationQueryRecord(Type locationRecordType) throws OperationFailedException
Location
record Type.
Multiple record
retrievals produce a nested OR
term.locationRecordType
- a location record typeNullArgumentException
- locationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(locationRecordType)
is false
mandatory
- This method must be implemented.