org.osid.topology

Interface GraphQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.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

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.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchNodeId

void matchNodeId(Id nodeId,
               boolean match)

Sets the node Id for this query to match graphs that have a related node.

Parameters:

nodeId - a node Id

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

Throws:

NullArgumentException - nodeId is null

Compliance:

mandatory - This method must be implemented.

clearNodeIdTerms

void clearNodeIdTerms()

Clears the node Id terms.

Compliance:

mandatory - This method must be implemented.

supportsNodeQuery

boolean supportsNodeQuery()

Tests if a NodeQuery is available.

Returns:

true if a node query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getNodeQuery

NodeQuery getNodeQuery()

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

Returns:

the node query

Throws:

UnimplementedException - supportsNodeQuery() is false

Compliance:

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

matchAnyNode

void matchAnyNode(boolean match)

Matches graphs that have any node.

Parameters:

match - true to match graphs with any node, false to match graphs with no node

Compliance:

mandatory - This method must be implemented.

clearNodeTerms

void clearNodeTerms()

Clears the node terms.

Compliance:

mandatory - This method must be implemented.

matchEdgeId

void matchEdgeId(Id edgeId,
               boolean match)

Sets the edge Id for this query to match graphs containing edges.

Parameters:

edgeId - the edge Id

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

Throws:

NullArgumentException - edgeId is null

Compliance:

mandatory - This method must be implemented.

clearEdgeIdTerms

void clearEdgeIdTerms()

Clears the edge Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEdgeQuery

boolean supportsEdgeQuery()

Tests if an EdgeQuery is available.

Returns:

true if an edge query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEdgeQuery

EdgeQuery getEdgeQuery()

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

Returns:

the edge query

Throws:

UnimplementedException - supportsEdgeQuery() is false

Compliance:

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

matchAnyEdge

void matchAnyEdge(boolean match)

Matches graphs that have any edge.

Parameters:

match - true to match graphs with any edge, false to match graphs with no edge

Compliance:

mandatory - This method must be implemented.

clearEdgeTerms

void clearEdgeTerms()

Clears the edge terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorGraphId

void matchAncestorGraphId(Id graphId,
                        boolean match)

Sets the graph Id for this query to match graphs that have the specified graph as an ancestor.

Parameters:

graphId - a graph Id

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

Throws:

NullArgumentException - graphId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorGraphIdTerms

void clearAncestorGraphIdTerms()

Clears the ancestor graph Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorGraphQuery

boolean supportsAncestorGraphQuery()

Tests if a GraphQuery is available.

Returns:

true if a graph query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorGraphQuery

GraphQuery getAncestorGraphQuery()

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

Returns:

the graph query

Throws:

UnimplementedException - supportsAncestorGraphQuery() is false

Compliance:

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

matchAnyAncestorGraph

void matchAnyAncestorGraph(boolean match)

Matches graphs with any ancestor.

Parameters:

match - true to match graphs with any ancestor, false to match root graphs

Compliance:

mandatory - This method must be implemented.

clearAncestorGraphTerms

void clearAncestorGraphTerms()

Clears the ancestor graph terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantGraphId

void matchDescendantGraphId(Id graphId,
                          boolean match)

Sets the graph Id for this query to match graphs that have the specified graph as a descendant.

Parameters:

graphId - a graph Id

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

Throws:

NullArgumentException - graphId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantGraphIdTerms

void clearDescendantGraphIdTerms()

Clears the descendant graph Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantGraphQuery

boolean supportsDescendantGraphQuery()

Tests if a GraphQuery is available.

Returns:

true if a graph query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantGraphQuery

GraphQuery getDescendantGraphQuery()

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

Returns:

the graph query

Throws:

UnimplementedException - supportsDescendantGraphQuery() is false

Compliance:

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

matchAnyDescendantGraph

void matchAnyDescendantGraph(boolean match)

Matches graphs with any descendant.

Parameters:

match - true to match graphs with any descendant, false to match leaf graphs

Compliance:

mandatory - This method must be implemented.

clearDescendantGraphTerms

void clearDescendantGraphTerms()

Clears the descendant graph terms.

Compliance:

mandatory - This method must be implemented.

getGraphQueryRecord

GraphQueryRecord getGraphQueryRecord(Type graphRecordType)
                                     throws OperationFailedException

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

Parameters:

graphRecordType - a graph record type

Returns:

the graph query record

Throws:

NullArgumentException - graphRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(graphRecordType) is false

Compliance:

mandatory - This method must be implemented.