core/org.eclipse.smila.processing.pipelets.xmlprocessing/code/src/org/eclipse/smila/processing/pipelets/xmlprocessing/RemoveElementFromXMLPipelet.java

/***********************************************************************************************************************
 * Copyright (c) 2008, 2011 Attensity Europe GmbH and brox IT Solutions GmbH. All rights reserved. This program and the
 * accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this
 * distribution, and is available at http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Daniel Stucky (empolis GmbH) - initial API and implementation
 *               Andreas Weber (Attensity Europe GmbH) - data model simplification
 **********************************************************************************************************************/

package org.eclipse.smila.processing.pipelets.xmlprocessing;

import org.eclipse.smila.blackboard.Blackboard;
import org.eclipse.smila.processing.parameters.ParameterAccessor;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

/**
 * Pipelet that removes a selected element from an XML document. The possible properties are:
 * <ul>
 * <li>elementId: the id of the XML element</li>
 * <li>inputName: name of the Attribute/Attachment to read the XML Document from</li>
 * <li>outputName: name of the Attribute/Attachment to store the manipulated XML Document in</li>
 * <li>inputType: the type (Attribute or Attachment of the inputName</li>
 * <li>outputType: the type (Attribute or Attachment of the outputtName</li>
 * </ul>
 */
public class RemoveElementFromXMLPipelet extends AXmlTransformationPipelet {

  /**
   * Property for the Id of the XML element..
   */
  public static final String PROP_ELEMENT_ID = "elementId";

  @Override
  protected void processRecord(final Blackboard blackboard, final ParameterAccessor paramAccessor, final String id)
    throws Exception {
    final String elementId = paramAccessor.getRequiredParameter(PROP_ELEMENT_ID);
    final Document inputDocument = createDocument(blackboard, id, paramAccessor);
    if (inputDocument != null) {
      final Element el = inputDocument.getElementById(elementId);
      if (el != null) {
        final Node parent = el.getParentNode();
        parent.removeChild(el);
      }
      storeDocument(blackboard, id, inputDocument, paramAccessor);
    }
  }
}