org.camunda.bpm.engine.impl.util.xml.Element Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation
There is a newer version: 7.22.0-alpha1
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.camunda.bpm.engine.impl.util.xml;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.camunda.bpm.engine.ProcessEngineException;
import org.xml.sax.Attributes;
import org.xml.sax.Locator;


/**
 * Represents one XML element.
 *
 * @author Tom Baeyens
 * @author Joram Barrez
 */
public class Element {

  protected String uri;
  protected String tagName;

  /*
   * Key of map = 'uri':attributeName
   *
   * if namespace is empty, key is 'attributeName'
   */
  protected Map attributeMap = new HashMap();

  protected int line;
  protected int column;
  protected StringBuilder text = new StringBuilder();
  protected List elements = new ArrayList();

  public Element(String uri, String localName, String qName, Attributes attributes, Locator locator) {
    this.uri = uri;
    this.tagName = (uri == null || uri.equals("")) ? qName : localName;

    if (attributes!=null) {
      for (int i=0; i elements(String tagName) {
    return elementsNS( (String) null, tagName);
  }

  public List elementsNS(Namespace nameSpace, String tagName) {
    List elementsNS = elementsNS(nameSpace.getNamespaceUri(), tagName);
    if(elementsNS.isEmpty() && nameSpace.hasAlternativeUri()){
      elementsNS = elementsNS(nameSpace.getAlternativeUri(), tagName);
    }
    return elementsNS;
  }

  protected List elementsNS(String nameSpaceUri, String tagName) {
    List selectedElements = new ArrayList();
    for (Element element: elements) {
      if (tagName.equals(element.getTagName())) {
        if (nameSpaceUri  == null
                || ( nameSpaceUri != null && nameSpaceUri.equals(element.getUri()) ) ) {
          selectedElements.add(element);
        }
      }
    }
    return selectedElements;
  }

  public Element element(String tagName) {
    return elementNS(new Namespace(null), tagName);
  }

  public Element elementNS(Namespace nameSpace, String tagName) {
    List elements = elementsNS(nameSpace.getNamespaceUri(), tagName);
    if (elements.size() == 0 && nameSpace.hasAlternativeUri()) {
      elements = elementsNS(nameSpace.getAlternativeUri(), tagName);
    }
    if (elements.size() == 0) {
      return null;
    } else if (elements.size() > 1) {
      throw new ProcessEngineException("Parsing exception: multiple elements with tag name " + tagName + " found");
    }
    return elements.get(0);
  }

  public void add(Element element) {
    elements.add(element);
  }

  public String attribute(String name) {
    if (attributeMap.containsKey(name)) {
      return attributeMap.get(name).getValue();
    }
    return null;
  }

  public Set attributes() {
    return attributeMap.keySet();
  }

  public String attributeNS(Namespace namespace, String name) {
    String attribute = attribute(composeMapKey(namespace.getNamespaceUri(), name));
    if (attribute == null && namespace.hasAlternativeUri()) {
      attribute = attribute(composeMapKey(namespace.getAlternativeUri(), name));
    }
    return attribute;
  }

  public String attribute(String name, String defaultValue) {
    if (attributeMap.containsKey(name)) {
      return attributeMap.get(name).getValue();
    }
    return defaultValue;
  }

  public String attributeNS(Namespace namespace, String name, String defaultValue) {
    String attribute = attribute(composeMapKey(namespace.getNamespaceUri(), name));
    if (attribute == null && namespace.hasAlternativeUri()) {
      attribute = attribute(composeMapKey(namespace.getAlternativeUri(), name));
    }
    if (attribute == null) {
      return defaultValue;
    }
    return attribute;
  }

  protected String composeMapKey(String attributeUri, String attributeName) {
    StringBuilder strb = new StringBuilder();
    if (attributeUri != null && !attributeUri.equals("")) {
      strb.append(attributeUri);
      strb.append(":");
    }
    strb.append(attributeName);
    return strb.toString();
  }

  public List elements() {
    return elements;
  }

  public String toString() {
    return "<"+tagName+"...";
  }


  public String getUri() {
    return uri;
  }
  public String getTagName() {
    return tagName;
  }
  public int getLine() {
    return line;
  }
  public int getColumn() {
    return column;
  }
  /**
   * Due to the nature of SAX parsing, sometimes the characters of an element
   * are not processed at once. So instead of a setText operation, we need
   * to have an appendText operation.
   */
  public void appendText(String text) {
    this.text.append(text);
  }
  public String getText() {
    return text.toString();
  }

  /**
   * allows to recursively collect the ids of all elements in the tree.
   */
  public void collectIds(List ids) {
    ids.add(attribute("id"));
    for (Element child : elements) {
      child.collectIds(ids);
    }
  }
}