org.mindswap.owls.process
Interface Process

All Superinterfaces:
Conditional, MultiConditional, OWLEntity, OWLIndividual, OWLObject, OWLValue
All Known Subinterfaces:
AtomicProcess, CompositeProcess, SimpleProcess

public interface Process
extends OWLIndividual, MultiConditional

Represents the OWL-S process. It represents the super class for Atomic, Composite and Simple processes. Properties that all three process classes share are defined here. OWL-S concept: http://www.daml.org/services/owl-s/1.0/Process.owl#Process

Author:
Evren Sirin

Field Summary
static int ANY
           
static int ATOMIC
           
static int COMPOSITE
           
static int SIMPLE
           
 
Method Summary
 void addInput(Input input)
           
 void addLocal(Local local)
           
 void addOutput(Output output)
           
 void addParameter(Parameter param)
           
 void addResult(Result result)
           
 Input createInput(java.net.URI uri, OWLType paramType)
           
 Local createLocal(java.net.URI uri, OWLType paramType)
           
 Output createOutput(java.net.URI uri, OWLType paramType)
           
 Input getInput()
          Return the first input or null if there is no input.
 Input getInput(int i)
           
 Input getInput(java.lang.String localName)
           
 InputList getInputs()
          Get the inputs of this process.
 ParameterList getLocals()
           
 java.lang.String getName()
          Get the name defined for this process.
 java.lang.String getName(java.lang.String lang)
          Get the name defined for this process.
 OWLDataValueList getNames()
          Return all process names written in any language.
 Output getOutput()
          Return the first output or null if there is no input.
 Output getOutput(int i)
           
 Output getOutput(java.lang.String localName)
           
 OutputList getOutputs()
          Get the outputs of this process.
 Parameter getParameter(java.net.URI parameterURI)
          Return the parameter (input or output) with the given URI.
 ParameterList getParameters()
          Get all the parameters of this process.
 Profile getProfile()
          Get the profile for the service of this project.
 Result getResult()
           
 ResultList getResults()
           
 Service getService()
          Get the service this process belongs to.
 void setResult(Result result)
           
 void setService(Service service)
          Set the service this process belongs to.
 
Methods inherited from interface org.mindswap.owl.OWLObject
canCastTo, castTo, debugString, getImplementation, getNextView, setNextView
 
Methods inherited from interface org.mindswap.owl.OWLObject
canCastTo, castTo, debugString, getImplementation, getNextView, setNextView
 
Methods inherited from interface org.mindswap.owls.process.MultiConditional
addCondition, getConditions
 
Methods inherited from interface org.mindswap.owls.process.Conditional
getCondition, setCondition
 
Methods inherited from interface org.mindswap.owl.OWLObject
canCastTo, castTo, debugString, getImplementation, getNextView, setNextView
 
Methods inherited from interface org.mindswap.owl.OWLObject
canCastTo, castTo, debugString, getImplementation, getNextView, setNextView
 

Field Detail

ANY

static final int ANY
See Also:
Constant Field Values

ATOMIC

static final int ATOMIC
See Also:
Constant Field Values

COMPOSITE

static final int COMPOSITE
See Also:
Constant Field Values

SIMPLE

static final int SIMPLE
See Also:
Constant Field Values
Method Detail

setService

void setService(Service service)
Set the service this process belongs to.

Parameters:
service -

getService

Service getService()
Get the service this process belongs to. Actually a process may be used in multiple service descriptions. Unfortunately, OWL-S 1.0 specification does not make a distinction between process definition and process occurence. This implementation treats each process object as a process occurence and returns the service object this process is used in.

Returns:

getProfile

Profile getProfile()
Get the profile for the service of this project. This is equivalent to getService().getProfile()

Returns:

createInput

Input createInput(java.net.URI uri,
                  OWLType paramType)

createOutput

Output createOutput(java.net.URI uri,
                    OWLType paramType)

createLocal

Local createLocal(java.net.URI uri,
                  OWLType paramType)

addInput

void addInput(Input input)

addOutput

void addOutput(Output output)

addLocal

void addLocal(Local local)

addParameter

void addParameter(Parameter param)

addResult

void addResult(Result result)

setResult

void setResult(Result result)

getLocals

ParameterList getLocals()

getInputs

InputList getInputs()
Get the inputs of this process. An empty list is returned if there are no inputs.

Returns:

getInput

Input getInput()
Return the first input or null if there is no input.

Returns:

getInput

Input getInput(int i)

getInput

Input getInput(java.lang.String localName)

getOutputs

OutputList getOutputs()
Get the outputs of this process. An empty list is returned if there are no outputs.

Returns:

getOutput

Output getOutput()
Return the first output or null if there is no input.

Returns:

getOutput

Output getOutput(int i)

getOutput

Output getOutput(java.lang.String localName)

getResult

Result getResult()

getResults

ResultList getResults()

getParameters

ParameterList getParameters()
Get all the parameters of this process. This list includes inputs, outputs and local parameters.

Returns:

getParameter

Parameter getParameter(java.net.URI parameterURI)
Return the parameter (input or output) with the given URI. First check if input list contains the parameter and then check the output list. A null value is returned if the given URI does not exist in either list.

Parameters:
parameterURI -
Returns:

getName

java.lang.String getName()
Get the name defined for this process. See OWLConfig to learn how the language identifiers will be resolved when searching for a name.

Returns:

getName

java.lang.String getName(java.lang.String lang)
Get the name defined for this process. The associated name should have the same language identifier as given in the parameter. If a name for that language is not found null value will be returned even if there is another name with a different language identifier.

Parameters:
lang -
Returns:

getNames

OWLDataValueList getNames()
Return all process names written in any language.

Returns:


Copyright © 2004 Evren Sirin. All Rights Reserved.