process.java

开发owl的API,提供了W3C规定标准接口,是目前比较少的API.

// The MIT License
//
// Copyright (c) 2004 Evren Sirin
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

/*
 * Created on Dec 27, 2003
 *
 */
package org.mindswap.owls.process;

import java.net.URI;

import org.mindswap.owls.profile.Profile;
import org.mindswap.owls.service.Service;

/**
 * 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
 *
 */
public interface Process extends ProcessComponent {
	/**
	 * Set the service this process belongs to. 
	 * 
	 * @param service
	 */
	public void setService(Service service);
	
	/**
	 * 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.   
	 * 
	 * @return
	 */
	public Service getService();
	
	/**
	 * Get the profile for the service of this project. This is equivalent to getService().getProfile()
	 * 
	 * @return
	 */
	public Profile getProfile();
		
	/**
	 * Get the inputs of this process. An empty list is returned if there are no inputs.
	 * 
	 * @return
	 */
	public InputList  getInputs();
	
	/**
	 * Get the outputs of this process. An empty list is returned if there are no outputs.
	 * 
	 * @return
	 */
	public OutputList getOutputs();
	
	/**
	 * Get the preconditions of this process. An empty list is returned if there are no preconditions.
	 * 
	 * @return
	 */
	public ConditionList getPreconditions();

	/**
	 * Get the effects of this process. An empty list is returned if there are no effects.
	 * 
	 * @return
	 */
	public EffectList getEffects();
	
	/**
	 * 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.
	 * 
	 * @param parameterURI
	 * @return
	 */
	public Parameter getParameter(URI parameterURI);
	
	/**
	 * Get the default value bindings for the parameters of this service. OWL-S specification
	 * does not explicitly mention this but for a Process description it is possible to assign
	 * a constant value to one of its parameters (possibly using owl:hasValue construct). Constant
	 * values in process descriptions make it easier to reuse the other processes.
	 * Still, It is an application dependent choice to use these values in execution directly or
	 * let the user overwrite the values with the given ValueMap  
	 * 
	 * @return
	 */
	public ValueMap getDefaultValues();
}