org.databene.commons.xml.XPathUtil Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of databene-commons Show documentation

'databene commons' is an open source Java library by Volker Bergmann. It provides extensions to the Java core library by utility classes, abstract concepts and concrete implementations.

There is a newer version: 1.0.11

Show newest version

/*
 * Copyright (C) 2004-2014 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * 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.databene.commons.xml;

import java.util.List;

import javax.xml.namespace.QName;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpressionException;
import javax.xml.xpath.XPathFactory;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

/**
 * Provides XPath query functionality on XML documents and elements.


 * Created: 28.03.2014 16:55:12
 * @since 0.5.29
 * @author Volker Bergmann
 */

public class XPathUtil {

	public static String queryString(Document document, String expression) throws XPathExpressionException {
		return (String) query(document, expression, XPathConstants.STRING);
	}

	public static List queryElements(Document document, String expression) throws XPathExpressionException {
		return XMLUtil.toElementList(queryNodes(document, expression));
	}

	public static List queryElements(Element element, String expression) throws XPathExpressionException {
		return XMLUtil.toElementList((NodeList) query(element, expression, XPathConstants.NODESET));
	}

	public static Element queryElement(Document document, String expression) throws XPathExpressionException {
		return (Element) query(document, expression, XPathConstants.NODE);
	}

	public static NodeList queryNodes(Document document, String expression) throws XPathExpressionException {
		return (NodeList) query(document, expression, XPathConstants.NODESET);
	}

	public static Object query(Document document, String expression, QName returnType) throws XPathExpressionException {
		XPath xpath = XPathFactory.newInstance().newXPath();
		return xpath.evaluate(expression, document, returnType);
	}
	
	public static String queryString(Element element, String expression) throws XPathExpressionException {
		return (String) query(element, expression, XPathConstants.STRING);
	}

	public static Object query(Element element, String expression, QName returnType) throws XPathExpressionException {
		XPath xpath = XPathFactory.newInstance().newXPath();
		return xpath.evaluate(expression, element, returnType);
	}
	
}