setversiontask.java

一个java写的business process management系统

/*
 * Copyright (c) 2003-2004, 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 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;

/**
 * Class SetVersionTask TODO
 * @author greifa
 * 
 */
public class SetVersionTask extends AbstractTaskFlowlet {

	/* 
	 * Returns the task name
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#getName()
	 */
	public String getName() {
		return "set version (${version})";
	}

	/* 
	 * Sets the flow file's version
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#execute(net.orthanc.flow4j.runtime.FlowDictionary)
	 */
	public void execute(FlowDictionary dict) {
		Document document = (Document)dict.get(UpdateFlowFileConsts.KEY_DOM_DOC);
				Attr versionAttr =
					((Element) document.getDocumentElement()).getAttributeNode(
						"version");
				int newVersion = Integer.parseInt(getProperty("version"));
				versionAttr.setValue(""+newVersion);

				dict.put(UpdateFlowFileConsts.KEY_VERSION, new Integer(newVersion));
	}




	/* 
	 * TODO
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#getDescription()
	 */
	public String getDescription() {
		return "Sets the flowXML file's version";
	}

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

	/* 
	 * TODO
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#getOutputParameterDescriptors()
	 */
	public TaskParameterDescriptors getOutputParameterDescriptors() {
		TaskParameterDescriptors d = new TaskParameterDescriptors();
		d.addParameterDescriptor(UpdateFlowFileConsts.KEY_VERSION, Integer.class, "the flow xml file's new version");
		return d;
	}

	/* 
	 * Returns the task's properties.
	 * @see net.orthanc.flow4j.runtime.ITaskFlowlet#getPropertyDescriptors()
	 */
	public TaskPropertyDescriptors getPropertyDescriptors() {
		TaskPropertyDescriptors d = new TaskPropertyDescriptors();
		d.addPropertyDescriptor("version", "the new version");
		return d;
	}

}