com.ebay.sdk.util.XPathUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation
The newest version!
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent  version 
thereof released by eBay.  The then-current version of the License can be found 
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that 
is under the eBay SDK ../docs directory.
*/

package com.ebay.sdk.util;

import javax.xml.transform.TransformerException;

import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import org.apache.xml.utils.PrefixResolver;
import org.apache.xml.utils.PrefixResolverDefault;
import org.apache.xml.utils.SAXSourceLocator;
import org.apache.xpath.XPath;
import org.apache.xpath.XPathContext;
import org.apache.xpath.objects.XObject;


/**
 * XPath related helper functions.
 * Title: 
 * Description: 
 * Copyright: Copyright (c) 2004
 * Company: eBay Inc.
 * @author Changyi Zhu
 * @version 1.0
 */
public abstract class XPathUtil {
  /**
   *
   * @param expr String
   * @throws TransformerException
   * @return XPath
   */
  static public XPath createXPath(String expr)
    throws TransformerException
  {
    return createXPath(expr, XPath.SELECT);
  }

  /**
   *
   * @param expr String
   * @param type int
   * @throws TransformerException
   * @return XPath
   */
  static public XPath createXPath(String expr, int type)
    throws TransformerException
  {
    return createXPath(expr, (PrefixResolver)null, type);
  }

  /**
   *
   * @param expr String
   * @param contextNode Node
   * @param type int
   * @throws TransformerException
   * @return XPath
   */
  static public XPath createXPath(String expr, Node contextNode, int type)
    throws TransformerException
  {
    PrefixResolver resolver = new PrefixResolverDefault(contextNode);
    return createXPath(expr, null, resolver, type);
  }

  /**
   *
   * @param expr String
   * @param resolver PrefixResolver
   * @param type int
   * @throws TransformerException
   * @return XPath
   */
  static public XPath createXPath(String expr, PrefixResolver resolver, int type)
    throws TransformerException
  {
    return createXPath(expr, null, resolver, type);
  }

  /**
   *
   * @param expr String
   * @param locator SAXSourceLocator
   * @param resolver PrefixResolver
   * @param type int
   * @throws TransformerException
   * @return XPath
   */
  static public XPath createXPath(String expr, SAXSourceLocator locator, PrefixResolver resolver, int type)
    throws TransformerException
  {
    return new XPath(expr, locator, resolver, type);
  }

  /**
   *
   * @param expr String
   * @param contextNode Node
   * @throws TransformerException
   * @return NodeList
   */
  public static NodeList selectNodes(String expr, Node contextNode)
    throws TransformerException
  {
    return execute(expr, contextNode, XPath.SELECT);
  }

  /**
   *
   * @param expr String
   * @param contextNode Node
   * @throws TransformerException
   * @return Node
   */
  public static Node selectSingleNode(String expr, Node contextNode)
      throws TransformerException
  {
    NodeList nl = execute(expr, contextNode, XPath.SELECT);
    if( nl.getLength() > 0 )
      return nl.item(0);
    else
      return null;
  }


  /**
   *
   * @param expr String
   * @param contextNode Node
   * @param type int
   * @throws TransformerException
   * @return NodeList
   */
  public static NodeList execute(String expr, Node contextNode, int type)
    throws TransformerException
  {
    PrefixResolver resolver = new PrefixResolverDefault(contextNode);
    XPath xpath = createXPath(expr, resolver, type);
    XPathContext xpathContext = new XPathContext();
    XObject xobj = xpath.execute(xpathContext, contextNode, resolver);
    if (xobj != null) {
      return xobj.nodelist();
    }
    else {
      return null;
    }
  }

  /**
   *
   * @param systemId String
   * @param expr String
   * @param contextNode Node
   * @param type int
   * @throws TransformerException
   * @return NodeList
   */
  public static NodeList execute(String systemId, String expr, Node contextNode, int type)
    throws TransformerException
  {
    SAXSourceLocator locator = new SAXSourceLocator();
    locator.setSystemId(systemId);
    PrefixResolver resolver = new PrefixResolverDefault(contextNode);
    XPath xpath = new XPath(expr, locator, resolver, type);
    return execute(xpath, contextNode);
  }

  /**
   *
   * @param xpath XPath
   * @param contextNode Node
   * @throws TransformerException
   * @return NodeList
   */
  public static NodeList execute(XPath xpath, Node contextNode)
    throws TransformerException
  {
    XPathContext xpathContext = new XPathContext();
    XObject xobj = xpath.execute(xpathContext, contextNode, xpathContext.getNamespaceContext());
    if (xobj != null) {
      return xobj.nodelist();
    }
    else {
      return null;
    }
  }

  /**
   *
   * @param xpathContext XPathContext
   * @param xpath XPath
   * @param contextNode Node
   * @throws TransformerException
   * @return NodeList
   */
  public static NodeList execute(XPathContext xpathContext, XPath xpath, Node contextNode)
    throws TransformerException
  {
    XObject xobj = xpath.execute(xpathContext, contextNode, xpathContext.getNamespaceContext());
    if (xobj != null) {
      return xobj.nodelist();
    }
    else {
      return null;
    }
  }
}