org.wsmo.service.signature
Interface StateSignature

All Superinterfaces:

org.wsmo.common.Entity, Iterable<Mode>

All Known Implementing Classes:

StateSignatureRI

public interface StateSignature
extends org.wsmo.common.Entity, Iterable<Mode>

StateSignature defines the containers for the modes and also implements methods to allow the modification of imported ontologies which define the state of the machine.

      Created on Jul 26, 2005
      Committed by $Author: vassil_momtchev $
      $Source$
 

Version:

$Revision: 1849 $ $Date: 2006-10-24 17:56:41 +0300 (Tue, 24 Oct 2006) $

Author:

James Scicluna, Thomas Haselwanter, Holger Lausen

Method Summary

void	addMediator(org.wsmo.mediator.OOMediator mediator) Adds a reference to a new oo-mediator to this element's used mediators list.
void	addMode(Mode mode) Adds a particular mode to the signature
void	addOntology(org.omwg.ontology.Ontology ontology) Adds an ontology to this element's imported ontologies list
Set<Controlled>	listControlledModes() Lists the Controlled Mode
Set<In>	listInModes() Lists the In Modes
Set	listMediators() Returns the list of used mediators.
Set<org.omwg.ontology.Ontology>	listOntologies() Returns a list of ontologies which this element imports.
Set<Out>	listOutModes() Lists the Out Modes
Set<Shared>	listSharedModes() Lists the Shared Modes
Set<Static>	listStaticModes() Lists the Static Mode
void	removeMediator(org.wsmo.common.IRI iri) Removes a reference to a oo-mediator from this element's used mediator list.
void	removeMediator(org.wsmo.mediator.OOMediator mediator) Removes a reference to a mediator from this element's used mediator list.
void	removeMode(Mode mode) Removes a particular mode from the state signature
void	removeOntology(org.wsmo.common.IRI iri) Removes an ontology from the list of ontolgies which this element imports.
void	removeOntology(org.omwg.ontology.Ontology ontology) Removes an ontology from the list of ontolgies which this element imports.

Methods inherited from interface org.wsmo.common.Entity

addNFPValue, addNFPValue, getIdentifier, listNFPValues, listNFPValues, removeNFP, removeNFPValue, removeNFPValue

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

listInModes

Set<In> listInModes()

Lists the In Modes

Returns:

Set of concept references and groundings for the In Mode

listOutModes

Set<Out> listOutModes()

Lists the Out Modes

Returns:

Set of concept references and groundings for the Out Mode

listSharedModes

Set<Shared> listSharedModes()

Lists the Shared Modes

Returns:

Set of concept references and groundings (if any) for the Shared Mode

listStaticModes

Set<Static> listStaticModes()

Lists the Static Mode

Returns:

Set of concept references for the Static Mode

listControlledModes

Set<Controlled> listControlledModes()

Lists the Controlled Mode

Returns:

Set of concept references for the Controlled Mode

addOntology

void addOntology(org.omwg.ontology.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(org.wsmo.common.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(org.omwg.ontology.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

Set<org.omwg.ontology.Ontology> listOntologies()

Returns a list of ontologies which this element imports.

Returns:

: The list of ontologies that this element imports.

See Also:

Ontology

addMediator

void addMediator(org.wsmo.mediator.OOMediator mediator)

Adds a reference to a new oo-mediator to this element's used mediators list.

Parameters:

mediator - the used mediator reference

See Also:

#removeMediator(Mediator mediator)

removeMediator

void removeMediator(org.wsmo.mediator.OOMediator 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(org.wsmo.common.IRI iri)

Removes a reference to a oo-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

Set listMediators()

Returns the list of used mediators.

Returns:

: The list of used mediators.

See Also:

Mediator

addMode

void addMode(Mode mode)

Adds a particular mode to the signature

Parameters:

mode -

removeMode

void removeMode(Mode mode)

Removes a particular mode from the state signature

Parameters:

mode - The Mode object to be removed