org.deri.wsmo4j.choreography.signature
Class StateSignatureRI

java.lang.Object
  extended by com.ontotext.wsmo4j.common.EntityImpl
      extended by org.deri.wsmo4j.choreography.signature.StateSignatureRI
All Implemented Interfaces:
Iterable<Mode>, org.wsmo.common.Entity, StateSignature

public class StateSignatureRI
extends com.ontotext.wsmo4j.common.EntityImpl
implements StateSignature

Reference implementation for the State Signature.

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

Version:
$Revision: 1844 $ $Date: 2006-10-24 17:11:48 +0300 (Tue, 24 Oct 2006) $
Author:
Thomas Haselwanter, James Scicluna

Field Summary
protected  Set<Controlled> controlledModeDefinition
           
protected  Set<In> inModeDefinition
           
protected  Set<Out> outModeDefinition
           
protected  Set<Shared> sharedModeDefinition
           
protected  Set<Static> staticModeDefinition
           
 
Constructor Summary
StateSignatureRI(org.wsmo.common.Identifier id)
          Constructor initializing a state signature with an IRI and empty sets of modes
StateSignatureRI(org.wsmo.common.Identifier id, Set<In> inModeDefinition, Set<Out> outModeDefinition, Set<Shared> sharedModeDefinition, Set<Static> staticModeDefinition, Set<Controlled> controlledModeDefinition)
          Constructor initializing a state signature with an IRI and 5 sets of the specific types of modes
StateSignatureRI(org.wsmo.common.Identifier id, Set<Mode> modes)
          Constructor initializing a state signature with an IRI and a set of modes
 
Method Summary
 void add(Controlled mode)
          Adds a mode of type Controlled
 void add(In mode)
          Adds a mode of type In
 void add(Out mode)
          Adds a mode of type Out
 void add(Set<Mode> modes)
          Adds a set of modes to the respective containers
 void add(Shared mode)
          Adds a mode of type Shared
 void add(Static mode)
          Adds a mode of type Static
 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
 Iterator<Mode> iterator()
           
 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 remove(Controlled mode)
          Removes an Out mode from the state signature
 void remove(In mode)
          Removes an In mode from the state signature
 void remove(Out mode)
          Removes an Out mode from the state signature
 void remove(Shared mode)
          Removes an Out mode from the state signature
 void remove(Static mode)
          Removes an Out mode from the state signature
 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 class com.ontotext.wsmo4j.common.EntityImpl
addNFPValue, addNFPValue, equals, getIdentifier, hashCode, listNFPValues, listNFPValues, removeNFP, removeNFPValue, removeNFPValue
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.wsmo.common.Entity
addNFPValue, addNFPValue, getIdentifier, listNFPValues, listNFPValues, removeNFP, removeNFPValue, removeNFPValue
 

Field Detail

inModeDefinition

protected Set<In> inModeDefinition

outModeDefinition

protected Set<Out> outModeDefinition

sharedModeDefinition

protected Set<Shared> sharedModeDefinition

staticModeDefinition

protected Set<Static> staticModeDefinition

controlledModeDefinition

protected Set<Controlled> controlledModeDefinition
Constructor Detail

StateSignatureRI

public StateSignatureRI(org.wsmo.common.Identifier id)
Constructor initializing a state signature with an IRI and empty sets of modes

Parameters:
id - An IRI object defining the identifier of the state signature

StateSignatureRI

public StateSignatureRI(org.wsmo.common.Identifier id,
                        Set<Mode> modes)
Constructor initializing a state signature with an IRI and a set of modes

Parameters:
id - An IRI object defining the identifier of the state signature
modes - A Set of Mode objects which define the modes in the state signature.

StateSignatureRI

public StateSignatureRI(org.wsmo.common.Identifier id,
                        Set<In> inModeDefinition,
                        Set<Out> outModeDefinition,
                        Set<Shared> sharedModeDefinition,
                        Set<Static> staticModeDefinition,
                        Set<Controlled> controlledModeDefinition)
Constructor initializing a state signature with an IRI and 5 sets of the specific types of modes

Parameters:
id - An IRI object defining the identifier of the state signature
inModeDefinition - A Set of In mode definitions
outModeDefinition - A Set of Out mode definitions
sharedModeDefinition - A Set of Shared mode definitions
staticModeDefinition - A Set of Static mode definitions
controlledModeDefinition - A Set of Controlled mode definitions
Method Detail

listInModes

public Set<In> listInModes()
Description copied from interface: StateSignature
Lists the In Modes

Specified by:
listInModes in interface StateSignature
Returns:
Set of concept references and groundings for the In Mode

listOutModes

public Set<Out> listOutModes()
Description copied from interface: StateSignature
Lists the Out Modes

Specified by:
listOutModes in interface StateSignature
Returns:
Set of concept references and groundings for the Out Mode

listSharedModes

public Set<Shared> listSharedModes()
Description copied from interface: StateSignature
Lists the Shared Modes

Specified by:
listSharedModes in interface StateSignature
Returns:
Set of concept references and groundings (if any) for the Shared Mode

listStaticModes

public Set<Static> listStaticModes()
Description copied from interface: StateSignature
Lists the Static Mode

Specified by:
listStaticModes in interface StateSignature
Returns:
Set of concept references for the Static Mode

listControlledModes

public Set<Controlled> listControlledModes()
Description copied from interface: StateSignature
Lists the Controlled Mode

Specified by:
listControlledModes in interface StateSignature
Returns:
Set of concept references for the Controlled Mode

add

public void add(In mode)
Adds a mode of type In

Parameters:
mode - An In mode object

remove

public void remove(In mode)
Removes an In mode from the state signature

Parameters:
mode - An In mode object to be removed

add

public void add(Out mode)
Adds a mode of type Out

Parameters:
mode - An Out mode object

remove

public void remove(Out mode)
Removes an Out mode from the state signature

Parameters:
mode - An Out mode object to be removed

add

public void add(Shared mode)
Adds a mode of type Shared

Parameters:
mode - An Shared mode object

remove

public void remove(Shared mode)
Removes an Out mode from the state signature

Parameters:
mode - An Out mode object to be removed

add

public void add(Static mode)
Adds a mode of type Static

Parameters:
mode - An Static mode object

remove

public void remove(Static mode)
Removes an Out mode from the state signature

Parameters:
mode - An Out mode object to be removed

add

public void add(Controlled mode)
Adds a mode of type Controlled

Parameters:
mode - An Controlled mode object

remove

public void remove(Controlled mode)
Removes an Out mode from the state signature

Parameters:
mode - An Out mode object to be removed

addMode

public void addMode(Mode mode)
Description copied from interface: StateSignature
Adds a particular mode to the signature

Specified by:
addMode in interface StateSignature

removeMode

public void removeMode(Mode mode)
Description copied from interface: StateSignature
Removes a particular mode from the state signature

Specified by:
removeMode in interface StateSignature
Parameters:
mode - The Mode object to be removed

add

public void add(Set<Mode> modes)
Adds a set of modes to the respective containers

Parameters:
modes - A set of Mode objects to be added to the state signature

addOntology

public void addOntology(org.omwg.ontology.Ontology ontology)
Description copied from interface: StateSignature
Adds an ontology to this element's imported ontologies list

Specified by:
addOntology in interface StateSignature
Parameters:
ontology - The ontology to be imported.
See Also:
StateSignature.removeOntology(Ontology ontology), StateSignature.removeOntology(IRI iri)

removeOntology

public void removeOntology(org.wsmo.common.IRI iri)
Description copied from interface: StateSignature
Removes an ontology from the list of ontolgies which this element imports.

Specified by:
removeOntology in interface StateSignature
Parameters:
iri - The ID of the ontology to be removed from this element's imported ontologies list.

removeOntology

public void removeOntology(org.omwg.ontology.Ontology ontology)
Description copied from interface: StateSignature
Removes an ontology from the list of ontolgies which this element imports.

Specified by:
removeOntology in interface StateSignature
Parameters:
ontology - The ontology to be removed from this element's imported ontologies list.

listOntologies

public Set<org.omwg.ontology.Ontology> listOntologies()
Description copied from interface: StateSignature
Returns a list of ontologies which this element imports.

Specified by:
listOntologies in interface StateSignature
Returns:
: The list of ontologies that this element imports.
See Also:
Ontology

addMediator

public void addMediator(org.wsmo.mediator.OOMediator mediator)
Description copied from interface: StateSignature
Adds a reference to a new oo-mediator to this element's used mediators list.

Specified by:
addMediator in interface StateSignature
Parameters:
mediator - the used mediator reference
See Also:
#removeMediator(Mediator mediator)

removeMediator

public void removeMediator(org.wsmo.mediator.OOMediator mediator)
Description copied from interface: StateSignature
Removes a reference to a mediator from this element's used mediator list.

Specified by:
removeMediator in interface StateSignature
Parameters:
mediator - The mediator to be removed from this element's list of used mediators.

removeMediator

public void removeMediator(org.wsmo.common.IRI iri)
Description copied from interface: StateSignature
Removes a reference to a oo-mediator from this element's used mediator list.

Specified by:
removeMediator in interface StateSignature
Parameters:
iri - The ID of the mediator to be removed from this element's list of used mediators.

listMediators

public Set listMediators()
Description copied from interface: StateSignature
Returns the list of used mediators.

Specified by:
listMediators in interface StateSignature
Returns:
: The list of used mediators.
See Also:
Mediator

iterator

public Iterator<Mode> iterator()
Specified by:
iterator in interface Iterable<Mode>


Copyright © 2004-2008 Ontotext Lab.. All Rights Reserved.