public interface GraphQuery extends OsidCatalogQuery
This is the query for searching graphs. 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 |
clearAncestorGraphIdTerms()
Clears the ancestor graph
Id terms. |
void |
clearAncestorGraphTerms()
Clears the ancestor graph terms.
|
void |
clearDescendantGraphIdTerms()
Clears the descendant graph
Id terms. |
void |
clearDescendantGraphTerms()
Clears the descendant graph terms.
|
void |
clearEdgeIdTerms()
Clears the edge
Id terms. |
void |
clearEdgeTerms()
Clears the edge terms.
|
void |
clearNodeIdTerms()
Clears the node
Id terms. |
void |
clearNodeTerms()
Clears the node terms.
|
GraphQuery |
getAncestorGraphQuery()
Gets the query for a graph.
|
GraphQuery |
getDescendantGraphQuery()
Gets the query for a graph.
|
EdgeQuery |
getEdgeQuery()
Gets the query for an edge.
|
GraphQueryRecord |
getGraphQueryRecord(Type graphRecordType)
Gets the graph query record corresponding to the given
Graph
record Type. |
NodeQuery |
getNodeQuery()
Gets the query for a node.
|
void |
matchAncestorGraphId(Id graphId,
boolean match)
Sets the graph
Id for this query to match graphs that
have the specified graph as an ancestor. |
void |
matchAnyAncestorGraph(boolean match)
Matches graphs with any ancestor.
|
void |
matchAnyDescendantGraph(boolean match)
Matches graphs with any descendant.
|
void |
matchAnyEdge(boolean match)
Matches graphs that have any edge.
|
void |
matchAnyNode(boolean match)
Matches graphs that have any node.
|
void |
matchDescendantGraphId(Id graphId,
boolean match)
Sets the graph
Id for this query to match graphs that
have the specified graph as a descendant. |
void |
matchEdgeId(Id edgeId,
boolean match)
Sets the edge
Id for this query to match graphs
containing edges. |
void |
matchNodeId(Id nodeId,
boolean match)
Sets the node
Id for this query to match graphs that
have a related node. |
boolean |
supportsAncestorGraphQuery()
Tests if a
GraphQuery is available. |
boolean |
supportsDescendantGraphQuery()
Tests if a
GraphQuery is available. |
boolean |
supportsEdgeQuery()
Tests if an
EdgeQuery is available. |
boolean |
supportsNodeQuery()
Tests if a
NodeQuery 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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchNodeId(Id nodeId, boolean match)
Id
for this query to match graphs that
have a related node.nodeId
- a node Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- nodeId
is
null
mandatory
- This method must be implemented. void clearNodeIdTerms()
Id
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 matchAnyNode(boolean match)
match
- true
to match graphs with any node,
false
to match graphs with no nodemandatory
- This method must be implemented. void clearNodeTerms()
mandatory
- This method must be implemented. void matchEdgeId(Id edgeId, boolean match)
Id
for this query to match graphs
containing edges.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
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 matchAnyEdge(boolean match)
match
- true
to match graphs with any edge,
false
to match graphs with no edgemandatory
- This method must be implemented. void clearEdgeTerms()
mandatory
- This method must be implemented. void matchAncestorGraphId(Id graphId, boolean match)
Id
for this query to match graphs that
have the specified graph as an ancestor.graphId
- a graph Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- graphId
is
null
mandatory
- This method must be implemented. void clearAncestorGraphIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorGraphQuery()
GraphQuery
is available. true
if a graph query is available,
false
otherwisemandatory
- This method must be implemented. GraphQuery getAncestorGraphQuery()
OR
term.UnimplementedException
-
supportsAncestorGraphQuery()
is false
optional
- This method must be implemented if
supportsAncestorGraphQuery()
is true.
void matchAnyAncestorGraph(boolean match)
match
- true
to match graphs with any ancestor,
false
to match root graphsmandatory
- This method must be implemented. void clearAncestorGraphTerms()
mandatory
- This method must be implemented. void matchDescendantGraphId(Id graphId, boolean match)
Id
for this query to match graphs that
have the specified graph as a descendant.graphId
- a graph Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- graphId
is
null
mandatory
- This method must be implemented. void clearDescendantGraphIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantGraphQuery()
GraphQuery
is available. true
if a graph query is available,
false
otherwisemandatory
- This method must be implemented. GraphQuery getDescendantGraphQuery()
OR
term.UnimplementedException
-
supportsDescendantGraphQuery()
is false
optional
- This method must be implemented if
supportsDescendantGraphQuery()
is true.
void matchAnyDescendantGraph(boolean match)
match
- true
to match graphs with any descendant,
false
to match leaf graphsmandatory
- This method must be implemented. void clearDescendantGraphTerms()
mandatory
- This method must be implemented. GraphQueryRecord getGraphQueryRecord(Type graphRecordType) throws OperationFailedException
Graph
record Type.
Multiple record retrievals produce
a nested OR
term.graphRecordType
- a graph record typeNullArgumentException
- graphRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(graphRecordType)
is false
mandatory
- This method must be implemented.