xercesc/dom/DOMNotation.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_DOMNOTATION_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMNOTATION_HPP
0024
0025 #include <xercesc/util/XercesDefs.hpp>
0026 #include <xercesc/dom/DOMNode.hpp>
0027
0028 XERCES_CPP_NAMESPACE_BEGIN
0029
0030
0031 /**
0032  * This interface represents a notation declared in the DTD. A notation either
0033  * declares, by name, the format of an unparsed entity (see section 4.7 of
0034  * the XML 1.0 specification), or is used for formal declaration of
0035  * Processing Instruction targets (see section 2.6 of the XML 1.0
0036  * specification). The <code>nodeName</code> attribute inherited from
0037  * <code>DOMNode</code> is set to the declared name of the notation.
0038  * <p>The DOM Level 1 does not support editing <code>DOMNotation</code> nodes;
0039  * they are therefore readonly.
0040  * <p>A <code>DOMNotation</code> node does not have any parent.
0041  *
0042  * @since DOM Level 1
0043  */
0044 class CDOM_EXPORT DOMNotation: public DOMNode {
0045 protected:
0046     // -----------------------------------------------------------------------
0047     //  Hidden constructors
0048     // -----------------------------------------------------------------------
0049     /** @name Hidden constructors */
0050     //@{
0051     DOMNotation() {}
0052     DOMNotation(const DOMNotation &other) : DOMNode(other) {}
0053     //@}
0054
0055 private:
0056     // -----------------------------------------------------------------------
0057     // Unimplemented constructors and operators
0058     // -----------------------------------------------------------------------
0059     /** @name Unimplemented operators */
0060     //@{
0061     DOMNotation & operator = (const DOMNotation &);
0062     //@}
0063
0064 public:
0065     // -----------------------------------------------------------------------
0066     //  All constructors are hidden, just the destructor is available
0067     // -----------------------------------------------------------------------
0068     /** @name Destructor */
0069     //@{
0070     /**
0071      * Destructor
0072      *
0073      */
0074     virtual ~DOMNotation() {};
0075     //@}
0076
0077
0078     // -----------------------------------------------------------------------
0079     //  Virtual DOMNotation interface
0080     // -----------------------------------------------------------------------
0081     /** @name Functions introduced in DOM Level 1 */
0082     //@{
0083     // -----------------------------------------------------------------------
0084     //  Getter methods
0085     // -----------------------------------------------------------------------
0086     /**
0087      * Get the public identifier of this notation.
0088      *
0089      * If the  public identifier was not
0090      * specified, this is <code>null</code>.
0091      * @return Returns the public identifier of the notation
0092      * @since DOM Level 1
0093      */
0094     virtual const XMLCh *getPublicId() const = 0;
0095
0096     /**
0097      * Get the system identifier of this notation.
0098      *
0099      * If the  system identifier was not
0100      * specified, this is <code>null</code>.
0101      * @return Returns the system identifier of the notation
0102      * @since DOM Level 1
0103      */
0104     virtual const XMLCh *getSystemId() const = 0;
0105
0106
0107     //@}
0108 };
0109
0110 XERCES_CPP_NAMESPACE_END
0111
0112 #endif
0113
0114