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

import java.util.Collection;
import java.util.HashSet;

import net.orthanc.flow4j.Flow4JConsts;
import net.orthanc.flow4j.designer.core.Flow4JPlugin;

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

/**
 * The Model Part for the Template Flowlet.
 * @author agreif
 * 
 */
public class TemplateFlowletModelPart extends FlowletWithLabelModelPart {

	public static final String PROP_TEMPLATE_DESCRIPTION = "template_description"; //$NON-NLS-1$

	private HashSet templateFlowletPropertyDescriptors = null;
	private String description = null;


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

	/**
	 * 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_TemplateFlowlet.label";
	}






	/**
	 * Collects all property descriptors. Those of
	 * the superclass and those of this class
	 * @return Collection with all Property descriptors
	 */
	protected Collection getPropertyDescriptorsCollection() {
		if (templateFlowletPropertyDescriptors == null)
			createPropertyDescriptors();

		return templateFlowletPropertyDescriptors;
	}

	/**
	 * Creates the property descriptors if they have not been
	 * created yet. The following descriptor is added:<br>
	 * ROTextPropertyDescriptor for the task's description
	 */
	private void createPropertyDescriptors() {
		if (templateFlowletPropertyDescriptors != null)
			return;

		templateFlowletPropertyDescriptors =
			new HashSet(super.getPropertyDescriptorsCollection());

		templateFlowletPropertyDescriptors.add(
			new TextPropertyDescriptor(
				PROP_TEMPLATE_DESCRIPTION,
				Flow4JPlugin.getResourceString(
					"PropertyDescriptor_TemplateFlowlet_Description.label")));
	}


	/**
	 * 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_TEMPLATE_DESCRIPTION.equals(propName))
			//return flowletLabel.getText();
		return getDescription() == null ? "" : getDescription();
		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_TEMPLATE_DESCRIPTION.equals(id))
			setDescription((String)value);
		else
			super.setPropertyValue(id, value);
	}


	/**
	 * Returns whether the flowlet has a vlid description.
	 * This means that is is not <code>null</code> and length
	 * is not zero.
	 * @return <code>true</code> if the flowlet has a valid description.
	 */
	public boolean hasValidDescription() {
		return getDescription() != null
			&& getDescription().trim().length() != 0;
	}


	/**
	 * @return
	 */
	public String getDescription() {
		return description;
	}

	/**
	 * Sets the description and fires a propety change event.
	 * @param string the description
	 */
	public void setDescription(String string) {
		if (string == null)
			return;
		description = string.trim();
		firePropertyChange(PROP_TEMPLATE_DESCRIPTION, null, description);
	}









}