/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

#ifndef DOMWriterFilter_HEADER_GUARD_

#define DOMWriterFilter_HEADER_GUARD_

/*

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

 */

/*

 * $Id: DOMWriterFilter.hpp 568078 2007-08-21 11:43:25Z amassari $

 */

/**

 *

 * DOMWriterFilter.hpp: interface for the DOMWriterFilter class.

 *

 * DOMWriterFilter provide applications the ability to examine nodes

 * as they are being serialized.

 *

 * DOMWriterFilter lets the application decide what nodes should be

 * serialized or not.

 *

 * The DOMDocument, DOMDocumentType, DOMNotation, and DOMEntity nodes are not passed

 * to the filter.

 *

 * @since DOM Level 3

 */

#include <xercesc/dom/DOMNodeFilter.hpp>

XERCES_CPP_NAMESPACE_BEGIN

class CDOM_EXPORT DOMWriterFilter : public DOMNodeFilter {

protected:

    // -----------------------------------------------------------------------

    //  Hidden constructors

    // -----------------------------------------------------------------------

    /** @name Hidden constructors */

    //@{    

    DOMWriterFilter() {};

    //@}

private:

    // -----------------------------------------------------------------------

    // Unimplemented constructors and operators

    // -----------------------------------------------------------------------

    /** @name Unimplemented constructors and operators */

    //@{

    DOMWriterFilter(const DOMWriterFilter &);

    DOMWriterFilter & operator = (const DOMWriterFilter &);

    //@}

public:

    // -----------------------------------------------------------------------

    //  All constructors are hidden, just the destructor is available

    // -----------------------------------------------------------------------

    /** @name Destructor */

    //@{

    /**

     * Destructor

     *

     */

    virtual ~DOMWriterFilter() {};

    //@}

    // -----------------------------------------------------------------------

    //  Virtual DOMWriterFilter interface

    // -----------------------------------------------------------------------

    /** @name Functions introduced in DOM Level 3 */

    //@{

	 /**

     * Interface from <code>DOMNodeFilter</code>,

     * to be implemented by implementation (derived class)

     */

    virtual short acceptNode(const DOMNode* node) const = 0;

    /**

     * Tells the DOMWriter what types of nodes to show to the filter.

     * See <code>DOMNodeFilter</code> for definition of the constants.

     * The constant SHOW_ATTRIBUTE is meaningless here, attribute nodes will

     * never be passed to a DOMWriterFilter.

     *

     *  <p><b>"Experimental - subject to change"</b></p>

     *

     * @return The constants of what types of nodes to show.

     * @see   setWhatToShow

     * @since DOM Level 3

     */

    virtual unsigned long getWhatToShow() const =0;

    /**

     * Set what types of nodes are to be presented.

     * See <code>DOMNodeFilter</code> for definition of the constants.

     *

     *  <p><b>"Experimental - subject to change"</b></p>

     *

     * @param toShow The constants of what types of nodes to show.

     * @see   getWhatToShow

     * @since DOM Level 3

     */

    virtual void          setWhatToShow(unsigned long toShow) =0;

    //@}

private:

    // -----------------------------------------------------------------------

    //  Private data members

    //

    //  fWhatToShow

    //

    //      The whatToShow mask.

    //      Tells the DOMWriter what types of nodes to show to the filter.

    //      See NodeFilter for definition of the constants.

    //      The constants

    //      SHOW_ATTRIBUTE,

    //      SHOW_DOCUMENT,

    //      SHOW_DOCUMENT_TYPE,

    //      SHOW_NOTATION, and

    //      SHOW_DOCUMENT_FRAGMENT are meaningless here,

    //      Entity nodes are not passed to the filter.

    //

    //      Those nodes will never be passed to a DOMWriterFilter.

    //

    //   Derived class shall add this data member:

    //

    //   unsigned long fWhatToShow;

    // -----------------------------------------------------------------------

};

XERCES_CPP_NAMESPACE_END

#endif