Class AbstractRouteQueryInspector
java.lang.Object
net.okapia.osid.jamocha.spi.AbstractOsidQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidIdentifiableQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidObjectQueryInspector
net.okapia.osid.jamocha.spi.AbstractTemporalOsidObjectQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidRelationshipQueryInspector
net.okapia.osid.jamocha.mapping.route.route.spi.AbstractRouteQueryInspector
- All Implemented Interfaces:
Extensible, RouteQueryInspector, OsidAggregateableQueryInspector, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
- Direct Known Subclasses:
RouteQueryUninspector
public abstract class AbstractRouteQueryInspector
extends AbstractOsidRelationshipQueryInspector
implements RouteQueryInspector
A query inspector template for routes.
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractTemporalOsidObjectQueryInspector
AbstractTemporalOsidObjectQueryInspector.OsidTemporalQueryInspectorModifier and TypeClassDescriptionprotected classComposed OsidTemporalQueryInspector.Nested classes/interfaces inherited from class AbstractOsidObjectQueryInspector
AbstractOsidObjectQueryInspector.OsidBrowsableQueryInspectorModifier and TypeClassDescriptionprotected classComposed BrowsableQueryInspector. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddRouteQueryInspectorRecord(RouteQueryInspectorRecord routeQueryInspectorRecord, Type routeRecordType) Adds a record to this route query.Gets the along locationIdquery terms.Gets the distance query terms.IdTerm[]Gets the ending locationIdquery terms.Gets the ending location query terms.Gets the ETA query terms.IdTerm[]Gets the locationIdquery terms.Gets the location query terms.IdTerm[]Gets the mapIdquery terms.Gets the map query terms.IdTerm[]Gets the pathIdquery terms.Gets the path query terms.getRouteQueryInspectorRecord(Type routeRecordType) Gets the record corresponding to the given route query inspector recordType.IdTerm[]Gets the starting locationIdquery terms.Gets the starting location query terms.Methods inherited from class AbstractOsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsModifier and TypeMethodDescriptionIdTerm[]Gets the end reaosn stateIdquery terms.Gets the end reason state query terms.Methods inherited from class AbstractTemporalOsidObjectQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTermsModifier and TypeMethodDescriptionGets the date query terms.Gets the effective query terms.Gets the end date query terms.Gets the start date query terms.Methods inherited from class AbstractOsidObjectQueryInspector
addRecordType, getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRecordTypes, getRecordTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms, hasRecordTypeModifier and TypeMethodDescriptionprotected voidaddRecordType(Type recordType) Adds a record type.IdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.Gets the record types available in this object.TypeTerm[]Gets the record type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the relevancy query terms.Gets the subject query terms.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from class AbstractOsidIdentifiableQueryInspector
getIdTermsMethods inherited from class AbstractOsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Constructor Details
-
AbstractRouteQueryInspector
public AbstractRouteQueryInspector()Constructs a newAbstractRouteQueryInspector.
-
-
Method Details
-
getStartingLocationIdTerms
Gets the starting locationIdquery terms.- Specified by:
getStartingLocationIdTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getStartingLocationTerms
Gets the starting location query terms.- Specified by:
getStartingLocationTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getEndingLocationIdTerms
Gets the ending locationIdquery terms.- Specified by:
getEndingLocationIdTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getEndingLocationTerms
Gets the ending location query terms.- Specified by:
getEndingLocationTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getAlongLocationIdsTerms
Gets the along locationIdquery terms.- Specified by:
getAlongLocationIdsTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getDistanceTerms
Gets the distance query terms.- Specified by:
getDistanceTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getETATerms
Gets the ETA query terms.- Specified by:
getETATermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getLocationIdTerms
Gets the locationIdquery terms.- Specified by:
getLocationIdTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getLocationTerms
Gets the location query terms.- Specified by:
getLocationTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getPathIdTerms
Gets the pathIdquery terms.- Specified by:
getPathIdTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getPathTerms
Gets the path query terms.- Specified by:
getPathTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getMapIdTerms
Gets the mapIdquery terms.- Specified by:
getMapIdTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getMapTerms
Gets the map query terms.- Specified by:
getMapTermsin interfaceRouteQueryInspector- Returns:
- the query terms
-
getRouteQueryInspectorRecord
@OSID public RouteQueryInspectorRecord getRouteQueryInspectorRecord(Type routeRecordType) throws OperationFailedException Gets the record corresponding to the given route query inspector recordType.This method must be used to retrieve a route implementing the requested record.- Specified by:
getRouteQueryInspectorRecordin interfaceRouteQueryInspector- Parameters:
routeRecordType- a route record type- Returns:
- the route query inspsector record
- Throws:
NullArgumentException-routeRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(routeRecordType)isfalse
-
addRouteQueryInspectorRecord
protected void addRouteQueryInspectorRecord(RouteQueryInspectorRecord routeQueryInspectorRecord, Type routeRecordType) Adds a record to this route query.- Parameters:
routeQueryInspectorRecord- route query inspector recordrouteRecordType- route record type- Throws:
NullArgumentException-recordisnull
-