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(XALANENTITY_HEADER_GUARD_1357924680)
00017 #define XALANENTITY_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 Entity interface.
00034  *
00035  * This class is experimental and subject to change!!
00036  */
00037 
00038 class XALAN_DOM_EXPORT XalanEntity : public XalanNode
00039 {
00040 public:
00041 
00042     XalanEntity();
00043 
00044     virtual
00045     ~XalanEntity();
00046 
00047 
00048     // These interfaces are inherited from XalanNode...
00049 
00050     virtual const XalanDOMString&
00051     getNodeName() const = 0;
00052 
00056     virtual const XalanDOMString&
00057     getNodeValue() const = 0;
00058 
00062     virtual NodeType
00063     getNodeType() const = 0;
00064 
00074     virtual XalanNode*
00075     getParentNode() const = 0;
00076 
00090     virtual const XalanNodeList*
00091     getChildNodes() const = 0;
00092 
00098     virtual XalanNode*
00099     getFirstChild() const = 0;
00100 
00106     virtual XalanNode*
00107     getLastChild() const = 0;
00108 
00114     virtual XalanNode*
00115     getPreviousSibling() const = 0;
00116 
00122     virtual XalanNode*
00123     getNextSibling() const = 0;
00124 
00129     virtual const XalanNamedNodeMap*
00130     getAttributes() const = 0;
00131 
00141     virtual XalanDocument*
00142     getOwnerDocument() const = 0;
00143 
00145 
00147 
00166     virtual XalanNode*
00167     cloneNode(bool deep) const = 0;
00168 
00170 
00172 
00189     virtual XalanNode*
00190     insertBefore(
00191             XalanNode*  newChild,
00192             XalanNode*  refChild) = 0;
00193 
00207     virtual XalanNode*
00208     replaceChild(
00209             XalanNode*  newChild,
00210             XalanNode*  oldChild) = 0;
00211 
00219     virtual XalanNode*
00220     removeChild(XalanNode*  oldChild) = 0;
00221 
00233     virtual XalanNode*
00234     appendChild(XalanNode*  newChild) = 0;
00235 
00237 
00239 
00247     virtual bool
00248     hasChildNodes() const = 0;
00249 
00250 
00252 
00254 
00255 
00269     virtual void
00270     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00271 
00273 
00275 
00292     virtual void
00293     normalize() = 0;
00294 
00308     virtual bool
00309     isSupported(
00310             const XalanDOMString&   feature,
00311             const XalanDOMString&   version) const = 0;
00312 
00326     virtual const XalanDOMString&
00327     getNamespaceURI() const = 0;
00328 
00333     virtual const XalanDOMString&
00334     getPrefix() const = 0;
00335 
00343     virtual const XalanDOMString&
00344     getLocalName() const = 0;
00345 
00375     virtual void
00376     setPrefix(const XalanDOMString& prefix) = 0;
00377 
00383     virtual bool
00384     isIndexed() const = 0;
00385 
00392     virtual IndexType
00393     getIndex() const = 0;
00394 
00396 
00397     // These interfaces are new to XalanEntity...
00398 
00406     virtual const XalanDOMString&
00407     getPublicId() const = 0;
00408 
00416     virtual const XalanDOMString&
00417     getSystemId() const = 0;
00418 
00424     virtual const XalanDOMString&
00425     getNotationName() const = 0;
00426 
00427 protected:
00428 
00429     XalanEntity(const XalanEntity&  theSource);
00430 
00431     XalanEntity&
00432     operator=(const XalanEntity&    theSource);
00433 
00434     bool
00435     operator==(const XalanEntity&   theRHS) const;
00436 
00437 private:
00438 };
00439 
00440 
00441 
00442 XALAN_CPP_NAMESPACE_END
00443 
00444 
00445 
00446 #endif  // !defined(XALANENTITY_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.9

XalanEntity.hpp
