/*
 * 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.
 */

/* $Rev$ $Date$ */

#ifndef _XMLHELPERIMPL_H_
#define _XMLHELPERIMPL_H_

#include "commonj/sdo/disable_warn.h"

#include "commonj/sdo/XMLHelper.h"
#include "commonj/sdo/export.h"
#include "commonj/sdo/SDOXMLString.h"
#include "commonj/sdo/SAX2Namespaces.h"
#include "commonj/sdo/SchemaInfo.h"
#include "commonj/sdo/TypeDefinitionsImpl.h"
#include "commonj/sdo/ParserErrorSetter.h"

namespace commonj
{
    namespace sdo
    {
        
        /**  
         *
         * XMLHelperImpl is the implementation of the abstract class
         * XMLHelper.
         * Provides the ability to load XML data into 
         * a data object graph, according to  a schema
         */
        
        class XMLHelperImpl : public XMLHelper, ParserErrorSetter
        {
        public:            
            // Constructor
            XMLHelperImpl(DataFactoryPtr dataFactory);
            
            // Destructor
            virtual ~XMLHelperImpl();
            
            virtual unsigned int  getErrorCount() const;
            virtual const char*  getErrorMessage(unsigned int errnum) const;
            virtual void setError(const char* error);


            /**  load/loadFile - loads xml data
             *
             * De-serializes the specified XML file building a graph of DataObjects.
             * Returns a pointer to the root data object
             */

           virtual XMLDocumentPtr createDocument(
               const char* elementname= 0,
               const char* rootElementURI=0);

           virtual XMLDocumentPtr createDocument(
               const SDOString& elementname,
               const SDOString& rootElementURI);

           virtual XMLDocumentPtr loadFile(
                const char* xmlFile,
                const char* targetNamespaceURI = 0);
           virtual XMLDocumentPtr loadFile(
                const SDOString& xmlFile,
                const SDOString& targetNamespaceURI = "");

            virtual XMLDocumentPtr load(
                std::istream& inXml,
                const char* targetNamespaceURI = 0);
            virtual XMLDocumentPtr load(
                std::istream& inXml,
                const SDOString& targetNamespaceURI = "");

            virtual XMLDocumentPtr load(
                const char* inXml,
                const char* targetNamespaceURI = 0);
            virtual XMLDocumentPtr load(
                const SDOString& inXml,
                const SDOString& targetNamespaceURI = "");

            virtual XMLDocumentPtr createDocument(
                DataObjectPtr dataObject,
                const char* rootElementURI,
                const char* rootElementName);
            virtual XMLDocumentPtr createDocument(
                DataObjectPtr dataObject,
                const SDOString& rootElementURI,
                const SDOString& rootElementName);

            /**  save saves the graph to XML
             *
             * save - Serializes the datagraph to the XML file
             */

            void save(XMLDocumentPtr doc,
                      const char* xmlFile,
                      int indent = -1);
            void save(XMLDocumentPtr doc,
                      const SDOString& xmlFile,
                      int indent = -1);

            void save(
                DataObjectPtr dataObject,
                const char* rootElementURI,
                const char* rootElementName,
                const char* xmlFile, int indent = -1);
            void save(
                DataObjectPtr dataObject,
                const SDOString& rootElementURI,
                const SDOString& rootElementName,
                const SDOString& xmlFile, int indent = -1);

            /**  save saves the graph to XML
             *
             * save - Serializes the datagraph to a stream
             */

            void save(XMLDocumentPtr doc, std::ostream& outXml,
                int indent = -1);
            void save(
                DataObjectPtr dataObject,
                const char* rootElementURI,
                const char* rootElementName,
                std::ostream& outXml,
                int indent = -1);
            void save(
                DataObjectPtr dataObject,
                const SDOString& rootElementURI,
                const SDOString& rootElementName,
                std::ostream& outXml,
                int indent = -1);

            /**  save saves the graph to XML
             *
             * save - Serializes the datagraph to a string
             */
            char* save(XMLDocumentPtr doc,int indent = -1);
            char* save(
                DataObjectPtr dataObject,
                const char* rootElementURI,
                const char* rootElementName,
                int indent = -1);
            char* save(
                DataObjectPtr dataObject,
                const SDOString& rootElementURI,
                const SDOString& rootElementName,
                int indent = -1);
                            
        private:
            int     parse(const char* source);
            void clearErrors();

            std::vector<char*> parseErrors;
            
            // Instance variables
            DataFactoryImplPtr    dataFactory;
            SDOXMLString targetNamespaceURI;

            const TypeImpl* findRoot(DataFactoryImplPtr df,
                const SDOString& rootElementURI);

            DataFactoryPtr getDataFactory();
        };
        
    } // End - namespace sdo
} // End - namespace commonj

#endif // _XMLHELPERIMPL_H_