public interface PathQuery extends OsidRelationshipQuery, OsidAggregateableQuery
This is the query for searching paths. 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 |
clearAlongNodeIdsTerms()
Clears the along node
Id query terms. |
void |
clearClosedTerms()
Clears the path closed query terms.
|
void |
clearCompleteTerms()
Clears the path complete query terms.
|
void |
clearCostTerms()
Clears the cost query terms.
|
void |
clearDistanceTerms()
Clears the distance query terms.
|
void |
clearEdgeIdTerms()
Clears the edge
Id query terms. |
void |
clearEdgeTerms()
Clears the edge query terms.
|
void |
clearEndingNodeIdTerms()
Clears the ending node
Id query terms. |
void |
clearEndingNodeTerms()
Clears the ending node query terms.
|
void |
clearGraphIdTerms()
Clears the graph
Id terms. |
void |
clearGraphTerms()
Clears the graph terms.
|
void |
clearHopsTerms()
Clears the number of hops query terms.
|
void |
clearIntersectingPathIdTerms()
Clears the intersecting path
Id query terms. |
void |
clearIntersectingPathTerms()
Clears the intersecting path query terms.
|
void |
clearNodeIdTerms()
Clears the node
Id query terms. |
void |
clearNodeTerms()
Clears the node query terms.
|
void |
clearStartingNodeIdTerms()
Clears the starting node
Id query terms. |
void |
clearStartingNodeTerms()
Clears the starting node query terms.
|
EdgeQuery |
getEdgeQuery()
Gets the query for an edge.
|
NodeQuery |
getEndingNodeQuery()
Gets the query for an ending node.
|
GraphQuery |
getGraphQuery()
Gets the query for a graph.
|
PathQuery |
getIntersectingPathQuery()
Gets the query for an intersecting path, Multiple retrievals produce a
nested
OR term. |
NodeQuery |
getNodeQuery()
Gets the query for a node.
|
PathQueryRecord |
getPathQueryRecord(Type pathRecordType)
Gets the path query record corresponding to the given
Path
record Type. |
NodeQuery |
getStartingNodeQuery()
Gets the query for a starting node.
|
void |
matchAlongNodeIds(Id[] nodeIds,
boolean match)
Sets the node
Ids for this query to match paths along
the given nodes. |
void |
matchAnyDistance(boolean match)
Matches paths that has any distance assigned.
|
void |
matchAnyIntersectingPath(boolean match)
Matches paths with any intersecting path,
|
void |
matchClosed(boolean match)
Matches paths that are closed.
|
void |
matchComplete(boolean match)
Matches paths that are complete.
|
void |
matchCost(java.math.BigDecimal from,
java.math.BigDecimal to,
boolean match)
Matches paths that have a cost with the given range inclusive.
|
void |
matchDistance(java.math.BigDecimal from,
java.math.BigDecimal to,
boolean match)
Matches paths that have a distance with the given range inclusive.
|
void |
matchEdgeId(Id edgeId,
boolean match)
Sets the edge
Id for this query to match paths contain
the edge. |
void |
matchEndingNodeId(Id nodeId,
boolean match)
Sets the node
Id for this query to match paths with an
ending node. |
void |
matchGraphId(Id graphId,
boolean match)
Sets the graph
Id for this query to match edges
assigned to graphs. |
void |
matchHops(long from,
long to,
boolean match)
Matches paths that have a number of hops within the given range
inclusive.
|
void |
matchIntersectingPathId(Id pathId,
boolean match)
Sets the path
Id for this query to match paths
intersecting with another path. |
void |
matchNodeId(Id nodeId,
boolean match)
Sets the node
Id for this query to match paths that
pass through nodes. |
void |
matchStartingNodeId(Id nodeId,
boolean match)
Sets the node
Id for this query to match paths with a
starting node. |
boolean |
supportsEdgeQuery()
Tests if an
EdgeQuery is available. |
boolean |
supportsEndingNodeQuery()
Tests if a
NodeQuery is available for an ending node. |
boolean |
supportsGraphQuery()
Tests if a
GraphQuery is available. |
boolean |
supportsIntersectingPathQuery()
Tests if a
PathQuery is available for intersecting
paths, |
boolean |
supportsNodeQuery()
Tests if a
NodeQuery is available. |
boolean |
supportsStartingNodeQuery()
Tests if a
NodeQuery is available for a starting node. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchComplete(boolean match)
match
- true
to match complete paths,
false
to match inactive pathsmandatory
- This method must be implemented. void clearCompleteTerms()
mandatory
- This method must be implemented. void matchClosed(boolean match)
match
- true
to match closed paths, false
to match inactive pathsmandatory
- This method must be implemented. void clearClosedTerms()
mandatory
- This method must be implemented. void matchStartingNodeId(Id nodeId, boolean match)
Id
for this query to match paths with a
starting node.nodeId
- the node Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- nodeId
is
null
mandatory
- This method must be implemented. void clearStartingNodeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsStartingNodeQuery()
NodeQuery
is available for a starting node. true
if a node query is available, false
otherwisemandatory
- This method must be implemented. NodeQuery getStartingNodeQuery()
OR
term.UnimplementedException
-
supportsStartingNodeQuery()
is false
optional
- This method must be implemented if
supportsStartingNodeQuery()
is true.
void clearStartingNodeTerms()
mandatory
- This method must be implemented. void matchEndingNodeId(Id nodeId, boolean match)
Id
for this query to match paths with an
ending node.nodeId
- the node Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- nodeId
is
null
mandatory
- This method must be implemented. void clearEndingNodeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsEndingNodeQuery()
NodeQuery
is available for an ending node. true
if a node query is available, false
otherwisemandatory
- This method must be implemented. NodeQuery getEndingNodeQuery()
OR
term.UnimplementedException
-
supportsEndingNodeQuery()
is false
optional
- This method must be implemented if
supportsEndingNodeQuery()
is true.
void clearEndingNodeTerms()
mandatory
- This method must be implemented. void matchAlongNodeIds(Id[] nodeIds, boolean match)
Ids
for this query to match paths along
the given nodes.nodeIds
- the node Ids
match
- true
for a positive match, false
for a negative matchNullArgumentException
- nodeIds
is
null
mandatory
- This method must be implemented. void clearAlongNodeIdsTerms()
Id
query terms.mandatory
- This method must be implemented. void matchIntersectingPathId(Id pathId, boolean match)
Id
for this query to match paths
intersecting with another 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 clearIntersectingPathIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsIntersectingPathQuery()
PathQuery
is available for intersecting
paths, true
if a path query is available, false
otherwisemandatory
- This method must be implemented. PathQuery getIntersectingPathQuery()
OR
term.UnimplementedException
-
supportsIntersectingPathQuery()
is false
optional
- This method must be implemented if
supportsIntersectingPathQuery()
is true.
void matchAnyIntersectingPath(boolean match)
match
- true
to match paths with any intersecting
path, false
to match paths with no intersecting
pathmandatory
- This method must be implemented. void clearIntersectingPathTerms()
mandatory
- This method must be implemented. void matchHops(long from, long to, boolean match)
from
- starting rangeto
- ending rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
mandatory
- This method must be implemented. void clearHopsTerms()
mandatory
- This method must be implemented. void matchDistance(java.math.BigDecimal from, java.math.BigDecimal to, boolean match)
from
- starting rangeto
- ending rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
mandatory
- This method must be implemented. void matchAnyDistance(boolean match)
match
- true
to match paths with any distance,
false
to match paths with no distance assignedmandatory
- This method must be implemented. void clearDistanceTerms()
mandatory
- This method must be implemented. void matchCost(java.math.BigDecimal from, java.math.BigDecimal to, boolean match)
from
- starting rangeto
- ending rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
is less
than from
mandatory
- This method must be implemented. void clearCostTerms()
mandatory
- This method must be implemented. void matchNodeId(Id nodeId, boolean match)
Id
for this query to match paths that
pass through nodes.nodeId
- the node Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- nodeId
is
null
mandatory
- This method must be implemented. void clearNodeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsNodeQuery()
NodeQuery
is available. true
if a node query is available, false
otherwisemandatory
- This method must be implemented. NodeQuery getNodeQuery()
OR
term.UnimplementedException
- supportsNodeQuery()
is false
optional
- This method must be implemented if
supportsNodeQuery()
is true.
void clearNodeTerms()
mandatory
- This method must be implemented. void matchEdgeId(Id edgeId, boolean match)
Id
for this query to match paths contain
the edge.edgeId
- the edge Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- edgeId
is
null
mandatory
- This method must be implemented. void clearEdgeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsEdgeQuery()
EdgeQuery
is available. true
if an edge query is available,
false
otherwisemandatory
- This method must be implemented. EdgeQuery getEdgeQuery()
OR
term.UnimplementedException
- supportsEdgeQuery()
is false
optional
- This method must be implemented if
supportsEdgeQuery()
is true.
void clearEdgeTerms()
mandatory
- This method must be implemented. void matchGraphId(Id graphId, boolean match)
Id
for this query to match edges
assigned to graphs.graphId
- the graph Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- graphId
is
null
mandatory
- This method must be implemented. void clearGraphIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsGraphQuery()
GraphQuery
is available. true
if a graph query is available,
false
otherwisemandatory
- This method must be implemented. GraphQuery getGraphQuery()
OR
term.UnimplementedException
- supportsGraphQuery()
is false
optional
- This method must be implemented if
supportsGraphQuery()
is true.
void clearGraphTerms()
mandatory
- This method must be implemented. PathQueryRecord getPathQueryRecord(Type pathRecordType) throws OperationFailedException
Path
record Type.
Multiple record retrievals produce
a nested OR
term.pathRecordType
- a path record typeNullArgumentException
- pathRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(pathRecordType)
is false
mandatory
- This method must be implemented.