net.sf.saxon.option.jdom2.JDOM2DocumentWrapper Maven / Gradle / Ivy
Show all versions of saxon-he Show documentation
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.option.jdom2;
import net.sf.saxon.Configuration;
import net.sf.saxon.om.*;
import net.sf.saxon.pattern.NodeKindTest;
import net.sf.saxon.tree.iter.AxisIterator;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.type.Type;
import net.sf.saxon.type.Untyped;
import org.jdom2.Attribute;
import org.jdom2.Document;
import org.jdom2.Element;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
/**
* The root node of an XPath tree. (Or equivalently, the tree itself).
* This class should have been named Root; it is used not only for the root of a document,
* but also for the root of a result tree fragment, which is not constrained to contain a
* single top-level element.
* @author Michael H. Kay
*/
public class JDOM2DocumentWrapper extends JDOM2NodeWrapper implements DocumentInfo {
protected Configuration config;
protected String baseURI;
protected long documentNumber;
private HashMap idIndex;
private HashMap userData;
/**
* Create a Saxon wrapper for a JDOM document
* @param doc The JDOM document
* @param baseURI The base URI for all the nodes in the document
* @param config The Saxon Configuration
*/
public JDOM2DocumentWrapper(Document doc, String baseURI, Configuration config) {
super(doc, null, 0);
node = doc;
nodeKind = Type.DOCUMENT;
this.baseURI = baseURI;
docWrapper = this;
setConfiguration(config);
}
/**
* Wrap a node in the JDOM document.
* @param node The node to be wrapped. This must be a node in the same document
* (the system does not check for this).
* @return the wrapping NodeInfo object
*/
public JDOM2NodeWrapper wrap(Object node) {
if (node==this.node) {
return this;
}
return makeWrapper(node, this);
}
/**
* Set the configuration (containing the name pool used for all names in this document)
*/
public void setConfiguration(Configuration config) {
this.config = config;
documentNumber = config.getDocumentNumberAllocator().allocateDocumentNumber();
}
@Override
public String getBaseURI() {
return baseURI;
}
@Override
public String getSystemId() {
return baseURI;
}
public int comparePosition(NodeInfo other) {
return 0; //To change body of implemented methods use File | Settings | File Templates.
}
/**
* Get the configuration previously set using setConfiguration
* (or the default configuraton allocated automatically)
*/
public Configuration getConfiguration() {
return config;
}
/**
* Get the name pool used for the names in this document
*/
public NamePool getNamePool() {
return config.getNamePool();
}
/**
* Get the unique document number
*/
public long getDocumentNumber() {
return documentNumber;
}
/**
* Ask whether the document contains any nodes whose type annotation is anything other than
* UNTYPED
*
* @return true if the document contains elements whose type is other than UNTYPED
*/
public boolean isTyped() {
return false;
}
/**
* Get the element with a given ID, if any
* @param id the required ID value
* @param getParent
* @return the element node with the given ID if there is one, otherwise null.
*/
public NodeInfo selectID(String id, boolean getParent) {
if (idIndex == null) {
idIndex = new HashMap(100);
AxisIterator iter = iterateAxis(AxisInfo.DESCENDANT, NodeKindTest.ELEMENT);
while (true) {
NodeInfo node = iter.next();
if (node == null) {
break;
}
Element element = (Element)((JDOM2NodeWrapper)node).node;
List attributes = element.getAttributes();
for (Object attribute : attributes) {
Attribute att = (Attribute) attribute;
if (att.getAttributeType() == Attribute.ID_TYPE) {
idIndex.put(att.getValue(), element);
}
}
}
}
Element element = idIndex.get(id);
return (element == null ? null : wrap(element));
}
/**
* Get the list of unparsed entities defined in this document
* @return an Iterator, whose items are of type String, containing the names of all
* unparsed entities defined in this document. If there are no unparsed entities or if the
* information is not available then an empty iterator is returned
*/
public Iterator getUnparsedEntityNames() {
return Collections.EMPTY_LIST.iterator();
}
/**
* Get the unparsed entity with a given name
* @param name the name of the entity
* @return null: JDOM does not provide access to unparsed entities
*/
public String[] getUnparsedEntity(String name) {
return null;
}
/**
* Get the type annotation. Always XS_UNTYPED.
*/
public int getTypeAnnotation() {
return StandardNames.XS_UNTYPED;
}
/**
* Get the type annotation of this node, if any. The type annotation is represented as
* SchemaType object.
*
* Types derived from a DTD are not reflected in the result of this method.
*
* @return For element and attribute nodes: the type annotation derived from schema
* validation (defaulting to xs:untyped and xs:untypedAtomic in the absence of schema
* validation). For comments, text nodes, processing instructions, and namespaces: null.
* For document nodes, either xs:untyped if the document has not been validated, or
* xs:anyType if it has.
* @since 9.4
*/
public SchemaType getSchemaType() {
return Untyped.getInstance();
}
/**
* Set user data on the document node. The user data can be retrieved subsequently
* using {@link #getUserData}
* @param key A string giving the name of the property to be set. Clients are responsible
* for choosing a key that is likely to be unique. Must not be null. Keys used internally
* by Saxon are prefixed "saxon:".
* @param value The value to be set for the property. May be null, which effectively
* removes the existing value for the property.
*/
public void setUserData(String key, Object value) {
if (userData == null) {
userData = new HashMap(4);
}
if (value == null) {
userData.remove(key);
} else {
userData.put(key, value);
}
}
/**
* Get user data held in the document node. This retrieves properties previously set using
* {@link #setUserData}
* @param key A string giving the name of the property to be retrieved.
* @return the value of the property, or null if the property has not been defined.
*/
public Object getUserData(String key) {
if (userData == null) {
return null;
} else {
return userData.get(key);
}
}
}
// Original Code is Copyright (c) Saxonica Limited 2009. All rights reserved.