Interface LocationQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

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 .

Method Summary

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchCoordinate

void matchCoordinate(Coordinate coordinate,
 boolean match)

Matches locations at 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.

matchAnyCoordinate

void matchAnyCoordinate(boolean match)

Matches locations that have any coordinate assignment.

Parameters:

match - true to match locations with any coordinate, false to match locations with no coordinates

Compliance:

mandatory - This method must be implemented.

clearCoordinateTerms

void clearCoordinateTerms()

Clears the coordinate query terms.

Compliance:

mandatory - This method must be implemented.

matchContainedSpatialUnit

void matchContainedSpatialUnit(SpatialUnit spatialUnit,
 boolean match)

Matches locations containing 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.

clearContainedSpatialUnitTerms

void clearContainedSpatialUnitTerms()

Clears the spatial unit terms.

Compliance:

mandatory - This method must be implemented.

matchOverlappingSpatialUnit

void matchOverlappingSpatialUnit(SpatialUnit spatialUnit,
 boolean match)

Matches locations overlapping with 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.

clearOverlappingSpatialUnitTerms

void clearOverlappingSpatialUnitTerms()

Clears the overlapping spatial unit terms.

Compliance:

mandatory - This method must be implemented.

matchAnySpatialUnit

void matchAnySpatialUnit(boolean match)

Matches locations that have any spatial unit assignment.

Parameters:

match - true to match locations with any boundary, false to match locations with no boundaries

Compliance:

mandatory - This method must be implemented.

clearSpatialUnitTerms

void clearSpatialUnitTerms()

Clears the spatial unit query terms.

Compliance:

mandatory - This method must be implemented.

matchRouteId

void matchRouteId(Id routeId,
 boolean match)

Sets the route Id for this query to match locations along the given route.

Parameters:

routeId - the route Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - routeId is null

Compliance:

mandatory - This method must be implemented.

clearRouteIdTerms

void clearRouteIdTerms()

Clears the route Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRouteQuery

boolean supportsRouteQuery()

Tests if a RouteQuery is available.

Returns:

true if a route query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRouteQuery

RouteQuery getRouteQuery()

Gets the query for a route. Multiple retrievals produce a nested OR term.

Returns:

the route query

Throws:

UnimplementedException - supportsRouteQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRouteQuery()} is {@code true} .

matchAnyRoute

void matchAnyRoute(boolean match)

Matches locations that are used on any route.

Parameters:

match - true to match locations on any route, false to match locations on no routes

Compliance:

mandatory - This method must be implemented.

clearRouteTerms

void clearRouteTerms()

Clears the route query terms.

Compliance:

mandatory - This method must be implemented.

matchPathId

void matchPathId(Id pathId,
 boolean match)

Sets the path Id for this query to match locations 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} .

matchAnyPath

void matchAnyPath(boolean match)

Matches locations that exist along any path.

Parameters:

match - true to match locations on any path, false to match locations on no path

Compliance:

mandatory - This method must be implemented.

clearPathTerms

void clearPathTerms()

Clears the path query terms.

Compliance:

mandatory - This method must be implemented.

matchContainingLocationId

void matchContainingLocationId(Id locationId,
 boolean match)

Sets the location Id for this query to match locations contained within the given location.

Parameters:

locationId - a location Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - locationId is null

Compliance:

mandatory - This method must be implemented.

clearContainingLocationIdTerms

void clearContainingLocationIdTerms()

Clears the pcontaining location Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsContainingLocationQuery

boolean supportsContainingLocationQuery()

Tests if a LocationQuery is available.

Returns:

true if a location query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getContainingLocationQuery

LocationQuery getContainingLocationQuery()

Gets the query for a parent location. Multiple retrievals produce a nested OR term.

Returns:

the location query

Throws:

UnimplementedException - supportsContainingLocationQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsContainingLocationQuery()} is {@code true} .

matchAnyContainingLocation

void matchAnyContainingLocation(boolean match)

Matches locations that have any ancestor.

Parameters:

match - true to match locations with any parent location, false to match root locations

Compliance:

mandatory - This method must be implemented.

clearContainingLocationTerms

void clearContainingLocationTerms()

Clears the containing location query terms.

Compliance:

mandatory - This method must be implemented.

matchContainedLocationId

void matchContainedLocationId(Id locationId,
 boolean match)

Sets the location Id for this query to match locations containing the given location.

Parameters:

locationId - a location Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - locationId is null

Compliance:

mandatory - This method must be implemented.

clearContainedLocationIdTerms

void clearContainedLocationIdTerms()

Clears the contained location Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsContainedLocationQuery

boolean supportsContainedLocationQuery()

Tests if a LocationQuery is available.

Returns:

true if a location query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getContainedLocationQuery

LocationQuery getContainedLocationQuery()

Gets the query for a contained location. Multiple retrievals produce a nested OR term.

Returns:

the location query

Throws:

UnimplementedException - supportsContainedLocationQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsContainedLocationQuery()} is {@code true} .

matchAnyContainedLocation

void matchAnyContainedLocation(boolean match)

Matches locations that have any children.

Parameters:

match - true to match locations containing any other location, false to match empty locations

Compliance:

mandatory - This method must be implemented.

clearContainedLocationTerms

void clearContainedLocationTerms()

Clears the contained location query 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.

getLocationQueryRecord

LocationQueryRecord getLocationQueryRecord(Type locationRecordType)
                                    throws OperationFailedException

Gets the location query record corresponding to the given Location record Type .Multiple record retrievals produce a nested OR term.

Parameters:

locationRecordType - a location record type

Returns:

the location query record

Throws:

NullArgumentException - locationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(locationRecordType) is false

Compliance:

mandatory - This method must be implemented.