org.apache.xerces.jaxp.validation.DOMDocumentHandler Maven / Gradle / Ivy

Go to download
/*
 * 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.jaxp.validation;

import javax.xml.transform.dom.DOMResult;

import org.apache.xerces.xni.XMLDocumentHandler;
import org.apache.xerces.xni.XNIException;
import org.w3c.dom.CDATASection;
import org.w3c.dom.Comment;
import org.w3c.dom.DocumentType;
import org.w3c.dom.ProcessingInstruction;
import org.w3c.dom.Text;

/**
 * An extension to XMLDocumentHandler for building DOM structures.
 * 
 * @author Michael Glavassevich, IBM
 * @version $Id: DOMDocumentHandler.java 699902 2008-09-28 21:40:49Z mrglavas $
 */
interface DOMDocumentHandler extends XMLDocumentHandler {
    
    /**
     * Sets the DOMResult object which 
     * receives the constructed DOM nodes.
     * 
     * @param result the object which receives the constructed DOM nodes
     */
    public void setDOMResult(DOMResult result);
    
    /**
     * A document type declaration.
     * 
     * @param node a DocumentType node
     *                 
     * @exception XNIException Thrown by handler to signal an error.
     */
    public void doctypeDecl(DocumentType node) throws XNIException;
    
    public void characters(Text node) throws XNIException;
    
    public void cdata(CDATASection node) throws XNIException;
    
    /**
     * A comment.
     * 
     * @param node a Comment node
     *               
     * @exception XNIException Thrown by application to signal an error.
     */
    public void comment(Comment node) throws XNIException;
    
    /**
     * A processing instruction. Processing instructions consist of a
     * target name and, optionally, text data. The data is only meaningful
     * to the application.
     * 
     * Typically, a processing instruction's data will contain a series
     * of pseudo-attributes. These pseudo-attributes follow the form of
     * element attributes but are not parsed or presented
     * to the application as anything other than text. The application is
     * responsible for parsing the data.
     * 
     * @param node a ProcessingInstruction node
     *               
     * @exception XNIException Thrown by handler to signal an error.
     */
    public void processingInstruction(ProcessingInstruction node) throws XNIException;
    
    public void setIgnoringCharacters(boolean ignore);
}