org.wsmo.common
Interface Entity

All Known Subinterfaces:
Attribute, Axiom, Capability, Choreography, Concept, GGMediator, Goal, Instance, Interface, Mediator, Ontology, OntologyElement, OOMediator, Orchestration, Relation, RelationInstance, ServiceDescription, TopEntity, WebService, WGMediator, WWMediator

public interface Entity

Base class for all WSMO entities.

Version:
$Revision: 1.11 $ $Date: 2005/09/27 13:10:24 $
Author:
not attributable

Method Summary
 void addNFPValue(IRI key, Identifier value)
          Adds a value to the list of values associated with this key.
 void addNFPValue(IRI key, Value value)
          Adds a value to the list of values associated with this key.
 Identifier getIdentifier()
          Returns the ID of this entity.
 java.util.Map listNFPValues()
          Returns all the NFP with their values as java.util.Map.
 java.util.Set listNFPValues(IRI key)
          Returns the list of values associated with the specified key.
 void removeNFP(IRI key)
          Removes a NFP (e.g.
 void removeNFPValue(IRI key, Identifier value)
          Removes a value from the list of values associated with a specific key.
 void removeNFPValue(IRI key, Value value)
          Removes a value from the list of values associated with a specific key.
 

Method Detail

listNFPValues

java.util.Set listNFPValues(IRI key)
                            throws SynchronisationException
Returns the list of values associated with the specified key.

Parameters:
key - The key (IRI) of interest.
Returns:
A list of values associated with the specified key.
Throws:
SynchronisationException
See Also:
NFP

listNFPValues

java.util.Map listNFPValues()
                            throws SynchronisationException
Returns all the NFP with their values as java.util.Map. The Map entries are (key, set-of-values-for-that-key)

Returns:
A Map holding the NFPs and values
Throws:
SynchronisationException
See Also:
NFP

addNFPValue

void addNFPValue(IRI key,
                 Identifier value)
                 throws SynchronisationException,
                        InvalidModelException
Adds a value to the list of values associated with this key.

Parameters:
key - The key of interest.
value - Identifier or DataValue to be added to the list of values associated with this key.
Throws:
SynchronisationException
InvalidModelException
See Also:
NFP

addNFPValue

void addNFPValue(IRI key,
                 Value value)
                 throws SynchronisationException,
                        InvalidModelException
Adds a value to the list of values associated with this key.

Parameters:
key - The key of interest.
value - Identifier or DataValue to be added to the list of values associated with this key.
Throws:
SynchronisationException
InvalidModelException
See Also:
NFP

removeNFPValue

void removeNFPValue(IRI key,
                    Identifier value)
                    throws SynchronisationException,
                           InvalidModelException
Removes a value from the list of values associated with a specific key.

Parameters:
key - The key of interest.
value - Identifier or DataValue to be removed from the list of values associated with the specified key.
Throws:
SynchronisationException
InvalidModelException
See Also:
NFP

removeNFPValue

void removeNFPValue(IRI key,
                    Value value)
                    throws SynchronisationException,
                           InvalidModelException
Removes a value from the list of values associated with a specific key.

Parameters:
key - The key of interest.
value - Identifier or DataValue to be removed from the list of values associated with the specified key.
Throws:
SynchronisationException
InvalidModelException
See Also:
NFP

removeNFP

void removeNFP(IRI key)
               throws SynchronisationException,
                      InvalidModelException
Removes a NFP (e.g. all key/value pairs) associated with a specific key.

Parameters:
key - The key of interest.
Throws:
SynchronisationException
InvalidModelException
See Also:
NFP

getIdentifier

Identifier getIdentifier()
Returns the ID of this entity.

Returns:
The ID of this entity.