org.wsmo.common
Interface TopEntity

All Superinterfaces:
Entity
All Known Subinterfaces:
Capability, GGMediator, Goal, Interface, Mediator, Ontology, OOMediator, ServiceDescription, WebService, WGMediator, WWMediator

public interface TopEntity
extends Entity

Base class for top level WSMO entities (ontologies, mediators, goals, services + capabilities and interfaces)

Since:
0.4.0
Version:
$Revision: 1.2 $ $Date: 2005/09/21 08:15:39 $
Author:
not attributable

Method Summary
 void addMediator(Mediator mediator)
          Adds a reference to a new mediator to this element's used mediators list.
 void addNamespace(Namespace ns)
          add a namespace in the contaioner
 void addOntology(Ontology ontology)
          Adds an ontology to this element's imported ontologies list
 Namespace findNamespace(java.lang.String prefix)
          finds a namespace by its prefix
 Namespace getDefaultNamespace()
          retrieve the default namespace
 java.lang.String getWsmlVariant()
          returns the WSML variant used for the definition of this entity
 java.util.Set listMediators()
          Returns the list of used mediators.
 java.util.Set listNamespaces()
          retrieves all avalible namespaces
 java.util.Set listOntologies()
          Returns a list of ontologies which this element imports.
 void removeMediator(IRI iri)
          Removes a reference to a mediator from this element's used mediator list.
 void removeMediator(Mediator mediator)
          Removes a reference to a mediator from this element's used mediator list.
 void removeNamespace(Namespace ns)
          remove namespace from the top entity
 void removeNamespace(java.lang.String prefix)
          remove namespace from the top entity
 void removeOntology(IRI iri)
          Removes an ontology from the list of ontolgies which this element imports.
 void removeOntology(Ontology ontology)
          Removes an ontology from the list of ontolgies which this element imports.
 void setDefaultNamespace(IRI iri)
          sets a default namespace for the container
 void setDefaultNamespace(Namespace ns)
          sets a default namespace for the container
 void setWsmlVariant(java.lang.String variant)
          specifies the WSML variant used for the definition of this entity
 
Methods inherited from interface org.wsmo.common.Entity
addNFPValue, addNFPValue, getIdentifier, listNFPValues, listNFPValues, removeNFP, removeNFPValue, removeNFPValue
 

Method Detail

getWsmlVariant

java.lang.String getWsmlVariant()
returns the WSML variant used for the definition of this entity

Returns:
the name of the WSML variant (as string)
See Also:
WSML, setWsmlVariant(String variant)

setWsmlVariant

void setWsmlVariant(java.lang.String variant)
specifies the WSML variant used for the definition of this entity

Parameters:
variant - the name of the WSML variant (as string)
See Also:
WSML

listNamespaces

java.util.Set listNamespaces()
retrieves all avalible namespaces

Returns:
a set of namespaces
See Also:
Namespace

addNamespace

void addNamespace(Namespace ns)
add a namespace in the contaioner

Parameters:
ns - to add
See Also:
removeNamespace(String), removeNamespace(Namespace)

removeNamespace

void removeNamespace(java.lang.String prefix)
remove namespace from the top entity

Parameters:
prexif - prexif of the namespcae to be removed

removeNamespace

void removeNamespace(Namespace ns)
remove namespace from the top entity

Parameters:
ns - namespace to be removed

findNamespace

Namespace findNamespace(java.lang.String prefix)
finds a namespace by its prefix

Parameters:
prefix - of a namespace to look for
Returns:
a namesspace with such prefix or null if not found

getDefaultNamespace

Namespace getDefaultNamespace()
retrieve the default namespace

Returns:
default namespace or null if not set
See Also:
setDefaultNamespace(Namespace ns), setDefaultNamespace(IRI iri)

setDefaultNamespace

void setDefaultNamespace(Namespace ns)
sets a default namespace for the container

Parameters:
ns - namespace to set as default
See Also:
setDefaultNamespace(IRI iri)

setDefaultNamespace

void setDefaultNamespace(IRI iri)
sets a default namespace for the container

Parameters:
iri - IRI of namespace to set as default
See Also:
setDefaultNamespace(Namespace ns)

addMediator

void addMediator(Mediator mediator)
Adds a reference to a new mediator to this element's used mediators list.

Parameters:
mediator - the used mediator reference
See Also:
removeMediator(Mediator mediator)

removeMediator

void removeMediator(Mediator mediator)
Removes a reference to a mediator from this element's used mediator list.

Parameters:
mediator - The mediator to be removed from this element's list of used mediators.

removeMediator

void removeMediator(IRI iri)
Removes a reference to a mediator from this element's used mediator list.

Parameters:
iri - The ID of the mediator to be removed from this element's list of used mediators.

listMediators

java.util.Set listMediators()
Returns the list of used mediators.

Returns:
: The list of used mediators.
See Also:
Mediator

addOntology

void addOntology(Ontology ontology)
Adds an ontology to this element's imported ontologies list

Parameters:
ontology - The ontology to be imported.
See Also:
removeOntology(Ontology ontology), removeOntology(IRI iri)

removeOntology

void removeOntology(IRI iri)
Removes an ontology from the list of ontolgies which this element imports.

Parameters:
iri - The ID of the ontology to be removed from this element's imported ontologies list.

removeOntology

void removeOntology(Ontology ontology)
Removes an ontology from the list of ontolgies which this element imports.

Parameters:
ontology - The ontology to be removed from this element's imported ontologies list.

listOntologies

java.util.Set listOntologies()
Returns a list of ontologies which this element imports.

Returns:
: The list of ontologies that this element imports.
See Also:
Ontology