xercesc/xinclude/XIncludeDOMDocumentProcessor.hpp

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *      http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 /*
0019  * $Id$
0020  */
0021
0022 #if !defined(XERCESC_INCLUDE_GUARD_XINCLUDEDOMDOCUMENTPROCESSOR_HPP)
0023 #define XERCESC_INCLUDE_GUARD_XINCLUDEDOMDOCUMENTPROCESSOR_HPP
0024
0025 #include <xercesc/util/XercesDefs.hpp>
0026 #include <xercesc/dom/DOM.hpp>
0027 #include <xercesc/framework/XMLErrorReporter.hpp>
0028
0029 XERCES_CPP_NAMESPACE_BEGIN
0030
0031 class XMLEntityHandler;
0032
0033 /**
0034   * Class for representing and manipulating the XMLCh * href's used
0035   * by an xi:include element.
0036   *
0037   * This class is designed primarily for internal use. This class implements
0038   * the functionality required to calculate relative hrefs and the base URI
0039   * fixups required for performing XInclude functionality.
0040   */
0041 class XINCLUDE_EXPORT XIncludeDOMDocumentProcessor
0042 {
0043 public:
0044      /** Walk the supplied DOMDocument performing all XInclude's as encountered.
0045       *
0046       * @param source A DOMDocument to parse, this document is not modified.
0047       * @param errorHandled An errorHandler to call back in case of problems
0048       *
0049       * @return a newly created DOMDocument containing the parsed and actioned
0050       * xinclude elements.
0051       */
0052     DOMDocument *doXIncludeDOMProcess(const DOMDocument * const source, XMLErrorReporter *errorHandler, XMLEntityHandler* entityResolver=NULL);
0053 };
0054
0055 XERCES_CPP_NAMESPACE_END
0056
0057 #endif /* XINCLUDEDOMDOCUMENTPROCESSOR_HPP */
0058