trunk/workflowmodel-api/src/main/java/net/sf/taverna/t2/workflowmodel/serialization/xml/XMLDeserializer.java

/*******************************************************************************
 * Copyright (C) 2007 The University of Manchester   
 * 
 *  Modifications to the initial code base are copyright of their
 *  respective authors, or their employers as appropriate.
 * 
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2.1 of
 *  the License, or (at your option) any later version.
 *    
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *    
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 ******************************************************************************/
package net.sf.taverna.t2.workflowmodel.serialization.xml;

import net.sf.taverna.t2.workflowmodel.Dataflow;
import net.sf.taverna.t2.workflowmodel.EditException;
import net.sf.taverna.t2.workflowmodel.Edits;
import net.sf.taverna.t2.workflowmodel.serialization.DeserializationException;

import org.jdom.Element;

/**
 * The API that defines the entry point for deserialising a complete dataflow XML document into a dataflow instance.
 * 
 * @author Stuart Owen
 *
 */
public interface XMLDeserializer {
	
	/**
	 * Deserialises a complete dataflow document into a Dataflow instance.
	 * 
	 * @param element a jdom element holding the XML document that represents the dataflow
	 * @return an instance of the Dataflow
	 * @throws DeserializationException
	 * @throws EditException - should an error occur whilst constructing the dataflow via Edits
	 * 
	 * @see Edits
	 */
	public Dataflow deserializeDataflow(Element element) throws DeserializationException,EditException;
	
}