org.osid.mapping.path

Interface SignalQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface SignalQuery
extends OsidRuleQuery

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearContainingSpatialUnitTerms() Clears the spatial unit terms.
void	clearCoordinateTerms() Clears the coordinate 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	clearStateIdTerms() Clears the state Id query terms.
void	clearStateTerms() Clears the state query terms.
MapQuery	getMapQuery() Gets the query for a map.
PathQuery	getPathQuery() Gets the query for a path.
SignalQueryRecord	getSignalQueryRecord(Type signalRecordType) Gets the signal query record corresponding to the given Signal record Type.
StateQuery	getStateQuery() Gets the query for a state.
void	matchAnyCoordinate(boolean match) Matches signals that have any coordinate assignment.
void	matchContainingSpatialUnit(SpatialUnit spatialUnit, boolean match) Matches signals within the specified SpatialUnit.
void	matchCoordinate(Coordinate coordinate, boolean match) Matches signals overlapping with the specified Coordinate.
void	matchMapId(Id mapId, boolean match) Sets the map Id for this query.
void	matchPathId(Id pathId, boolean match) Sets the path Id for this query to match speed zones along the given path.
void	matchStateId(Id stateId, boolean match) Sets the state Id for this query.
boolean	supportsMapQuery() Tests if a MapQuery is available.
boolean	supportsPathQuery() Tests if a PathQuery is available.
boolean	supportsStateQuery() Tests if a StateQuery is available.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchPathId

void matchPathId(Id pathId,
               boolean match)

Sets the path Id for this query to match speed zones 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 supportsPathQuery() is true.

clearPathTerms

void clearPathTerms()

Clears the path query terms.

Compliance:

mandatory - This method must be implemented.

matchCoordinate

void matchCoordinate(Coordinate coordinate,
                   boolean match)

Matches signals 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.

matchAnyCoordinate

void matchAnyCoordinate(boolean match)

Matches signals that have any coordinate assignment.

Parameters:

match - true to match signals with any coordinate, false to match signals 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.

matchContainingSpatialUnit

void matchContainingSpatialUnit(SpatialUnit spatialUnit,
                              boolean match)

Matches signals 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.

matchStateId

void matchStateId(Id stateId,
                boolean match)

Sets the state Id for this query.

Specified by:

matchStateId in interface OsidObjectQuery

Parameters:

stateId - the state Id

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

Throws:

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearStateIdTerms

void clearStateIdTerms()

Clears the state Id query terms.

Specified by:

clearStateIdTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

supportsStateQuery

boolean supportsStateQuery()

Tests if a StateQuery is available.

Specified by:

supportsStateQuery in interface OsidObjectQuery

Returns:

true if a state query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStateQuery

StateQuery getStateQuery()

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

Specified by:

getStateQuery in interface OsidObjectQuery

Returns:

the state query

Throws:

UnimplementedException - supportsStateQuery() is false

Compliance:

optional - This method must be implemented if supportsStateQuery() is true.

clearStateTerms

void clearStateTerms()

Clears the state query terms.

Specified by:

clearStateTerms in interface OsidObjectQuery

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 supportsMapQuery() is true.

clearMapTerms

void clearMapTerms()

Clears the map query terms.

Compliance:

mandatory - This method must be implemented.

getSignalQueryRecord

SignalQueryRecord getSignalQueryRecord(Type signalRecordType)
                                       throws OperationFailedException

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

Parameters:

signalRecordType - a signal record type

Returns:

the signal query record

Throws:

NullArgumentException - signalRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalRecordType) is false

Compliance:

mandatory - This method must be implemented.