flowdiagrammodelpart.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.beans.PropertyChangeListener;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

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

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

/**
 * @author agreif
 *
 * TODO
 * 
 * To change the template for this generated type comment go to
 * Window>Preferences>Java>Code Generation>Code and Comments
 */
public class FlowDiagramModelPart extends Flow4JModelPart
	implements IPropertySource
{

	public static final String CHILDREN = "children"; 	//$NON-NLS-1$
	public static final String PROP_FLOW_NAME = "flow_name"; 	//$NON-NLS-1$

	private static Set flowDiagramElementPropertyDescriptors = null;
	private List children = new ArrayList();
	private String flowName = "";





	/**
	 * Adds a child to the flow model.
	 * @param child
	 */
	public void addChild(FlowDiagramElementModelPart child){
		addChild(child, -1);
	}



	/**
	 * Adds a child's modelpart to the diagram
	 * @param child child model part
	 * @param index
	 */
	public void addChild(FlowDiagramElementModelPart child, int index) {
		if (index >= 0)
			children.add(index,child);
		else
			children.add(child);
			
		fireStructureChange(CHILDREN, child);
	}


	/**
	 * Returns the list of all children's model parts
	 * @return
	 */
	public List getChildren() {
		return children;
	}

	/**
	 * Removes the childs's model part from the diagram
	 * @param child
	 */
	public void removeChild(FlowDiagramElementModelPart child) {
		if (children.remove(child))
			fireStructureChange(CHILDREN, child);
	}



	/**
	 * TODO
	 * @param l
	 */
	public void addStructureChangeListener(PropertyChangeListener l) {
		addPropertyChangeListener(l);
	}

	/**
	 * TODO
	 * @param l
	 */
	public void removeStructureChangeListener(PropertyChangeListener l) {
		removePropertyChangeListener(l);
	}




	/**
	 * @see org.eclipse.ui.views.properties.IPropertySource#getEditableValue()
	 */
	public Object getEditableValue() {
		return this;
	}

	/**
	 * Creates the property descriptors if they have not been
	 * created yet. The following descriptor is added:<br>
	 * descriptor for the location group
	 */
	private void createPropertyDescriptors() {
		if (flowDiagramElementPropertyDescriptors != null)
			return;
		
		flowDiagramElementPropertyDescriptors = new HashSet();
		flowDiagramElementPropertyDescriptors.add(
			new TextPropertyDescriptor(
				PROP_FLOW_NAME,
				Flow4JPlugin.getResourceString("PropertyDescriptor_FlowDiagram.flowName"))); 	//$NON-NLS-1$
	}
	

	/**
	 * Returns the collection of the property descriptors
	 * @return the collection of the property descriptors
	 */
	protected Collection getPropertyDescriptorsCollection() {
		if (flowDiagramElementPropertyDescriptors == null)
			createPropertyDescriptors();
			
		return flowDiagramElementPropertyDescriptors;
	}

	/**
	 * Returns useful property flowDiagramDescriptors for the use
	 * in property sheets. This supports location.
	 *
	 * @see org.eclipse.ui.views.properties.IPropertySource#getPropertyDescriptors()
	 * @return  Array of property flowDiagramElementescriptors.
	 */
	public IPropertyDescriptor[] getPropertyDescriptors() {
		return (IPropertyDescriptor[])getPropertyDescriptorsCollection().toArray(new IPropertyDescriptor[]{});
	}

	/**
	 * Returns an Object which represents the appropriate
	 * value for the property name supplied.
	 *
	 * @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_FLOW_NAME.equals(propName))
			return getFlowName();
		else
			System.out.println("FlowDiagramModelPart.getPropertyValue() unknown propName: " + propName);
			
		return null;
	}

	/**
	 * @see org.eclipse.ui.views.properties.IPropertySource#isPropertySet(java.lang.Object)
	 */
	public boolean isPropertySet(Object propName){
		return isPropertySet((String)propName);
	}

	/**
	 * TODO
	 * @param propName
	 * @return
	 */
	protected boolean isPropertySet(String propName){
		return true;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.views.properties.IPropertySource#resetPropertyValue(java.lang.Object)
	 */
	public void resetPropertyValue(Object arg0) {
	}

	/**
	 * 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_FLOW_NAME.equals(id)) {
			setFlowName((String)value);
		} else
			System.out.println("FlowDiagramModelPart.setPropertyValue() unknown id: " + id);
	}

	/**
	 * @return
	 */
	public String getFlowName() {
		return flowName;
	}

	/**
	 * @param string
	 */
	public void setFlowName(String flowName) {
		this.flowName = flowName;
	}

}