StringValueTestXPathMessageSelector.java :  » J2EE » spring-ide_2.3.0 » org » springframework » integration » xml » selector » Java Open Source

/*
 * Copyright 2002-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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.springframework.integration.xml.selector;

import java.util.Map;

import org.w3c.dom.Document;
import org.w3c.dom.Node;

import org.springframework.integration.core.Message;
import org.springframework.integration.selector.MessageSelector;
import org.springframework.xml.xpath.XPathExpression;

/**
 * XPath {@link MessageSelector} that tests if a provided value supports
 * payloads of type {@link Document} or {@link String}.
 * 
 * @author Jonas Partner
 */
public class StringValueTestXPathMessageSelector extends AbstractXPathMessageSelector {

  private final String valueToTestFor;

  private volatile boolean caseSensitive = true;


  /**
   * Create a selector which tests for the given value and supports multiple
   * namespaces.
   * 
   * @param expression
   * @param namespaces
   * @param valueToTestFor
   */
  public StringValueTestXPathMessageSelector(String expression, Map<String, String> namespaces, String valueToTestFor) {
    super(expression, namespaces);
    this.valueToTestFor = valueToTestFor;
  }

  /**
   * Creates a single namespace Xpath selector.
   * 
   * @param expression
   * @param prefix
   * @param namespace
   * @param valueToTestFor
   */
  public StringValueTestXPathMessageSelector(String expression, String prefix, String namespace, String valueToTestFor) {
    super(expression, prefix, namespace);
    this.valueToTestFor = valueToTestFor;
  }

  /**
   * Creates non-namespaced testing selector.
   * 
   * @param expression
   * @param valueToTestFor
   */
  public StringValueTestXPathMessageSelector(String expression, String valueToTestFor) {
    super(expression);
    this.valueToTestFor = valueToTestFor;
  }

  /**
   * Creates a selector with the provided {@link XPathExpression}.
   * 
   * @param expression
   * @param valueToTestFor
   */
  public StringValueTestXPathMessageSelector(XPathExpression expression, String valueToTestFor) {
    super(expression);
    this.valueToTestFor = valueToTestFor;
  }


  /**
   * Specify whether comparison of value returned by {@link XPathExpression}
   * to test value should be case sensitive. Default is 'true'.
   * 
   * @param caseSensitive
   */
  public void setCaseSensitive(boolean caseSensitive) {
    this.caseSensitive = caseSensitive;
  }

  /**
   * Evaluate the payload and return true if the value returned by the
   * {@link XPathExpression} is equal to the <code>valueToTestFor</code>.
   */
  public boolean accept(Message<?> message) {
    Node nodeToTest = getConverter().convertToNode(message.getPayload());
    String xPathResult = getXPathExpresion().evaluateAsString(nodeToTest);
    if (this.caseSensitive) {
      return this.valueToTestFor.equals(xPathResult);
    }
    else {
      return this.valueToTestFor.equalsIgnoreCase(xPathResult);
    }
  }

}