DOMUserDataHandler.hpp Source File

00001 #ifndef DOMUserDataHandler_HEADER_GUARD_
00002 #define DOMUserDataHandler_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2002 The Apache Software Foundation.  All rights
00008  * reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions
00012  * are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright
00015  *    notice, this list of conditions and the following disclaimer.
00016  *
00017  * 2. Redistributions in binary form must reproduce the above copyright
00018  *    notice, this list of conditions and the following disclaimer in
00019  *    the documentation and/or other materials provided with the
00020  *    distribution.
00021  *
00022  * 3. The end-user documentation included with the redistribution,
00023  *    if any, must include the following acknowledgment:
00024  *       "This product includes software developed by the
00025  *        Apache Software Foundation (http://www.apache.org/)."
00026  *    Alternately, this acknowledgment may appear in the software itself,
00027  *    if and wherever such third-party acknowledgments normally appear.
00028  *
00029  * 4. The names "Xerces" and "Apache Software Foundation" must
00030  *    not be used to endorse or promote products derived from this
00031  *    software without prior written permission. For written
00032  *    permission, please contact apache\@apache.org.
00033  *
00034  * 5. Products derived from this software may not be called "Apache",
00035  *    nor may "Apache" appear in their name, without prior written
00036  *    permission of the Apache Software Foundation.
00037  *
00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00049  * SUCH DAMAGE.
00050  * ====================================================================
00051  *
00052  * This software consists of voluntary contributions made by many
00053  * individuals on behalf of the Apache Software Foundation, and was
00054  * originally based on software copyright (c) 1999, International
00055  * Business Machines, Inc., http://www.ibm.com .  For more information
00056  * on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * $Id: DOMUserDataHandler.hpp,v 1.6 2003/03/07 19:59:09 tng Exp $
00062  */
00063 
00064 #include <xercesc/util/XercesDefs.hpp>
00065 #include <xercesc/dom/DOMNode.hpp>
00066 
00067 XERCES_CPP_NAMESPACE_BEGIN
00068 
00081 class  DOMUserDataHandler {
00082 protected:
00083     // -----------------------------------------------------------------------
00084     //  Hidden constructors
00085     // -----------------------------------------------------------------------
00088     DOMUserDataHandler() {};
00090 
00091 private:
00092     // -----------------------------------------------------------------------
00093     // Unimplemented constructors and operators
00094     // -----------------------------------------------------------------------
00097     DOMUserDataHandler(const DOMUserDataHandler &);
00098     DOMUserDataHandler & operator = (const DOMUserDataHandler &);
00100 
00101 public:
00102     // -----------------------------------------------------------------------
00103     //  All constructors are hidden, just the destructor is available
00104     // -----------------------------------------------------------------------
00111     virtual ~DOMUserDataHandler() {};
00113 
00114     // -----------------------------------------------------------------------
00115     //  Class Types
00116     // -----------------------------------------------------------------------
00138     enum DOMOperationType {
00139         NODE_CLONED               = 1,
00140         NODE_IMPORTED             = 2,
00141         NODE_DELETED              = 3,
00142         NODE_RENAMED              = 4
00143     };
00145 
00146 
00147     // -----------------------------------------------------------------------
00148     //  Virtual DOMUserDataHandler interface
00149     // -----------------------------------------------------------------------
00166     virtual void handle(DOMOperationType operation,
00167                         const XMLCh* const key,
00168                         void* data,
00169                         const DOMNode* src,
00170                         const DOMNode* dst) = 0;
00171 
00173 
00174 };
00175 
00176 XERCES_CPP_NAMESPACE_END
00177 
00178 #endif
00179