public interface OntologyQuery extends OsidCatalogQuery
This is the query for searching ontologies. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorOntologyIdTerms()
Clears the ancestor ontology
Id terms for this query. |
void |
clearAncestorOntologyTerms()
Clears the ancestor ontology terms for this query.
|
void |
clearDescendantOntologyIdTerms()
Clears the descendant ontology
Id terms for this query. |
void |
clearDescendantOntologyTerms()
Clears the descendant ontology terms for this query.
|
void |
clearRelevancyIdTerms()
Clears the relevancy
Id terms for this query. |
void |
clearRelevancyTerms()
Clears the relevancy terms for this query.
|
void |
clearSubjectIdTerms()
Clears the subject
Id terms for this query. |
void |
clearSubjectTerms()
Clears the subject terms for this query.
|
OntologyQuery |
getAncestorOntologyQuery()
Gets the query for an ontology.
|
OntologyQuery |
getDescendantOntologyQuery()
Gets the query for an ontology.
|
OntologyQueryRecord |
getOntologyQueryRecord(Type ontologyRecordType)
Gets the ontology query record corresponding to the given
Ontology record Type. |
RelevancyQuery |
getRelevancyQuery()
Gets the query for a relevancy.
|
SubjectQuery |
getSubjectQuery()
Gets the query for a subject.
|
void |
matchAncestorOntologyId(Id ontologyId,
boolean match)
Sets the ontology
Id for this query to match ontologies
that have the specified ontology as an ancestor. |
void |
matchAnyAncestorOntology(boolean match)
Matches ontologies with any ancestor.
|
void |
matchAnyDescendantOntology(boolean match)
Matches ontologies with any descendant.
|
void |
matchAnyRelevancy(boolean match)
Matches ontologies that have any relevancy.
|
void |
matchAnySubject(boolean match)
Matches ontologies that have any subject.
|
void |
matchDescendantOntologyId(Id ontologyId,
boolean match)
Sets the ontology
Id for this query to match ontologies
that have the specified ontology as a descendant. |
void |
matchRelevancyId(Id relevancyId,
boolean match)
Sets the relevancy
Id for this query. |
void |
matchSubjectId(Id subjectId,
boolean match)
Sets the subject
Id for this query. |
boolean |
supportsAncestorOntologyQuery()
Tests if an
OntologyQuery is available. |
boolean |
supportsDescendantOntologyQuery()
Tests if an
OntologyQuery is available. |
boolean |
supportsRelevancyQuery()
Tests if a
RelevancyQuery is available. |
boolean |
supportsSubjectQuery()
Tests if a
SubjectQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectRelevancyTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, 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 matchSubjectId(Id subjectId, boolean match)
Id
for this query.matchSubjectId
in interface OsidObjectQuery
subjectId
- a subject Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- subjectId
is
null
mandatory
- This method must be implemented. void clearSubjectIdTerms()
Id
terms for this query.clearSubjectIdTerms
in interface OsidObjectQuery
mandatory
- This method must be implemented. boolean supportsSubjectQuery()
SubjectQuery
is available.supportsSubjectQuery
in interface OsidObjectQuery
true
if a subject query is available,
false
otherwisemandatory
- This method must be implemented. SubjectQuery getSubjectQuery()
OR
term.getSubjectQuery
in interface OsidObjectQuery
UnimplementedException
- supportsSubjectQuery()
is false
optional
- This method must be implemented if
supportsSubjectQuery()
is true.
void matchAnySubject(boolean match)
matchAnySubject
in interface OsidObjectQuery
match
- true
to match ontologies with any
subject, false
to match ontologies with no
subjectmandatory
- This method must be implemented. void clearSubjectTerms()
clearSubjectTerms
in interface OsidObjectQuery
mandatory
- This method must be implemented. void matchRelevancyId(Id relevancyId, boolean match)
Id
for this query.relevancyId
- a relevancy Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- relevancyId
is
null
mandatory
- This method must be implemented. void clearRelevancyIdTerms()
Id
terms for this query.mandatory
- This method must be implemented. boolean supportsRelevancyQuery()
RelevancyQuery
is available. true
if a relevancy query is available,
false
otherwisemandatory
- This method must be implemented. RelevancyQuery getRelevancyQuery()
OR
term.UnimplementedException
-
supportsRelevancyQuery()
is false
optional
- This method must be implemented if
supportsRelevancyQuery()
is true.
void matchAnyRelevancy(boolean match)
match
- true
to match ontologies with any
relevancy, false
to match ontologies with no
relevancymandatory
- This method must be implemented. void clearRelevancyTerms()
mandatory
- This method must be implemented. void matchAncestorOntologyId(Id ontologyId, boolean match)
Id
for this query to match ontologies
that have the specified ontology as an ancestor.ontologyId
- an ontology Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- ontologyId
is
null
mandatory
- This method must be implemented. void clearAncestorOntologyIdTerms()
Id
terms for this query.mandatory
- This method must be implemented. boolean supportsAncestorOntologyQuery()
OntologyQuery
is available. true
if an ontology query is available,
false
otherwisemandatory
- This method must be implemented. OntologyQuery getAncestorOntologyQuery()
OR
term.UnimplementedException
-
supportsAncestorOntologyQuery()
is false
optional
- This method must be implemented if
supportsAncestorOntologyQuery()
is true.
void matchAnyAncestorOntology(boolean match)
match
- true
to match ontologies with any
ancestor, false
to match root ontologiesmandatory
- This method must be implemented. void clearAncestorOntologyTerms()
mandatory
- This method must be implemented. void matchDescendantOntologyId(Id ontologyId, boolean match)
Id
for this query to match ontologies
that have the specified ontology as a descendant.ontologyId
- an ontology Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- ontologyId
is
null
mandatory
- This method must be implemented. void clearDescendantOntologyIdTerms()
Id
terms for this query.mandatory
- This method must be implemented. boolean supportsDescendantOntologyQuery()
OntologyQuery
is available. true
if an ontology query is available,
false
otherwisemandatory
- This method must be implemented. OntologyQuery getDescendantOntologyQuery()
OR
term.UnimplementedException
-
supportsDescendantOntologyQuery()
is false
optional
- This method must be implemented if
supportsDescendantOntologyQuery()
is true.
void matchAnyDescendantOntology(boolean match)
match
- true
to match ontologies with any
descendant, false
to match leaf ontologiesmandatory
- This method must be implemented. void clearDescendantOntologyTerms()
mandatory
- This method must be implemented. OntologyQueryRecord getOntologyQueryRecord(Type ontologyRecordType) throws OperationFailedException
Ontology
record Type.
Multiple record
retrievals produce a nested OR
term.ontologyRecordType
- a ontology record typeNullArgumentException
- ontologyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(ontologyRecordType)
is false
mandatory
- This method must be implemented.