org.semanticweb.skos
Interface SKOSDataset


public interface SKOSDataset

Author: Simon Jupp
Date: Apr 21, 2008
The University of Manchester
Bio-Health Informatics Group

A SKOSDataset is the central point of access to your SKOS vocabularies. The SKOS vocabulary is managed by a SKOSManager. A SKOSDataset can be thought of as an OWL Ontology which conatins a single or multiple SKOS concept schemes.
Because the SKOS API is built on top of the OWL API we use an OWLOntology to represent our SKOS Vocabularies, you always have access to the underlying OWLOntology, but in most cases you should be fine just using the SKOSDataset directly.


Method Summary
 java.util.Set<SKOSConcept> getConceptsInScheme(SKOSConceptScheme scheme)
          Convenience method for getting the set of Concept that are asserted to be in this scheme
 java.util.Set<SKOSDataRelationAssertion> getReferencingSKOSDataRelationAssertions(SKOSEntity skosEntity)
          Get the set of SKOS object assertions that invove the current SKOS entity
 java.util.Set<SKOSObjectRelationAssertion> getReferencingSKOSObjectRelationAssertions(SKOSEntity skosEntity)
          Get the set of SKOS object assertions that invove the current SKOS entity
 java.util.Set<SKOSAnnotation> getSKOSAnnotations(SKOSEntity entity)
          Get the set of SKOS annotations asserted on a SKOS entity
 java.util.Set<SKOSAnnotation> getSKOSAnnotationsByURI(SKOSEntity entity, java.net.URI annotationURI)
          Get the set of SKOS annotations by URI asserted on a SKOSEntity
 java.util.Set<SKOSConcept> getSKOSConcepts()
          The set of Concepts in this vocabualry
 java.util.Set<SKOSConceptScheme> getSKOSConceptSchemes()
          Get the set of Concept Schemes in this vocabulary
 java.util.Set<SKOSDataRelationAssertion> getSKOSDataRelationAssertions(SKOSEntity skosEntity)
          Get the set of SKOS entities related to the current entity by SKOS data properties
 java.util.Set<SKOSLiteral> getSKOSDataRelationByProperty(SKOSEntity entity, SKOSDataProperty property)
          Get the set of SKOS entities related to a particular concept by a SKOS data property
 SKOSEntity getSKOSEntity(java.lang.String shortForm)
          Query the vocabulary for a Entity, this will query the URI fragment of the entity URI.
 java.util.Set<SKOSLabelRelation> getSKOSLabelRelations(SKOSConcept concept)
          Get the set of label relations asserted on a particular concept
 java.util.Set<SKOSObjectRelationAssertion> getSKOSObjectRelationAssertions(SKOSEntity skosEntity)
          Get the set of SKOS entities related to the current entity by SKOS object properties
 java.util.Set<SKOSEntity> getSKOSObjectRelationByProperty(SKOSEntity entity, SKOSObjectProperty property)
          Get the set of SKOS entities related to a particular concept by a SKOS object property
 java.util.Set<SKOSConcept> getTopConcepts(SKOSConceptScheme scheme)
          Convenience method for getting the set of Concepts that are top concepts in a particular Concept Scheme
 java.net.URI getURI()
          This is the URI for the OWL Ontology that contains the SKOSVocabularies
 

Method Detail

getSKOSEntity

SKOSEntity getSKOSEntity(java.lang.String shortForm)
Query the vocabulary for a Entity, this will query the URI fragment of the entity URI. In addition it will query the prefLAbel, altLabel and hiddenLabel value.

Parameters:
shortForm -
Returns:
SKOSEntity A SKOS enity such as a SKOSConcept, SKOSConceptScheme or SKOSLabelRelation

getURI

java.net.URI getURI()
This is the URI for the OWL Ontology that contains the SKOSVocabularies

Returns:
URI Returns the URI for the Ontology that contains the SKOS vocabularies

getSKOSConceptSchemes

java.util.Set<SKOSConceptScheme> getSKOSConceptSchemes()
Get the set of Concept Schemes in this vocabulary

Returns:
Set

getSKOSConcepts

java.util.Set<SKOSConcept> getSKOSConcepts()
The set of Concepts in this vocabualry

Returns:
Set

getTopConcepts

java.util.Set<SKOSConcept> getTopConcepts(SKOSConceptScheme scheme)
Convenience method for getting the set of Concepts that are top concepts in a particular Concept Scheme

Parameters:
scheme - The concept scheme you want the top cponcepts from
Returns:
Set All concepts at the top of this concept scheme

getConceptsInScheme

java.util.Set<SKOSConcept> getConceptsInScheme(SKOSConceptScheme scheme)
Convenience method for getting the set of Concept that are asserted to be in this scheme

Parameters:
scheme - The concept scheme that contains the concepts
Returns:
Set The set of concepts in that scheme

getSKOSObjectRelationAssertions

java.util.Set<SKOSObjectRelationAssertion> getSKOSObjectRelationAssertions(SKOSEntity skosEntity)
Get the set of SKOS entities related to the current entity by SKOS object properties

Parameters:
skosEntity - The entity you want to query
Returns:
SKOSObjectRelationAssertion The set of object relations asserted on this entity

getReferencingSKOSObjectRelationAssertions

java.util.Set<SKOSObjectRelationAssertion> getReferencingSKOSObjectRelationAssertions(SKOSEntity skosEntity)
Get the set of SKOS object assertions that invove the current SKOS entity

Parameters:
skosEntity - The entity you want to query
Returns:
SKOSObjectRelationAssertion The set of object relations asserted on this entity

getSKOSDataRelationAssertions

java.util.Set<SKOSDataRelationAssertion> getSKOSDataRelationAssertions(SKOSEntity skosEntity)
Get the set of SKOS entities related to the current entity by SKOS data properties

Parameters:
skosEntity - The entity you want to query
Returns:
Set Set of Data relation assertions.

getReferencingSKOSDataRelationAssertions

java.util.Set<SKOSDataRelationAssertion> getReferencingSKOSDataRelationAssertions(SKOSEntity skosEntity)
Get the set of SKOS object assertions that invove the current SKOS entity

Parameters:
skosEntity - The entity you want to query
Returns:
SKOSObjectRelationAssertion The set of object relations asserted on this entity

getSKOSObjectRelationByProperty

java.util.Set<SKOSEntity> getSKOSObjectRelationByProperty(SKOSEntity entity,
                                                          SKOSObjectProperty property)
Get the set of SKOS entities related to a particular concept by a SKOS object property

Parameters:
entity - The concept you want to query
property - The SKOSObject property to follow
Returns:
Set Set of SKOS entities related by the specified property

getSKOSDataRelationByProperty

java.util.Set<SKOSLiteral> getSKOSDataRelationByProperty(SKOSEntity entity,
                                                         SKOSDataProperty property)
Get the set of SKOS entities related to a particular concept by a SKOS data property

Parameters:
entity - The concept you want to query
property - The SKOSData property to follow
Returns:
Set Set of SKOS entities related by the specified property

getSKOSAnnotationsByURI

java.util.Set<SKOSAnnotation> getSKOSAnnotationsByURI(SKOSEntity entity,
                                                      java.net.URI annotationURI)
Get the set of SKOS annotations by URI asserted on a SKOSEntity

Parameters:
entity - The entity you want to query
annotationURI - The URI for the SKOS annotation
Returns:
Set Set of SKOSAnnotations

getSKOSAnnotations

java.util.Set<SKOSAnnotation> getSKOSAnnotations(SKOSEntity entity)
Get the set of SKOS annotations asserted on a SKOS entity

Parameters:
entity - The entity you want to query
Returns:
Set Set of SKOSAnnotations

getSKOSLabelRelations

java.util.Set<SKOSLabelRelation> getSKOSLabelRelations(SKOSConcept concept)
Get the set of label relations asserted on a particular concept

Parameters:
concept - The concept you want to query
Returns:
Set Set of Label Relations