Back to index...

	/*
	* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
	*/
	/*
	* 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 com.sun.org.apache.xerces.internal.jaxp;

	import com.sun.org.apache.xerces.internal.impl.validation.EntityState;
	import com.sun.org.apache.xerces.internal.impl.validation.ValidationManager;
	import com.sun.org.apache.xerces.internal.xni.Augmentations;
	import com.sun.org.apache.xerces.internal.xni.XMLDTDHandler;
	import com.sun.org.apache.xerces.internal.xni.XMLLocator;
	import com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier;
	import com.sun.org.apache.xerces.internal.xni.XMLString;
	import com.sun.org.apache.xerces.internal.xni.XNIException;
	import com.sun.org.apache.xerces.internal.xni.parser.XMLDTDFilter;
	import com.sun.org.apache.xerces.internal.xni.parser.XMLDTDSource;
	import java.util.HashMap;
	import java.util.Map;

	/**
	* <p>This filter records which unparsed entities have been
	* declared in the DTD and provides this information to a ValidationManager.
	* Events are forwarded to the registered XMLDTDHandler without modification.</p>
	*
	* @author Michael Glavassevich, IBM
	* @LastModified: Oct 2017
	*/
	final class UnparsedEntityHandler implements XMLDTDFilter, EntityState {

	/ DTD source and handler. /
	private XMLDTDSource fDTDSource;
	private XMLDTDHandler fDTDHandler;

	/** Validation manager. */
	private final ValidationManager fValidationManager;

	/** Map for tracking unparsed entities. */
	private Map<String, String> fUnparsedEntities = null;

	UnparsedEntityHandler(ValidationManager manager) {
	fValidationManager = manager;
	}

	/*
	* XMLDTDHandler methods
	*/

	public void startDTD(XMLLocator locator, Augmentations augmentations)
	throws XNIException {
	fValidationManager.setEntityState(this);
	if (fDTDHandler != null) {
	fDTDHandler.startDTD(locator, augmentations);
	}
	}

	public void startParameterEntity(String name,
	XMLResourceIdentifier identifier, String encoding,
	Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.startParameterEntity(name, identifier, encoding, augmentations);
	}
	}

	public void textDecl(String version, String encoding,
	Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.textDecl(version, encoding, augmentations);
	}
	}

	public void endParameterEntity(String name, Augmentations augmentations)
	throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.endParameterEntity(name, augmentations);
	}
	}

	public void startExternalSubset(XMLResourceIdentifier identifier,
	Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.startExternalSubset(identifier, augmentations);
	}
	}

	public void endExternalSubset(Augmentations augmentations)
	throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.endExternalSubset(augmentations);
	}
	}

	public void comment(XMLString text, Augmentations augmentations)
	throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.comment(text, augmentations);
	}
	}

	public void processingInstruction(String target, XMLString data,
	Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.processingInstruction(target, data, augmentations);
	}
	}

	public void elementDecl(String name, String contentModel,
	Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.elementDecl(name, contentModel, augmentations);
	}
	}

	public void startAttlist(String elementName, Augmentations augmentations)
	throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.startAttlist(elementName, augmentations);
	}
	}

	public void attributeDecl(String elementName, String attributeName,
	String type, String[] enumeration, String defaultType,
	XMLString defaultValue, XMLString nonNormalizedDefaultValue,
	Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.attributeDecl(elementName, attributeName,
	type, enumeration, defaultType,
	defaultValue, nonNormalizedDefaultValue,
	augmentations);
	}
	}

	public void endAttlist(Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.endAttlist(augmentations);
	}
	}

	public void internalEntityDecl(String name, XMLString text,
	XMLString nonNormalizedText, Augmentations augmentations)
	throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.internalEntityDecl(name, text,
	nonNormalizedText, augmentations);
	}
	}

	public void externalEntityDecl(String name,
	XMLResourceIdentifier identifier, Augmentations augmentations)
	throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.externalEntityDecl(name, identifier, augmentations);
	}
	}

	public void unparsedEntityDecl(String name,
	XMLResourceIdentifier identifier, String notation,
	Augmentations augmentations) throws XNIException {
	if (fUnparsedEntities == null) {
	fUnparsedEntities = new HashMap<>();
	}
	fUnparsedEntities.put(name, name);
	if (fDTDHandler != null) {
	fDTDHandler.unparsedEntityDecl(name, identifier, notation, augmentations);
	}
	}

	public void notationDecl(String name, XMLResourceIdentifier identifier,
	Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.notationDecl(name, identifier, augmentations);
	}
	}

	public void startConditional(short type, Augmentations augmentations)
	throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.startConditional(type, augmentations);
	}
	}

	public void ignoredCharacters(XMLString text, Augmentations augmentations)
	throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.ignoredCharacters(text, augmentations);
	}

	}

	public void endConditional(Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.endConditional(augmentations);
	}
	}

	public void endDTD(Augmentations augmentations) throws XNIException {
	if (fDTDHandler != null) {
	fDTDHandler.endDTD(augmentations);
	}
	}

	public void setDTDSource(XMLDTDSource source) {
	fDTDSource = source;
	}

	public XMLDTDSource getDTDSource() {
	return fDTDSource;
	}

	/*
	* XMLDTDSource methods
	*/

	public void setDTDHandler(XMLDTDHandler handler) {
	fDTDHandler = handler;
	}

	public XMLDTDHandler getDTDHandler() {
	return fDTDHandler;
	}

	/*
	* EntityState methods
	*/

	public boolean isEntityDeclared(String name) {
	return false;
	}

	public boolean isEntityUnparsed(String name) {
	if (fUnparsedEntities != null) {
	return fUnparsedEntities.containsKey(name);
	}
	return false;
	}

	/*
	* Other methods
	*/

	public void reset() {
	if (fUnparsedEntities != null && !fUnparsedEntities.isEmpty()) {
	// should only clear this if the last document contained unparsed entities
	fUnparsedEntities.clear();
	}
	}
	}

Back to index...