valuemap.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.util.Map;

/**
 * This interface provides a way to assign values to OWL-S parameters. When a process needs to be
 * executed the values for the input parameters are specified with this interface. The result of
 * the execution is also given with this interface
 * 
 * @author Evren Sirin
 *
 */
public interface ValueMap extends Map {
	/**
	 * Set the value of the given parameter
	 * 
	 * @param p
	 * @param value
	 */
	public void    setValue(Parameter p, Object value);
	
	/**
	 * Get the value of the given parameter
	 * 
	 * @param p
	 * @return
	 */
	public Object  getValue(Parameter p);
	
	/**
	 * Return true if the given parameter has been assigned a value
	 * 
	 * @param p
	 * @return
	 */
	public boolean hasValue(Parameter p);
	
	/**
	 * Clear the value that has been assigned to the given parameter
	 * 
	 * @param p
	 */
	public void    clearValue(Parameter p);

	
	/**
	 * Add all the value bindings that has been defined in the given ValueMap.
	 * 
	 * @param valueMap
	 */
	
	public void    addMap(ValueMap valueMap);
	
	/**
	 * Add some more value bindings according to the given DataFlow. If the DataFlow has a mapping
	 * out -> in and the ValueMap contains a value binding out -> value than a new value binding
	 * in -> value is added. This method helps to propogate the value bindings according to the 
	 * data flow specs.  
	 * 
	 * @param dataFlow
	 */	
	public void    applyDataFlow(DataFlow dataFlow);
	
	/**
	 * Same as applyDataFlow(DataFlow) but may perform some transformation according to the given
	 * ValueRewriter if the types of the parameters in the data flow are not same. This may be 
	 * useful in the cases where data flow maps two parameters that has types defined in different 
	 * ontologies. At that point a rewriting may be necessary to transform the value
	 * 
	 * @param dataFlow
	 * @param rewriter
	 */
	public void    applyDataFlow(DataFlow dataFlow, ValueRewriter rewriter);

	/**
	 * Remove all the value bindings except for the parameters given in the list.  
	 * 
	 * @param params
	 */	
	public void    retainValues(ParameterList params);
	
}