Interface EdgeQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface EdgeQuery
extends OsidRelationshipQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearBiDirectionalTerms()	Clears the directional terms.
void	clearCostTerms()	Clears the cost terms.
void	clearDestinationNodeIdTerms()	Clears the related node Id terms.
void	clearDestinationNodeTerms()	Clears the related node terms.
void	clearDirectionalTerms()	Clears the directional terms.
void	clearDistanceTerms()	Clears the distance terms.
void	clearGraphIdTerms()	Clears the graph Id terms.
void	clearGraphTerms()	Clears the graph terms.
void	clearSameNodeTerms()	Clears the same node terms.
void	clearSourceNodeIdTerms()	Clears the node Id terms.
void	clearSourceNodeTerms()	Clears the node terms.
NodeQuery	getDestinationNodeQuery()	Gets the query for a related node.
EdgeQueryRecord	getEdgeQueryRecord(Type edgeRecordType)	Gets the edge query record corresponding to the given Edge record Type .Multiple record retrievals produce a nested OR term.
GraphQuery	getGraphQuery()	Gets the query for a graph.
NodeQuery	getSourceNodeQuery()	Gets the query for a node.
void	matchAnyCost(boolean match)	Matches edges that has any cost assigned.
void	matchAnyDistance(boolean match)	Matches edges that has any distance assigned.
void	matchBiDirectional(boolean match)	Matches bi-directional edges.
void	matchCost(BigDecimal from, BigDecimal to, boolean match)	Matches edges that have the specified cost inclusive.
void	matchDestinationNodeId(Id nodeId, boolean match)	Sets the related node Id for this query to match edges assigned to nodes.
void	matchDirectional(boolean match)	Matches directional edges.
void	matchDistance(BigDecimal from, BigDecimal to, boolean match)	Matches edges that have the specified distance inclusive.
void	matchGraphId(Id graphId, boolean match)	Sets the graph Id for this query to match edges assigned to graphs.
void	matchSameNode(boolean match)	Matches edges between the same node.
void	matchSourceNodeId(Id nodeId, boolean match)	Sets the node Id for this query to match edges assigned to nodes.
boolean	supportsDestinationNodeQuery()	Tests if a NodeQuery is available.
boolean	supportsGraphQuery()	Tests if a GraphQuery is available.
boolean	supportsSourceNodeQuery()	Tests if a NodeQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

matchSourceNodeId

void matchSourceNodeId(Id nodeId,
 boolean match)

Sets the node Id for this query to match edges assigned to nodes.

Parameters:

nodeId - the node Id

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

Throws:

NullArgumentException - nodeId is null

Compliance:

mandatory - This method must be implemented.

clearSourceNodeIdTerms

void clearSourceNodeIdTerms()

Clears the node Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSourceNodeQuery

boolean supportsSourceNodeQuery()

Tests if a NodeQuery is available.

Returns:

true if a node query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSourceNodeQuery

NodeQuery getSourceNodeQuery()

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

Returns:

the node query

Throws:

UnimplementedException - supportsSourceNodeQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSourceNodeQuery()} is {@code true} .

clearSourceNodeTerms

void clearSourceNodeTerms()

Clears the node terms.

Compliance:

mandatory - This method must be implemented.

matchDestinationNodeId

void matchDestinationNodeId(Id nodeId,
 boolean match)

Sets the related node Id for this query to match edges assigned to nodes.

Parameters:

nodeId - the node Id

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

Throws:

NullArgumentException - nodeId is null

Compliance:

mandatory - This method must be implemented.

clearDestinationNodeIdTerms

void clearDestinationNodeIdTerms()

Clears the related node Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDestinationNodeQuery

boolean supportsDestinationNodeQuery()

Tests if a NodeQuery is available.

Returns:

true if a node query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDestinationNodeQuery

NodeQuery getDestinationNodeQuery()

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

Returns:

the node query

Throws:

UnimplementedException - supportsDestinationNodeQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDestinationNodeQuery()} is {@code true} .

clearDestinationNodeTerms

void clearDestinationNodeTerms()

Clears the related node terms.

Compliance:

mandatory - This method must be implemented.

matchSameNode

void matchSameNode(boolean match)

Matches edges between the same node.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearSameNodeTerms

void clearSameNodeTerms()

Clears the same node terms.

Compliance:

mandatory - This method must be implemented.

matchDirectional

void matchDirectional(boolean match)

Matches directional edges.

Parameters:

match - true to match directional edges, false otherwise

Compliance:

mandatory - This method must be implemented.

clearDirectionalTerms

void clearDirectionalTerms()

Clears the directional terms.

Compliance:

mandatory - This method must be implemented.

matchBiDirectional

void matchBiDirectional(boolean match)

Matches bi-directional edges.

Parameters:

match - true to match bi-directional edges, false to match uni-directional edges

Compliance:

mandatory - This method must be implemented.

clearBiDirectionalTerms

void clearBiDirectionalTerms()

Clears the directional terms.

Compliance:

mandatory - This method must be implemented.

matchCost

void matchCost(BigDecimal from,
 BigDecimal to,
 boolean match)

Matches edges that have the specified cost inclusive.

Parameters:

from - starting range

to - ending range

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

Throws:

InvalidArgumentException - to is less than from

Compliance:

mandatory - This method must be implemented.

matchAnyCost

void matchAnyCost(boolean match)

Matches edges that has any cost assigned.

Parameters:

match - true to match edges with any cost, false to match edges with no cost assigned

Compliance:

mandatory - This method must be implemented.

clearCostTerms

void clearCostTerms()

Clears the cost terms.

Compliance:

mandatory - This method must be implemented.

matchDistance

void matchDistance(BigDecimal from,
 BigDecimal to,
 boolean match)

Matches edges that have the specified distance inclusive.

Parameters:

from - starting range

to - ending range

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

Throws:

InvalidArgumentException - to is less than from

Compliance:

mandatory - This method must be implemented.

matchAnyDistance

void matchAnyDistance(boolean match)

Matches edges that has any distance assigned.

Parameters:

match - true to match edges with any distance, false to match edges with no distance assigned

Compliance:

mandatory - This method must be implemented.

clearDistanceTerms

void clearDistanceTerms()

Clears the distance terms.

Compliance:

mandatory - This method must be implemented.

matchGraphId

void matchGraphId(Id graphId,
 boolean match)

Sets the graph Id for this query to match edges assigned to graphs.

Parameters:

graphId - the 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.

clearGraphIdTerms

void clearGraphIdTerms()

Clears the graph Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGraphQuery

boolean supportsGraphQuery()

Tests if a GraphQuery is available.

Returns:

true if a graph query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGraphQuery

GraphQuery getGraphQuery()

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

Returns:

the graph query

Throws:

UnimplementedException - supportsGraphQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsGraphQuery()} is {@code true} .

clearGraphTerms

void clearGraphTerms()

Clears the graph terms.

Compliance:

mandatory - This method must be implemented.

getEdgeQueryRecord

EdgeQueryRecord getEdgeQueryRecord(Type edgeRecordType)
                            throws OperationFailedException

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

Parameters:

edgeRecordType - an edge record type

Returns:

the edge query record

Throws:

NullArgumentException - edgeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeRecordType) is false

Compliance:

mandatory - This method must be implemented.