Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XMLParserLiaison.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XMLPARSERLIAISON_HEADER_GUARD_1357924680)
00058 #define XMLPARSERLIAISON_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XMLSupport/XMLSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <XalanDOM/XalanDOMString.hpp>
00068 
00069 
00070 
00071 #include <PlatformSupport/Resettable.hpp>
00072 
00073 
00074 
00075 class DocumentHandler;
00076 class FormatterListener;
00077 class InputSource;
00078 class URLInputSource;
00079 class XalanAttr;
00080 class XalanDocument;
00081 class XalanElement;
00082 
00083 
00084 
00085 class XALAN_XMLSUPPORT_EXPORT XMLParserLiaison : public Resettable
00086 {
00087 public:
00088 
00089     XMLParserLiaison();
00090 
00091     virtual
00092     ~XMLParserLiaison();
00093 
00094     // These interfaces are inherited from Resettable...
00095 
00096     virtual void
00097     reset() = 0;
00098 
00099     // These interfaces are new to XMLParserLiaison
00100 
00106     virtual bool
00107     supportsSAX() const = 0;
00108 
00121     virtual XalanDocument*
00122     parseXMLStream(
00123             InputSource&            inputSource,
00124             const XalanDOMString&   identifier = XalanDOMString()) = 0;
00125 
00137     virtual void
00138     parseXMLStream(
00139             InputSource&            inputSource,
00140             DocumentHandler&        handler,
00141             const XalanDOMString&   identifier = XalanDOMString()) = 0;
00142 
00149     virtual XalanDocument*
00150     createDocument() = 0;
00151 
00157     virtual XalanDocument*
00158     getDOMFactory() = 0;
00159 
00166     virtual XalanDOMString
00167     getExpandedElementName(const XalanElement&  elem) const = 0;
00168 
00175     virtual XalanDOMString
00176     getExpandedAttributeName(const XalanAttr&   attr) const = 0;
00177 
00183     virtual const XalanDOMString&
00184     getSpecialCharacters() const = 0;
00185 
00191     virtual void
00192     setSpecialCharacters(const XalanDOMString&  str) = 0;
00193 
00199     virtual int
00200     getIndent() const = 0;
00201 
00207     virtual void
00208     setIndent(int   i) = 0;
00209 
00216     virtual bool
00217     getShouldExpandEntityRefs() const = 0;
00218 
00225     virtual void
00226     SetShouldExpandEntityRefs(bool  b) = 0;
00227 
00234     virtual bool
00235     getUseValidation() const = 0;
00236 
00243     virtual void
00244     setUseValidation(bool   b) = 0;
00245 
00251     virtual const XalanDOMString
00252     getParserDescription() const = 0;
00253 
00254 private:
00255 
00256     // Not implemented
00257     XMLParserLiaison(const XMLParserLiaison&);
00258 
00259     XMLParserLiaison&
00260     operator=(const XMLParserLiaison&);
00261 };
00262 
00263 
00264 
00265 #endif  // XMLPARSERLIAISON_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.