/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XDocumentBuilder.idl,v $
 * $Revision: 1.5 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_xml_dom_XDocumentBuilder_idl__
#define __com_sun_star_xml_dom_XDocumentBuilder_idl__

#ifndef __com_sun_star_uno__XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif

#ifndef __com_sun_star_xml_dom_XDocument_idl__ 
#include <com/sun/star/xml/dom/XDocumentType.idl> 
#endif
#ifndef __com_sun_star_xml_dom_XDOMImplementation_idl__ 
#include <com/sun/star/xml/dom/XDOMImplementation.idl> 
#endif
#ifndef __com_sun_star_io_XInputStream_idl__ 
#include <com/sun/star/io/XInputStream.idl> 
#endif

#ifndef __com_sun_star_xml_sax_SAXException_idl__ 
#include <com/sun/star/xml/sax/SAXException.idl> 
#endif 

#ifndef __com_sun_star_xml_sax_XErrorHandler_idl__ 
#include <com/sun/star/xml/sax/XErrorHandler.idl> 
#endif 
#ifndef __com_sun_star_xml_sax_XEntityResolver_idl__ 
#include <com/sun/star/xml/sax/XEntityResolver.idl> 
#endif 


#ifndef __com_sun_star_io_IOException_idl__ 
#include <com/sun/star/io/IOException.idl> 
#endif 

module com { module sun { module star { module xml { module dom {

interface XInputStream;

/**
Builds a new dom tree
*/
interface XDocumentBuilder : com::sun::star::uno::XInterface
{

    /**
    Obtain an instance of a DOMImplementation object.
    */
    XDOMImplementation getDOMImplementation();

    /**
    Indicates whether or not this parser is configured to understand 
    namespaces.     
    */
    boolean isNamespaceAware();

    /**       
    Indicates whether or not this parser is configured to validate XML 
    documents.
    */
    boolean isValidating();

    /**
    Obtain a new instance of a DOM Document object to build a DOM tree 
    with.          
    */
    XDocument newDocument();

    /**
    Parse the content of the given InputStream as an XML document and 
    return a new DOM Document object.     
    */
    XDocument parse([in] com::sun::star::io::XInputStream is)
            raises( com::sun::star::xml::sax::SAXException, 
                    com::sun::star::io::IOException ); 

    /**
    Parse the content of the given URI as an XML document and return 
    a new DOM Document object.
    */
    XDocument parseURI([in] string uri)
            raises( com::sun::star::xml::sax::SAXException, 
                    com::sun::star::io::IOException ); 

    /**
    Specify the EntityResolver to be used to resolve entities present
    in the XML document to be parsed.
    */
    void setEntityResolver([in] com::sun::star::xml::sax::XEntityResolver er);

    /**
    Specify the ErrorHandler to be used to report errors present in
    the XML document to be parsed.
    */
    void setErrorHandler([in] com::sun::star::xml::sax::XErrorHandler eh);

};

}; }; }; }; };

#endif