v2tov3task.java

一个java写的business process management系统

/*
 * Copyright (c) 2003, Alexander Greif
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Flow4J-Eclipse project nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

package net.orthanc.flow4j.flows.updateflowfile;

import java.io.File;

import net.orthanc.flow4j.runtime.AbstractTaskFlowlet;
import net.orthanc.flow4j.runtime.FlowDictionary;
import net.orthanc.flow4j.runtime.descriptors.TaskParameterDescriptors;
import net.orthanc.flow4j.runtime.descriptors.TaskPropertyDescriptors;

import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * @author agreif
 *
 * This task converts flow files from version 2 to version 3
 */
public class V2ToV3Task extends AbstractTaskFlowlet {

	/**
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#getTaskName()
	 */
	public String getName() {
		return "V2ToV3";
	}


	/**
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#getDescription()
	 */
	public String getDescription() {
		return "Updates version 2 to version 3";
	}



	/* 
	 * TODO
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#getPropertyDescriptors()
	 */
	public TaskPropertyDescriptors getPropertyDescriptors() {
		return null;
	}

	/* 
	 * TODO
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#getInputParameterDescriptors()
	 */
	public TaskParameterDescriptors getInputParameterDescriptors() {
		TaskParameterDescriptors d = new TaskParameterDescriptors();
		d.addParameterDescriptor(UpdateFlowFileConsts.KEY_DOM_DOC, Document.class, "the DOM document to update");
		
		return d;
	}


	/**
	 * Updates version 2 to version 3
	 * @see net.orthanc.flow4j.runtime.IFlowlet#execute(net.orthanc.flow4j.runtime.FlowDictionary)
	 */
	public void execute(FlowDictionary dictionary) {
		Document document =
			(Document) dictionary.get(UpdateFlowFileConsts.KEY_DOM_DOC);
		File flowFile =
			(File) dictionary.get(UpdateFlowFileConsts.KEY_FLOW_FILE);

		updateDocument(document, flowFile);
	}

	/**
	 * Updates the document contents
	 * <ul>
	 * <li>add attribute flowname to root element</li>
	 * <li>change name of root element to flowmodel</li>
	 * </ul>
	 * @param document
	 */
	private void updateDocument(Document document, File flowFile) {
		//	add attribute flowname to root element
		Attr flowNameAttr = document.createAttribute("flowname");
		String flowFileName = flowFile.getName();
		String flowName =
			flowFileName.substring(0, flowFileName.lastIndexOf("."));
		flowNameAttr.setValue(flowName);
		((Element) document.getDocumentElement()).setAttributeNode(
			flowNameAttr);

		//	Obtain the root element
		Element element = document.getDocumentElement();
		//	rename name of root elem
		UpdateFlowFileUtils.renameElement(document, element, "flowmodel");
	}



}