atomicgrounding.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.grounding;

import org.mindswap.owl.OWLResource;
import org.mindswap.owls.process.AtomicProcess;
import org.mindswap.owls.process.ValueMap;

/**
 * Represents a grounding for AtomicProcesses. There is no corresponding concept in OWL-S ontology because OWL-S
 * ontology only describes WSDL gorunding. But this class is a base class for both
 * {@link org.mindswap.owls.grounding.WSDLAtomicGrounding WSDLAtomicGrounding} and
 * {@link org.mindswap.owls.grounding.UPnPAtomicGrounding UPnPAtomicGrounding} classes.
 * 
 * @author Evren Sirin
 *
 */
public interface AtomicGrounding extends OWLResource {
	/**
	 * Get a URL that describes the properties of this grounding. The nature of the file
	 * depends on the actual grounding type, e.g. WSDL grounding will return the WSDL
	 * document whereas  the UPNP rgounding may return the UPnP presentation URL  
	 * 
	 * @return
	 */
	public String getDescriptionURL();
	
	/**
	 * Get the AtomicProcess object for this grounding
	 * 
	 * @return
	 */
	public AtomicProcess getProcess();
	
	/**
	 * Set the AtomicProcess object for this grounding
	 * 
	 * @param process
	 */
	public void setProcess(AtomicProcess process);
	
	/**
	 * Get the mappings between the OWL-S inputs and grounding operation inputs
	 * 
	 * @return
	 */
	public MessageMapList getInputMap();
	
	/**
	 * Get the mappings between the OWL-S outputs and grounding operation outputs
	 * 
	 * @return
	 */
	public MessageMapList getOutputMap();	
	
	/**
	 * Invoke this grounding with the given input values
	 * 
	 * @param values
	 * @return
	 * @throws Exception
	 */
	public ValueMap invoke(ValueMap values) throws Exception;
}