org.w3.y2001.sw.Europe.skos
Interface SKOSThesaurus


public interface SKOSThesaurus

The Simple Knowledge Organisation System (SKOS) API

This is an interface that generates a Web Service description in WSDL for providing access to a thesauri web service. It is developed by the Thesaurus Activity of the SWAD-Europe project

Please send feedback to the public-esw-thes list archived at http://lists.w3.org/Archives/Public/public-esw-thes/

Version:
$Revision: 1.2 $ . 2004-06-01 Renamed to SKOSThesaurus from Service and made the following changes to the methods: getConceptsMatchingKeywords: renamed to getConceptsMatchingKeyword and takes a single String keyword parameter. getConceptByInternalID: deleted getConceptsMatchingKeywordsByThesaurus: renamed to getConceptsMatchingKeywordByThesaurus and takes a single String keyword parameter.
Author:
Dave Beckett, Nikki Rogers, Alistair Miles.

Method Summary
 Concept[] getAllConceptRelatives(Concept concept)
          Get a list of all concept relatives.
 Concept[] getAllConceptRelativesByThesaurus(Concept concept, URI thesaurus)
          Get a list of all concept relatives for a particular thesaurus.
 ConceptRelatives[] getAllConceptsByPath(Concept concept, Relation relation, int distance)
          Get a list of all concept relatives up to some distance
 Concept getConcept(URI uri)
          Get a concept by a known URI.
 Concept getConceptByExternalID(java.lang.String externalID, URI thesaurus)
          Get a concept by its non-URI ID for a particular thesaurus.
 Concept getConceptByPreferredLabel(java.lang.String preferredLabel, URI thesaurus)
          Get a concept by its preferred label for a particular thesaurus.
 Concept[] getConceptRelatives(Concept concept, Relation relation)
          Get a list of the concept relatives with a semantic relation.
 ConceptRelatives[] getConceptRelativesByPath(Concept concept, Relation relation, URI thesaurus, int distance)
          Get a list of concept relatives for a particular thesaurus up to some distance.
 Concept[] getConceptRelativesByThesaurus(Concept concept, Relation relation, URI thesaurus)
          Get a list of concept relatives with a semantic relation for a particular thesaurus.
 Concept[] getConceptsMatchingKeyword(java.lang.String keyword)
          Get a list of concepts matching a keyword
 Concept[] getConceptsMatchingKeywordByThesaurus(java.lang.String keyword, URI thesaurus)
          Get a list of concepts matching a keyword for a particular thesaurus.
 Concept[] getConceptsMatchingRegex(java.lang.String regexp)
          Get a list of concepts matching a regex.
 Concept[] getConceptsMatchingRegexByThesaurus(java.lang.String regexp, URI thesaurus)
          Get a list of concepts matching a regex for a particular thesaurus.
 Relation[] getSupportedSemanticRelations()
          Get a list of supported semantic relations.
 Relation[] getSupportedSemanticRelationsByThesaurus(URI thesaurus)
          Get a list of supported semantic relations for a particular thesaurus.
 Concept[] getTopConcepts(Concept concept, URI thesaurus)
          Get the top concept(s) of a concept
 Concept[] getTopmostConcepts(URI thesaurus)
          Get the top concepts of a thesaurus.
 

Method Detail

getConcept

public Concept getConcept(URI uri)
Get a concept by a known URI.

Parameters:
uri - The concept uri.

getConceptsMatchingKeyword

public Concept[] getConceptsMatchingKeyword(java.lang.String keyword)
Get a list of concepts matching a keyword


getConceptsMatchingRegex

public Concept[] getConceptsMatchingRegex(java.lang.String regexp)
Get a list of concepts matching a regex.

Parameters:
regexp - The regular expression to match. The resulting concepts are returned ordered according to likelihood

getSupportedSemanticRelations

public Relation[] getSupportedSemanticRelations()
Get a list of supported semantic relations. For example things such as broader, narrower, is-a each with a unique uri, a description of their meaning and human readable label.


getConceptRelatives

public Concept[] getConceptRelatives(Concept concept,
                                     Relation relation)
Get a list of the concept relatives with a semantic relation.

Parameters:
concept - The concept.
relation - The semantic relation to use to find relatives.

getAllConceptRelatives

public Concept[] getAllConceptRelatives(Concept concept)
Get a list of all concept relatives.

Parameters:
concept - The concept.

getTopmostConcepts

public Concept[] getTopmostConcepts(URI thesaurus)
Get the top concepts of a thesaurus.

Parameters:
thesaurus - The URI of the thesaurus.

getTopConcepts

public Concept[] getTopConcepts(Concept concept,
                                URI thesaurus)
Get the top concept(s) of a concept

Parameters:
concept - The concept.
thesaurus - The URI of the thesaurus.

getConceptByPreferredLabel

public Concept getConceptByPreferredLabel(java.lang.String preferredLabel,
                                          URI thesaurus)
Get a concept by its preferred label for a particular thesaurus.

Parameters:
preferredLabel - The preferred label of the concept.
thesaurus - The URI of the thesaurus.

getConceptByExternalID

public Concept getConceptByExternalID(java.lang.String externalID,
                                      URI thesaurus)
Get a concept by its non-URI ID for a particular thesaurus.

Parameters:
externalID - The concept non-URI external ID.
thesaurus - The URI of the thesaurus.

getConceptsMatchingKeywordByThesaurus

public Concept[] getConceptsMatchingKeywordByThesaurus(java.lang.String keyword,
                                                       URI thesaurus)
Get a list of concepts matching a keyword for a particular thesaurus.

Parameters:
thesaurus - The URI of the thesaurus. The resulting concepts are returned ordered according to likelihood

getConceptsMatchingRegexByThesaurus

public Concept[] getConceptsMatchingRegexByThesaurus(java.lang.String regexp,
                                                     URI thesaurus)
Get a list of concepts matching a regex for a particular thesaurus.

Parameters:
regexp - The regular expression to match.
thesaurus - The URI of the thesaurus. The resulting concepts are returned ordered according to likelihood

getSupportedSemanticRelationsByThesaurus

public Relation[] getSupportedSemanticRelationsByThesaurus(URI thesaurus)
Get a list of supported semantic relations for a particular thesaurus.

Parameters:
thesaurus - The URI of the thesaurus. For example things such as broader, narrower, is-a each with a unique uri, a description of their meaning and human readable label.

getConceptRelativesByThesaurus

public Concept[] getConceptRelativesByThesaurus(Concept concept,
                                                Relation relation,
                                                URI thesaurus)
Get a list of concept relatives with a semantic relation for a particular thesaurus.

Parameters:
concept - The concept.
thesaurus - The URI of the thesaurus.
relation - The semantic relation.

getAllConceptRelativesByThesaurus

public Concept[] getAllConceptRelativesByThesaurus(Concept concept,
                                                   URI thesaurus)
Get a list of all concept relatives for a particular thesaurus.

Parameters:
concept - The concept.
thesaurus - The URI of the thesaurus.

getConceptRelativesByPath

public ConceptRelatives[] getConceptRelativesByPath(Concept concept,
                                                    Relation relation,
                                                    URI thesaurus,
                                                    int distance)
Get a list of concept relatives for a particular thesaurus up to some distance.

Parameters:
concept - The concept.
relation - The semantic relation.
thesaurus - The URI of the thesaurus.
distance - The distance The concepts returned are up to 'distance' relations away.

getAllConceptsByPath

public ConceptRelatives[] getAllConceptsByPath(Concept concept,
                                               Relation relation,
                                               int distance)
Get a list of all concept relatives up to some distance

Parameters:
concept - The concept.
relation - The semantic relation.
distance - The distance The concepts returned are up to 'distance' relations away.