Xalan-C++ API Documentation

00001 /*
00002  * Copyright 1999-2004 The Apache Software Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #if !defined(XALANENTITYREFERENCE_HEADER_GUARD_1357924680)
00017 #define XALANENTITYREFERENCE_HEADER_GUARD_1357924680
00018 
00019 
00020 
00021 #include <xalanc/XalanDOM/XalanDOMDefinitions.hpp>
00022 #include <xalanc/XalanDOM/XalanNode.hpp>
00023 
00024 
00025 
00026 XALAN_CPP_NAMESPACE_BEGIN
00027 
00028 
00029 
00030 /*
00031  * <meta name="usage" content="experimental"/>
00032  *
00033  * Base class for the DOM EntityReference interface.
00034  *
00035  * This class is experimental and subject to change!!
00036  */
00037 
00038 class XALAN_DOM_EXPORT XalanEntityReference : public XalanNode
00039 {
00040 public:
00041 
00042     XalanEntityReference();
00043 
00044     virtual
00045     ~XalanEntityReference();
00046 
00047 
00048     // These interfaces are inherited from XalanNode...
00049     virtual const XalanDOMString&
00050     getNodeName() const = 0;
00051 
00055     virtual const XalanDOMString&
00056     getNodeValue() const = 0;
00057 
00061     virtual NodeType
00062     getNodeType() const = 0;
00063 
00073     virtual XalanNode*
00074     getParentNode() const = 0;
00075 
00089     virtual const XalanNodeList*
00090     getChildNodes() const = 0;
00091 
00097     virtual XalanNode*
00098     getFirstChild() const = 0;
00099 
00105     virtual XalanNode*
00106     getLastChild() const = 0;
00107 
00113     virtual XalanNode*
00114     getPreviousSibling() const = 0;
00115 
00121     virtual XalanNode*
00122     getNextSibling() const = 0;
00123 
00128     virtual const XalanNamedNodeMap*
00129     getAttributes() const = 0;
00130 
00140     virtual XalanDocument*
00141     getOwnerDocument() const = 0;
00142 
00144 
00146 
00165     virtual XalanNode*
00166     cloneNode(bool deep) const = 0;
00167 
00169 
00171 
00188     virtual XalanNode*
00189     insertBefore(
00190             XalanNode*  newChild,
00191             XalanNode*  refChild) = 0;
00192 
00206     virtual XalanNode*
00207     replaceChild(
00208             XalanNode*  newChild,
00209             XalanNode*  oldChild) = 0;
00210 
00218     virtual XalanNode*
00219     removeChild(XalanNode*  oldChild) = 0;
00220 
00232     virtual XalanNode*
00233     appendChild(XalanNode*  newChild) = 0;
00234 
00236 
00238 
00246     virtual bool
00247     hasChildNodes() const = 0;
00248 
00249 
00251 
00253 
00254 
00268     virtual void
00269     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00270 
00272 
00274 
00291     virtual void
00292     normalize() = 0;
00293 
00307     virtual bool
00308     isSupported(
00309             const XalanDOMString&   feature,
00310             const XalanDOMString&   version) const = 0;
00311 
00325     virtual const XalanDOMString&
00326     getNamespaceURI() const = 0;
00327 
00332     virtual const XalanDOMString&
00333     getPrefix() const = 0;
00334 
00342     virtual const XalanDOMString&
00343     getLocalName() const = 0;
00344 
00374     virtual void
00375     setPrefix(const XalanDOMString& prefix) = 0;
00376 
00382     virtual bool
00383     isIndexed() const = 0;
00384 
00391     virtual IndexType
00392     getIndex() const = 0;
00393 
00395 
00396 protected:
00397 
00398     XalanEntityReference(const XalanEntityReference&    theSource);
00399 
00400     XalanEntityReference&
00401     operator=(const XalanEntityReference&   theSource);
00402 
00403     bool
00404     operator==(const XalanEntityReference&  theRHS) const;
00405 
00406 private:
00407 };
00408 
00409 
00410 
00411 XALAN_CPP_NAMESPACE_END
00412 
00413 
00414 
00415 #endif  // !defined(XALANENTITYREFERENCE_HEADER_GUARD_1357924680)
Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.
Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanEntityReference.hpp
