Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

XalanSourceTreeParserLiaison.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2000 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(XALANSOURCETREEPARSERLIAISON_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREEPARSERLIAISON_HEADER_GUARD_1357924680
00059 
00060 
00061 // Base include file.  Must be first.
00062 #include <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 // Standard Library header files.
00067 #include <map>
00068 
00069 
00070 
00071 #include <XercesParserLiaison/XercesDOMSupport.hpp>
00072 #include <XercesParserLiaison/XercesParserLiaison.hpp>
00073 
00074 
00075 
00076 class ContentHandler;
00077 class DTDHandler;
00078 class LexicalHandler;
00079 class XalanSourceTreeDOMSupport;
00080 class XalanSourceTreeDocument;
00081 
00082 
00083 
00084 class XALAN_XALANSOURCETREE_EXPORT  XalanSourceTreeParserLiaison : public XMLParserLiaison
00085 {
00086 public:
00087 
00095     XalanSourceTreeParserLiaison(XalanSourceTreeDOMSupport&     theSupport);
00096 
00100     XalanSourceTreeParserLiaison();
00101 
00102     virtual
00103     ~XalanSourceTreeParserLiaison();
00104 
00111     bool
00112     getPoolAllText() const
00113     {
00114         return m_poolAllText;
00115     }
00116 
00123     void
00124     setPoolAllText(bool fValue)
00125     {
00126         m_poolAllText = fValue;
00127     }
00128 
00129     // These interfaces are inherited from XMLParserLiaison...
00130 
00131     virtual void
00132     reset();
00133 
00134     virtual ExecutionContext*
00135     getExecutionContext() const;
00136 
00137     virtual void
00138     setExecutionContext(ExecutionContext&   theContext);
00139 
00140     virtual XalanDocument*
00141     parseXMLStream(
00142             const InputSource&      reader,
00143             const XalanDOMString&   identifier = XalanDOMString());
00144 
00145     virtual void
00146     parseXMLStream(
00147             const InputSource&      inputSource,
00148             DocumentHandler&        handler,
00149             const XalanDOMString&   identifier = XalanDOMString());
00150 
00151     virtual XalanDocument*
00152     createDocument();
00153 
00154     virtual XalanDocument*
00155     createDOMFactory();
00156 
00157     virtual void
00158     destroyDocument(XalanDocument*  theDocument);
00159 
00160     virtual unsigned long
00161     getDocumentNumber();
00162 
00163     virtual int
00164     getIndent() const;
00165 
00166     virtual void
00167     setIndent(int   i);
00168 
00169     virtual bool
00170     getUseValidation() const;
00171 
00172     virtual void
00173     setUseValidation(bool   b);
00174 
00175     virtual const XalanDOMString
00176     getParserDescription() const;
00177 
00178     virtual EntityResolver*
00179     getEntityResolver();
00180 
00181     virtual void
00182     setEntityResolver(EntityResolver*   resolver);
00183 
00184 
00185     // These interfaces are new to XalanSourceTreeParserLiaison...
00186 
00196     virtual void
00197     parseXMLStream(
00198             const InputSource&      theInputSource,
00199             ContentHandler&         theContentHandler,
00200             DTDHandler*             theDTDHandler = 0,
00201             LexicalHandler*         theLexicalHandler = 0,
00202             const XalanDOMString&   theIdentifier = XalanDOMString());
00203 
00214     virtual bool
00215     getIncludeIgnorableWhitespace() const;
00216 
00235     virtual void
00236     setIncludeIgnorableWhitespace(bool  include);
00237 
00244     virtual ErrorHandler*
00245     getErrorHandler();
00246 
00253     virtual const ErrorHandler*
00254     getErrorHandler() const;
00255 
00266     virtual void
00267     setErrorHandler(ErrorHandler*   handler);
00268 
00278     virtual bool
00279     getDoNamespaces() const;
00280 
00298     virtual void
00299     setDoNamespaces(bool    newState);
00300 
00310     virtual bool
00311     getExitOnFirstFatalError() const;
00312 
00328     virtual void
00329     setExitOnFirstFatalError(bool   newState);
00330 
00340     XalanSourceTreeDocument*
00341     mapDocument(const XalanDocument*    theDocument) const;
00342 
00348     XalanSourceTreeDocument*
00349     createXalanSourceTreeDocument();
00350 
00351     bool
00352     setPersistent(XalanSourceTreeDocument*  theDocument);
00353 
00354     bool
00355     unsetPersistent(XalanSourceTreeDocument*    theDocument);
00356 
00357 #if defined(XALAN_NO_NAMESPACES)
00358     typedef map<const XalanDocument*,
00359                 XalanSourceTreeDocument*,
00360                 less<const XalanDocument*> >    DocumentMapType;
00361 #else
00362     typedef std::map<const XalanDocument*,
00363                      XalanSourceTreeDocument*>  DocumentMapType;
00364 #endif
00365 
00366 private:
00367 
00368     // Data members...
00369 
00370     unsigned long               m_documentNumber;
00371 
00372     XercesParserLiaison         m_xercesParserLiaison;
00373 
00374     DocumentMapType             m_documentMap;
00375 
00376     DocumentMapType             m_persistentDocumentMap;
00377 
00378     bool                        m_poolAllText;
00379 
00380     static const XalanDOMChar   validationString[];
00381 };
00382 
00383 
00384 
00385 #endif  // XALANSOURCETREEPARSERLIAISON_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.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.