startflowletmodelpart.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.designer.model;

import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;

import net.orthanc.flow4j.Flow4JConsts;
import net.orthanc.flow4j.designer.core.Flow4JPlugin;
import net.orthanc.flow4j.designer.model.propertysources.StartPropertiesPropertySource;

import org.eclipse.ui.views.properties.PropertyDescriptor;
import org.eclipse.ui.views.properties.TextPropertyDescriptor;

/**
 * @author agreif
 *
 * Model part of the start flowlet.
 */
public class StartFlowletModelPart extends FlowletWithLabelModelPart {

	private static final String PROP_PROPERTY_NAMES = "startFlowletProperty_names"; //$NON-NLS-1$
	public static final String PROP_START_PROPERTIES = "start_properties"; //$NON-NLS-1$

	private Set startFlowletPropertyDescriptors = null;
	/**	The StartFlowlet's properties	*/
	private Map startProperties;

	/**
	 * @see net.orthanc.flow4j.designer.model.FlowletModelPart#getType()
	 */
	public String getType() {
		return Flow4JConsts.START;
	}

	/**
	 * Returns the name of the resource entry that contains the property name
	 * @return key in the resources file
	 * @see net.orthanc.flow4j.designer.model.FlowletWithLabelModelPart#getLabelPropertyNameResource()
	 */
	protected String getLabelPropertyNameResource() {
		return "PropertyDescriptor_StartFlowlet.label";
	}

	/**
	 * Collects all property descriptors. Those of
	 * the superclass and those of this class
	 * @return Collection with all Property descriptors
	 */
	protected Collection getPropertyDescriptorsCollection() {
		//	allways create new ones
		createPropertyDescriptors();

		return startFlowletPropertyDescriptors;
	}

	/**
	 * Creates the property descriptors if they have not been
	 * created yet. The following descriptor is added:<br>
	 * TextPropertyDescriptor for the flowlet's label
	 */
	private void createPropertyDescriptors() {
		startFlowletPropertyDescriptors =
			new HashSet(super.getPropertyDescriptorsCollection());
		startFlowletPropertyDescriptors.add(
			new TextPropertyDescriptor(
				PROP_PROPERTY_NAMES,
				Flow4JPlugin.getResourceString(
					"PropertyDescriptor_StartFlowlet_Propertynames.label")));

		if (hasPropertyDescs())
			startFlowletPropertyDescriptors.add(
				new PropertyDescriptor(
					PROP_START_PROPERTIES,
					Flow4JPlugin.getResourceString(
						"PropertyDescriptor_StartFlowlet_Properties.label")));
	}

	/**
	 * Returns whether the StartFlowlet has Property property descriptors
	 * to show in the properties view.
	 * @return  whether the StartFlowlet has Property property descriptors
	 */
	private boolean hasPropertyDescs() {
		return startProperties != null && !startProperties.isEmpty();
	}

	/**
	 * Returns an Object which represents the appropriate
	 * value for the property name supplied.
	 * In case of label property the request will be routed to the label modelPart.
	 *
	 * @see org.eclipse.ui.views.properties.IPropertySource#getPropertyValue(java.lang.Object)
	 * @param propName  Name of the property for which the
	 *                  the values are needed.
	 * @return  Object which is the value of the property.
	 */
	public Object getPropertyValue(Object propName) {
		if (PROP_PROPERTY_NAMES.equals(propName)) {
			StringBuffer buf = new StringBuffer();
			if (startProperties != null)
				for (Iterator iter = startProperties.keySet().iterator();
					iter.hasNext();
					) {
					buf.append(iter.next());
					if (iter.hasNext())
						buf.append(", ");
				}
			return buf.toString();
		} else if (PROP_START_PROPERTIES.equals(propName)) {
			if (hasPropertyDescs())
				return new StartPropertiesPropertySource(this);
			else
				return null;
		} else
			return super.getPropertyValue(propName);
	}

	/**
	 * Sets the value of a given property with the value
	 * supplied. Also fires a property change if necessary.
	 * 
	 * @see org.eclipse.ui.views.properties.IPropertySource#setPropertyValue(java.lang.Object, java.lang.Object)
	 * @param id  Name of the parameter to be changed.
	 * @param value  Value to be set to the given parameter.
	 */
	public void setPropertyValue(Object id, Object value) {
		if (PROP_PROPERTY_NAMES.equals(id)) {
			Map oldProps =
				startProperties != null ? startProperties : new HashMap();
			startProperties = new HashMap();
			StringTokenizer st = new StringTokenizer((String) value, ",");
			while (st.hasMoreTokens()) {
				String key = st.nextToken().trim();
				String oldValue = (String)oldProps.get(key);
				startProperties.put(key, oldValue != null ? oldValue : "");
			}
		} else
			super.setPropertyValue(id, value);
	}

	/**
	 * Returns the StartFlowlet's properties or <code>null</code> if it has none
	 * @return the StartFlowlet's properties or <code>null</code> if it has none
	 */
	public Map getStartProperties() {
		return startProperties;
	}

	/**
	 * Sets the StartFlowlet's properties Map
	 * @param map the Map contzaining the properites
	 */
	public void setStartProperties(Map map) {
		startProperties = map;
	}

}