org.apache.xerces.impl.xs.SchemaNamespaceSupport Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation
Show all versions of xercesImpl Show documentation
Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family.
This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building
parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is
the reference implementation of XNI but other parser components, configurations, and parsers can be written
using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual.
Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema
1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema
Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for
evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation
of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete
implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML
Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that
it does not yet provide an option to enable normalization checking as described in section 2.13 of this
specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly
serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.xerces.impl.xs;
import org.apache.xerces.impl.xs.opti.ElementImpl;
import org.apache.xerces.util.NamespaceSupport;
import org.apache.xerces.util.SymbolTable;
import org.apache.xerces.util.XMLSymbols;
import org.apache.xerces.xni.NamespaceContext;
import org.apache.xerces.xni.QName;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
/**
* This class customizes the behaviour of the util.NamespaceSupport
* class in order to easily implement some features that we need for
* efficient schema handling. It will not be generally useful.
*
* @xerces.internal
*
* @author Neil Graham, IBM
*
* @version $Id: SchemaNamespaceSupport.java 446734 2006-09-15 20:51:23Z mrglavas $
*/
public class SchemaNamespaceSupport
extends NamespaceSupport {
private SchemaRootContext fSchemaRootContext = null;
public SchemaNamespaceSupport (Element schemaRoot, SymbolTable symbolTable) {
super();
if (schemaRoot != null && !(schemaRoot instanceof ElementImpl)) {
Document ownerDocument = schemaRoot.getOwnerDocument();
if (ownerDocument != null && schemaRoot != ownerDocument.getDocumentElement()) {
fSchemaRootContext = new SchemaRootContext(schemaRoot, symbolTable);
}
}
} // constructor
// more effecient than NamespaceSupport(NamespaceContext)
public SchemaNamespaceSupport(SchemaNamespaceSupport nSupport) {
fSchemaRootContext = nSupport.fSchemaRootContext;
fNamespaceSize = nSupport.fNamespaceSize;
if (fNamespace.length < fNamespaceSize)
fNamespace = new String[fNamespaceSize];
System.arraycopy(nSupport.fNamespace, 0, fNamespace, 0, fNamespaceSize);
fCurrentContext = nSupport.fCurrentContext;
if (fContext.length <= fCurrentContext)
fContext = new int[fCurrentContext+1];
System.arraycopy(nSupport.fContext, 0, fContext, 0, fCurrentContext+1);
} // end constructor
/**
* This method takes a set of Strings, as stored in a
* NamespaceSupport object, and "fools" the object into thinking
* that this is one unified context. This is meant to be used in
* conjunction with things like local elements, whose declarations
* may be deeply nested but which for all practical purposes may
* be regarded as being one level below the global
* element--at least with regard to namespace declarations.
* It's worth noting that the context from which the strings are
* being imported had better be using the same SymbolTable.
*/
public void setEffectiveContext (String [] namespaceDecls) {
if(namespaceDecls == null || namespaceDecls.length == 0) return;
pushContext();
int newSize = fNamespaceSize + namespaceDecls.length;
if (fNamespace.length < newSize) {
// expand namespace's size...
String[] tempNSArray = new String[newSize];
System.arraycopy(fNamespace, 0, tempNSArray, 0, fNamespace.length);
fNamespace = tempNSArray;
}
System.arraycopy(namespaceDecls, 0, fNamespace, fNamespaceSize,
namespaceDecls.length);
fNamespaceSize = newSize;
} // setEffectiveContext(String):void
/**
* This method returns an array of Strings, as would be stored in
* a NamespaceSupport object. This array contains all
* declarations except those at the global level.
*/
public String [] getEffectiveLocalContext() {
// the trick here is to recognize that all local contexts
// happen to start at fContext[3].
// context 1: empty
// context 2: decls for xml and xmlns;
// context 3: decls on : the global ones
String[] returnVal = null;
if (fCurrentContext >= 3) {
int bottomLocalContext = fContext[3];
int copyCount = fNamespaceSize - bottomLocalContext;
if (copyCount > 0) {
returnVal = new String[copyCount];
System.arraycopy(fNamespace, bottomLocalContext, returnVal, 0,
copyCount);
}
}
return returnVal;
} // getEffectiveLocalContext():String
// This method removes from this object all the namespaces
// returned by getEffectiveLocalContext.
public void makeGlobal() {
if (fCurrentContext >= 3) {
fCurrentContext = 3;
fNamespaceSize = fContext[3];
}
} // makeGlobal
public String getURI(String prefix) {
String uri = super.getURI(prefix);
if (uri == null && fSchemaRootContext != null) {
if (!fSchemaRootContext.fDOMContextBuilt) {
fSchemaRootContext.fillNamespaceContext();
fSchemaRootContext.fDOMContextBuilt = true;
}
if (fSchemaRootContext.fNamespaceSize > 0 &&
!containsPrefix(prefix)) {
uri = fSchemaRootContext.getURI(prefix);
}
}
return uri;
}
/**
* This class keeps track of the namespace bindings
* declared on ancestors of the schema root.
*/
static final class SchemaRootContext {
//
// Data
//
/**
* Namespace binding information. This array is composed of a
* series of tuples containing the namespace binding information:
* <prefix, uri>.
*/
String[] fNamespace = new String[16 * 2];
/** The size of the namespace information array. */
int fNamespaceSize = 0;
/**
* Flag indicating whether the namespace context
* has been from the root node's ancestors.
*/
boolean fDOMContextBuilt = false;
/** Schema root. **/
private final Element fSchemaRoot;
/** Symbol table. **/
private final SymbolTable fSymbolTable;
/** Temporary storage for attribute QNames. **/
private final QName fAttributeQName = new QName();
SchemaRootContext(Element schemaRoot, SymbolTable symbolTable) {
fSchemaRoot = schemaRoot;
fSymbolTable = symbolTable;
}
void fillNamespaceContext() {
if (fSchemaRoot != null) {
Node currentNode = fSchemaRoot.getParentNode();
while (currentNode != null) {
if (Node.ELEMENT_NODE == currentNode.getNodeType()) {
NamedNodeMap attributes = currentNode.getAttributes();
final int attrCount = attributes.getLength();
for (int i = 0; i < attrCount; ++i) {
Attr attr = (Attr) attributes.item(i);
String value = attr.getValue();
if (value == null) {
value = XMLSymbols.EMPTY_STRING;
}
fillQName(fAttributeQName, attr);
// REVISIT: Should we be looking at non-namespace attributes
// for additional mappings? Should we detect illegal namespace
// declarations and exclude them from the context? -- mrglavas
if (fAttributeQName.uri == NamespaceContext.XMLNS_URI) {
// process namespace attribute
if (fAttributeQName.prefix == XMLSymbols.PREFIX_XMLNS) {
declarePrefix(fAttributeQName.localpart, value.length() != 0 ? fSymbolTable.addSymbol(value) : null);
}
else {
declarePrefix(XMLSymbols.EMPTY_STRING, value.length() != 0 ? fSymbolTable.addSymbol(value) : null);
}
}
}
}
currentNode = currentNode.getParentNode();
}
}
}
String getURI(String prefix) {
// find prefix in the DOM context
for (int i = 0; i < fNamespaceSize; i += 2) {
if (fNamespace[i] == prefix) {
return fNamespace[i + 1];
}
}
// prefix not found
return null;
}
private void declarePrefix(String prefix, String uri) {
// resize array, if needed
if (fNamespaceSize == fNamespace.length) {
String[] namespacearray = new String[fNamespaceSize * 2];
System.arraycopy(fNamespace, 0, namespacearray, 0, fNamespaceSize);
fNamespace = namespacearray;
}
// bind prefix to uri in current context
fNamespace[fNamespaceSize++] = prefix;
fNamespace[fNamespaceSize++] = uri;
}
private void fillQName(QName toFill, Node node) {
final String prefix = node.getPrefix();
final String localName = node.getLocalName();
final String rawName = node.getNodeName();
final String namespace = node.getNamespaceURI();
toFill.prefix = (prefix != null) ? fSymbolTable.addSymbol(prefix) : XMLSymbols.EMPTY_STRING;
toFill.localpart = (localName != null) ? fSymbolTable.addSymbol(localName) : XMLSymbols.EMPTY_STRING;
toFill.rawname = (rawName != null) ? fSymbolTable.addSymbol(rawName) : XMLSymbols.EMPTY_STRING;
toFill.uri = (namespace != null && namespace.length() > 0) ? fSymbolTable.addSymbol(namespace) : null;
}
}
} // class NamespaceSupport