org.apache.xerces.parsers.XPointerParserConfiguration Maven / Gradle / Ivy
/*
* 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.parsers;
import org.apache.xerces.impl.Constants;
import org.apache.xerces.util.SymbolTable;
import org.apache.xerces.xinclude.XIncludeHandler;
import org.apache.xerces.xinclude.XIncludeNamespaceSupport;
import org.apache.xerces.xni.XMLDocumentHandler;
import org.apache.xerces.xni.grammars.XMLGrammarPool;
import org.apache.xerces.xni.parser.XMLComponentManager;
import org.apache.xerces.xni.parser.XMLConfigurationException;
import org.apache.xerces.xni.parser.XMLDocumentSource;
import org.apache.xerces.xpointer.XPointerHandler;
/**
* This parser configuration includes an XPointerHandler in the pipeline
* before the schema validator, or as the last component in the pipeline if there is
* no schema validator. Using this pipeline will enable processing according to the
* XML Inclusions specification with XPointers, to the conformance level described in
* XPointerHandler..
*
* @see org.apache.xerces.xpointer.XPointerHandler
*/
public class XPointerParserConfiguration extends XML11Configuration {
private XPointerHandler fXPointerHandler;
private XIncludeHandler fXIncludeHandler;
/** Feature identifier: allow notation and unparsed entity events to be sent out of order. */
protected static final String ALLOW_UE_AND_NOTATION_EVENTS =
Constants.SAX_FEATURE_PREFIX + Constants.ALLOW_DTD_EVENTS_AFTER_ENDDTD_FEATURE;
/** Feature identifier: fixup base URIs. */
protected static final String XINCLUDE_FIXUP_BASE_URIS =
Constants.XERCES_FEATURE_PREFIX + Constants.XINCLUDE_FIXUP_BASE_URIS_FEATURE;
/** Feature identifier: fixup language. */
protected static final String XINCLUDE_FIXUP_LANGUAGE =
Constants.XERCES_FEATURE_PREFIX + Constants.XINCLUDE_FIXUP_LANGUAGE_FEATURE;
/** Property identifier: error reporter. */
protected static final String XPOINTER_HANDLER =
Constants.XERCES_PROPERTY_PREFIX + Constants.XPOINTER_HANDLER_PROPERTY;
/** Property identifier: error reporter. */
protected static final String XINCLUDE_HANDLER =
Constants.XERCES_PROPERTY_PREFIX + Constants.XINCLUDE_HANDLER_PROPERTY;
/** Property identifier: error reporter. */
protected static final String NAMESPACE_CONTEXT =
Constants.XERCES_PROPERTY_PREFIX + Constants.NAMESPACE_CONTEXT_PROPERTY;
/** Default constructor. */
public XPointerParserConfiguration() {
this(null, null, null);
} // ()
/**
* Constructs a parser configuration using the specified symbol table.
*
* @param symbolTable The symbol table to use.
*/
public XPointerParserConfiguration(SymbolTable symbolTable) {
this(symbolTable, null, null);
} // (SymbolTable)
/**
* Constructs a parser configuration using the specified symbol table and
* grammar pool.
*
*
* @param symbolTable The symbol table to use.
* @param grammarPool The grammar pool to use.
*/
public XPointerParserConfiguration(
SymbolTable symbolTable,
XMLGrammarPool grammarPool) {
this(symbolTable, grammarPool, null);
} // (SymbolTable,XMLGrammarPool)
/**
* Constructs a parser configuration using the specified symbol table,
* grammar pool, and parent settings.
*
*
* @param symbolTable The symbol table to use.
* @param grammarPool The grammar pool to use.
* @param parentSettings The parent settings.
*/
public XPointerParserConfiguration(
SymbolTable symbolTable,
XMLGrammarPool grammarPool,
XMLComponentManager parentSettings) {
super(symbolTable, grammarPool, parentSettings);
fXIncludeHandler = new XIncludeHandler();
addCommonComponent(fXIncludeHandler);
fXPointerHandler = new XPointerHandler();
addCommonComponent(fXPointerHandler);
final String[] recognizedFeatures = {
ALLOW_UE_AND_NOTATION_EVENTS,
XINCLUDE_FIXUP_BASE_URIS,
XINCLUDE_FIXUP_LANGUAGE
};
addRecognizedFeatures(recognizedFeatures);
// add default recognized properties
final String[] recognizedProperties =
{ XINCLUDE_HANDLER, XPOINTER_HANDLER, NAMESPACE_CONTEXT };
addRecognizedProperties(recognizedProperties);
setFeature(ALLOW_UE_AND_NOTATION_EVENTS, true);
setFeature(XINCLUDE_FIXUP_BASE_URIS, true);
setFeature(XINCLUDE_FIXUP_LANGUAGE, true);
setProperty(XINCLUDE_HANDLER, fXIncludeHandler);
setProperty(XPOINTER_HANDLER, fXPointerHandler);
setProperty(NAMESPACE_CONTEXT, new XIncludeNamespaceSupport());
} // (SymbolTable,XMLGrammarPool)}
/** Configures the pipeline. */
protected void configurePipeline() {
super.configurePipeline();
//configure DTD pipeline
fDTDScanner.setDTDHandler(fDTDProcessor);
fDTDProcessor.setDTDSource(fDTDScanner);
fDTDProcessor.setDTDHandler(fXIncludeHandler);
fXIncludeHandler.setDTDSource(fDTDProcessor);
fXIncludeHandler.setDTDHandler(fXPointerHandler);
fXPointerHandler.setDTDSource(fXIncludeHandler);
fXPointerHandler.setDTDHandler(fDTDHandler);
if (fDTDHandler != null) {
fDTDHandler.setDTDSource(fXPointerHandler);
}
// configure XML document pipeline: insert after DTDValidator and
// before XML Schema validator
XMLDocumentSource prev = null;
if (fFeatures.get(XMLSCHEMA_VALIDATION) == Boolean.TRUE) {
// we don't have to worry about fSchemaValidator being null, since
// super.configurePipeline() instantiated it if the feature was set
prev = fSchemaValidator.getDocumentSource();
}
// Otherwise, insert after the last component in the pipeline
else {
prev = fLastComponent;
fLastComponent = fXPointerHandler;
}
XMLDocumentHandler next = prev.getDocumentHandler();
prev.setDocumentHandler(fXIncludeHandler);
fXIncludeHandler.setDocumentSource(prev);
if (next != null) {
fXIncludeHandler.setDocumentHandler(next);
next.setDocumentSource(fXIncludeHandler);
}
fXIncludeHandler.setDocumentHandler(fXPointerHandler);
fXPointerHandler.setDocumentSource(fXIncludeHandler);
} // configurePipeline()
protected void configureXML11Pipeline() {
super.configureXML11Pipeline();
// configure XML 1.1. DTD pipeline
fXML11DTDScanner.setDTDHandler(fXML11DTDProcessor);
fXML11DTDProcessor.setDTDSource(fXML11DTDScanner);
fDTDProcessor.setDTDHandler(fXIncludeHandler);
fXIncludeHandler.setDTDSource(fXML11DTDProcessor);
fXIncludeHandler.setDTDHandler(fXPointerHandler);
fXPointerHandler.setDTDSource(fXIncludeHandler);
fXPointerHandler.setDTDHandler(fDTDHandler);
if (fDTDHandler != null) {
fDTDHandler.setDTDSource(fXPointerHandler);
}
// configure XML document pipeline: insert after DTDValidator and
// before XML Schema validator
XMLDocumentSource prev = null;
if (fFeatures.get(XMLSCHEMA_VALIDATION) == Boolean.TRUE) {
// we don't have to worry about fSchemaValidator being null, since
// super.configurePipeline() instantiated it if the feature was set
prev = fSchemaValidator.getDocumentSource();
}
// Otherwise, insert after the last component in the pipeline
else {
prev = fLastComponent;
fLastComponent = fXPointerHandler;
}
XMLDocumentHandler next = prev.getDocumentHandler();
prev.setDocumentHandler(fXIncludeHandler);
fXIncludeHandler.setDocumentSource(prev);
if (next != null) {
fXIncludeHandler.setDocumentHandler(next);
next.setDocumentSource(fXIncludeHandler);
}
fXIncludeHandler.setDocumentHandler(fXPointerHandler);
fXPointerHandler.setDocumentSource(fXIncludeHandler);
} // configureXML11Pipeline()
public void setProperty(String propertyId, Object value)
throws XMLConfigurationException {
//if (propertyId.equals(XINCLUDE_HANDLER)) {
//}
super.setProperty(propertyId, value);
} // setProperty(String,Object)
}