org.jopendocument.util.SimpleXMLPath Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008 jOpenDocument, by ILM Informatique. All rights reserved.
*
* The contents of this file are subject to the terms of the GNU
* General Public License Version 3 only ("GPL").
* You may not use this file except in compliance with the License.
* You can obtain a copy of the License at http://www.gnu.org/licenses/gpl-3.0.html
* See the License for the specific language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each file.
*
*/
package org.jopendocument.util;
import org.jopendocument.util.CollectionUtils;
import org.jopendocument.util.Step.Axis;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import org.jdom.Attribute;
import org.jdom.Element;
import org.jdom.filter.Filter;
import org.jdom.xpath.XPath;
/**
* Like an {@link XPath} with less features but a greater speed.
*
* @author Sylvain CUAZ
*
* @param type of result.
*/
public final class SimpleXMLPath {
public static SimpleXMLPath create(final List> steps, final Step lastStep) {
final SimpleXMLPath res = new SimpleXMLPath(lastStep);
for (final Step s : steps)
res.add(s);
return res;
}
public static SimpleXMLPath create(final Step lastStep) {
return new SimpleXMLPath(lastStep);
}
public static SimpleXMLPath create(final Step first, final Step lastStep) {
final SimpleXMLPath res = new SimpleXMLPath(lastStep);
res.add(first);
return res;
}
public static SimpleXMLPath create(final Step first, final Step second, final Step lastStep) {
return create(Arrays.> asList(first, second), lastStep);
}
/**
* Create a path searching for all descendant attributes with the passed name and namespace.
* I.e. in XPath this would be ".//@ns:name".
*
* @param name the name of attributes.
* @param ns the namespace of attributes.
* @return a path searching attributes in all {@link Axis#descendantOrSelf} elements.
*/
public static SimpleXMLPath allAttributes(final String name, final String ns) {
return create(Step.createElementStep(Axis.descendantOrSelf, null), Step.createAttributeStep(name, ns));
}
/**
* Create a path searching for all descendant elements with the passed name and namespace. I.e.
* in XPath this would be ".//ns:name".
*
* @param name the name of elements.
* @param ns the namespace of elements.
* @return a path searching all {@link Axis#descendantOrSelf} elements.
*/
public static SimpleXMLPath allElements(final String name, final String ns) {
return create(Step.createElementStep(Axis.descendantOrSelf, name, ns));
}
private final List> items;
private final Step lastItem;
private SimpleXMLPath(Step lastStep) {
this.lastItem = lastStep;
this.items = new ArrayList>();
}
public final SimpleXMLPath add(final String name) {
return this.add(Step.createElementStep(name, null, null));
}
public final SimpleXMLPath add(Step step) {
this.items.add(step);
return this;
}
// return Element or Attribute
public final T selectSingleNode(final Object n) {
return selectSingleNode(n, this.items);
}
private final T selectSingleNode(final Object currentNode, List> steps) {
final int size = steps.size();
if (size > 0) {
final Step currentStep = steps.get(0);
final List nextNodes = currentStep.nextNodes(Node.get(currentNode), currentNode);
// MAYBE add an index argument instead of creating a sublist
final List> nextSteps = steps.subList(1, size);
final int stop = nextNodes.size();
for (int i = 0; i < stop; i++) {
final T finalNode = this.selectSingleNode(nextNodes.get(i), nextSteps);
if (finalNode != null)
return finalNode;
}
return null;
} else {
return CollectionUtils.getFirst(this.lastItem.nextNodes(Node.get(currentNode), currentNode));
}
}
public final List selectNodes(final Object n) {
List currentNodes = Collections.singletonList(n);
final int stop = this.items.size();
for (int i = 0; i < stop; i++) {
final Step currentStep = this.items.get(i);
final List nextNodes = currentStep.nextNodes(currentNodes);
if (nextNodes.isEmpty())
return Collections.emptyList();
else
currentNodes = nextNodes;
}
return this.lastItem.nextNodes(currentNodes);
}
// encapsulate differences about JDOM nodes
static abstract class Node {
static final Node elem = new ElementNode();
static final Node attr = new AttributeNode();
@SuppressWarnings("unchecked")
public static Node get(TT o) {
if (o instanceof Attribute)
return (Node) attr;
else if (o instanceof Element)
return (Node) elem;
else
throw new IllegalArgumentException("unknown Node: " + o);
}
@SuppressWarnings("unchecked")
public static Node get(Class clazz) {
if (clazz == Attribute.class)
return (Node) attr;
else if (clazz == Element.class)
return (Node) elem;
else
throw new IllegalArgumentException("unknown Node: " + clazz);
}
public abstract void nextNodes(final List res, final T node, final Step step);
// viva jdom who doesn't have a common interface for getName() and getNS()
abstract T filter(final T elem, final String name, final String ns);
@Override
public final String toString() {
return this.getClass().getSimpleName();
}
}
static class AttributeNode extends Node {
@Override
public void nextNodes(final List res, final Attribute node, final Step step) {
if (step.getAxis() == Axis.ancestor) {
step.add(node.getParent(), res);
} else
throw new IllegalArgumentException(this + " cannot take the passed step: " + step);
}
@Override
Attribute filter(Attribute elem, String name, String ns) {
if (elem == null)
return null;
if (name != null && !name.equals(elem.getName()))
return null;
if (ns != null && !ns.equals(elem.getNamespacePrefix()))
return null;
return elem;
}
}
static class ElementNode extends Node {
@SuppressWarnings("unchecked")
@Override
public void nextNodes(final List res, final Element node, final Step step) {
final Axis axis = step.getAxis();
if (axis == Axis.ancestor) {
step.add(node.getParent(), res);
} else if (axis == Axis.attribute) {
final List attributes = node.getAttributes();
final int stop = attributes.size();
for (int i = 0; i < stop; i++) {
step.add(attributes.get(i), res);
}
} else if (axis == Axis.child) {
// jdom : traversal through the List is best done with a Iterator
for (final Object o : node.getChildren()) {
step.add(o, res);
}
} else if (axis == Axis.descendantOrSelf) {
step.add(node, res);
final Iterator iter = node.getDescendants(new Filter() {
@Override
public boolean matches(Object obj) {
if (!(obj instanceof Element))
return false;
return step.evaluate(obj) != null;
}
});
while (iter.hasNext()) {
res.add(iter.next());
}
} else
throw new IllegalArgumentException(this + " cannot take the passed step: " + axis);
}
@Override
Element filter(Element elem, String name, String ns) {
if (elem == null)
return null;
if (name != null && !name.equals(elem.getName()))
return null;
if (ns != null && !ns.equals(elem.getNamespacePrefix()))
return null;
return elem;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy