org.openbpmn.bpmn.elements.Lane Maven / Gradle / Ivy
Show all versions of open-bpmn.metamodel Show documentation
package org.openbpmn.bpmn.elements;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.logging.Logger;
import org.openbpmn.bpmn.BPMNModel;
import org.openbpmn.bpmn.BPMNNS;
import org.openbpmn.bpmn.elements.core.BPMNElementNode;
import org.openbpmn.bpmn.exceptions.BPMNInvalidReferenceException;
import org.openbpmn.bpmn.exceptions.BPMNMissingElementException;
import org.openbpmn.bpmn.exceptions.BPMNModelException;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
/**
* The BPMNLane object represents a lane in a laneset contianed by a process
*
* e.g.:
*
*
*
{@code
*
task_1
* }
*
*
* A dc:Bounds element is part of a bpmndi:BPMNShape or bpmndi:BPMNLabel
*
* @author rsoika
*
*/
public class Lane extends BPMNElementNode {
private static Logger logger = Logger.getLogger(Lane.class.getName());
public final static double MIN_WIDTH = 270.0;
public final static double MIN_HEIGHT = 100.0;
public final static double DEFAULT_WIDTH = 470.0;
public final static double DEFAULT_HEIGHT = 150.0;
/**
* Creates a BPMNLane out of the bpmn elemnet
*
* <
*
*
* @param width
* @throws BPMNMissingElementException
*/
public Lane(BPMNModel model, Element node) {
super(model, node);
// find the BPMNShape element.
bpmnShape = (Element) model.findBPMNPlaneElement("BPMNShape", getId());
}
/**
* Returns the BPMNProcess the lance is a member of.
*
* To find the BPMNProcess of a lane we need to first fetch the processID form
* the outer laneset.
*/
@Override
public BPMNProcess getBpmnProcess() {
String processID = getProcessId();
try {
return this.model.openProcess(processID);
} catch (BPMNModelException e) {
logger.severe("Faild to resolve BPMNProcess for lane '" + this.getId() + "!' ");
}
return null;
}
/**
* This method returns the corresponding BPMNProcess ID for this Element.
*
* For a lane the process id is the parent of the parent lane set
*
* @param bpmynElement
* @return
*/
@Override
public String getProcessId() {
Element laneSet = (Element) getElementNode().getParentNode();
// now get the parent node of the laneset which is the process
Element parentProcess = (Element) laneSet.getParentNode();
return parentProcess.getAttribute("id");
}
/**
* This method returns the LaneSet element node from the bpmn2:process
*
* @return
*/
public Element getLaneSet() {
Element laneSet = (Element) this.getElementNode().getParentNode();
return laneSet;
}
/**
* This method inserts a given BPMNFlowElement to this lane
*
* {@code
*
StartEvent_4
}
*
* @param element
* @param laneId
* @throws BPMNInvalidReferenceException
*/
public void insert(BPMNElementNode bpmnElementNode) {
// append flowNodeRef if not yet listed
if (!contains(bpmnElementNode)) {
Element flowNodeRef = model.createElement(BPMNNS.BPMN2, "flowNodeRef");
Text textNode = this.getDoc().createTextNode(bpmnElementNode.getId());
flowNodeRef.appendChild(textNode);
this.getElementNode().appendChild(flowNodeRef);
}
}
/**
* Returns true if the given BPMNFlow Element is part of this lane
*
* @param element a BPMNFlowElement
* @return
*/
public boolean contains(BPMNElementNode bpmnElement) {
// get all bpmn2:flowNodeRef
Set refs = model.findChildNodesByName(this.getElementNode(), BPMNNS.BPMN2, "flowNodeRef");
for (Element element : refs) {
if (bpmnElement.getId().equals(element.getTextContent())) {
return true;
}
}
// not found
return false;
}
/**
* This method removes a given BPMNFlowElement from this lane
*
* {@code
*
StartEvent_4
}
*
* @param element
* @param laneId
* @throws BPMNInvalidReferenceException
*/
public void remove(BPMNElementNode bpmnElement) {
// remove flowNodeRef if listed
if (contains(bpmnElement)) {
Set refs = model.findChildNodesByName(this.getElementNode(), BPMNNS.BPMN2, "flowNodeRef");
for (Element element : refs) {
if (bpmnElement.getId().equals(element.getTextContent())) {
this.elementNode.removeChild(element);
break;
}
}
}
}
/**
* Returns a list of a all BPMNFlowElement IDs contained by this lane
*
* @return - list of ids
*/
public Set getFlowElementIDs() {
Set result = new LinkedHashSet();
Set refs = model.findChildNodesByName(this.getElementNode(), BPMNNS.BPMN2, "flowNodeRef");
for (Element element : refs) {
result.add(element.getTextContent());
}
return result;
}
/**
* This method adds a flowElementID to the lane
*
* @param id
*/
/*
* public void addFlowElementID(String id) {
* // test if the id is already listed...
* Set refList = getFlowElementIDs();
* if (refList.contains(id)) {
* // already listed - no op
* return;
* }
* // add id....
* model.createElement(null, id)
*
* }
*/
@Override
public double getDefaultWidth() {
return DEFAULT_WIDTH;
}
@Override
public double getDefaultHeight() {
return DEFAULT_HEIGHT;
}
/**
* Remove any embedded bpmndi:BPMNLabel element within the bpmndi:BPMNShape
*
* Positioning of the label is part of the client. Any position update should
* ignore these settings in Open-BPMN.
*
*/
@Override
public void setPosition(double x, double y) {
super.setPosition(x, y);
// remove optional BPMNLabel
Element bpmnLabel = getModel().findChildNodeByName(this.bpmnShape, BPMNNS.BPMNDI, "BPMNLabel");
if (bpmnLabel != null) {
this.bpmnShape.removeChild(bpmnLabel);
}
}
}