Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XalanSourceTreeAttr.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #if !defined(XALANSOURCETREEATTR_HEADER_GUARD_1357924680)
19 #define XALANSOURCETREEATTR_HEADER_GUARD_1357924680
20 
21 
22 
24 
25 
26 
28 
29 
30 
32 
33 
34 
35 XALAN_CPP_NAMESPACE_BEGIN
36 
37 
38 
41 
42 
43 
44 /*
45  * <meta name="usage" content="experimental"/>
46  *
47  * Base class for the Xalan source tree Attr interface.
48  *
49  * This class is experimental and subject to change!!
50  */
51 
53 {
54 public:
55 
56  /**
57  * Constructor.
58  *
59  * @param theName The name of the attribute
60  * @param theValue The value of the attribute
61  * @param theOwnerDocument The document that owns the instance
62  * @param theOwnerElement The element that owns the instance
63  * @param theIndex The document-order index of the node.
64  */
66  const XalanDOMString& theName,
67  const XalanDOMString& theValue,
68  XalanSourceTreeElement* theOwnerElement = 0,
69  IndexType theIndex = 0);
70 
71  virtual
73 
74 
75  // These interfaces are inherited from XalanNode...
76  virtual const XalanDOMString&
77  getNodeName() const;
78 
79  virtual const XalanDOMString&
80  getNodeValue() const;
81 
82  virtual NodeType
83  getNodeType() const;
84 
85  virtual XalanNode*
86  getParentNode() const;
87 
88  virtual const XalanNodeList*
89  getChildNodes() const;
90 
91  virtual XalanNode*
92  getFirstChild() const;
93 
94  virtual XalanNode*
95  getLastChild() const;
96 
97  virtual XalanNode*
98  getPreviousSibling() const;
99 
100  virtual XalanNode*
101  getNextSibling() const;
102 
103  virtual const XalanNamedNodeMap*
104  getAttributes() const;
105 
106  virtual XalanDocument*
107  getOwnerDocument() const;
108 
109  virtual const XalanDOMString&
110  getNamespaceURI() const;
111 
112  virtual const XalanDOMString&
113  getPrefix() const;
114 
115  virtual const XalanDOMString&
116  getLocalName() const;
117 
118  virtual bool
119  isIndexed() const;
120 
121  virtual IndexType
122  getIndex() const;
123 
124  // These interfaces are inherited from XalanAttr...
125  virtual const XalanDOMString&
126  getName() const;
127 
128  virtual bool
129  getSpecified() const;
130 
131  virtual const XalanDOMString&
132  getValue() const;
133 
134  virtual XalanElement*
135  getOwnerElement() const;
136 
137  // public interfaces not inherited from XalanAttr...
138 
139  void
141  {
142  m_ownerElement = theElement;
143  }
144 
145  void
146  setIndex(IndexType theIndex)
147  {
148  m_index = theIndex;
149  }
150 
151 private:
152 
153  // Not defined...
154  XalanSourceTreeAttr(const XalanSourceTreeAttr& theSource);
155 
157  operator=(const XalanSourceTreeAttr& theSource);
158 
159  bool
160  operator==(const XalanSourceTreeAttr& theRHS) const;
161 
162 
163  // Data members...
164  const XalanDOMString& m_name;
165 
166  const XalanDOMString& m_value;
167 
168  XalanSourceTreeElement* m_ownerElement;
169 
170  IndexType m_index;
171 };
172 
173 
174 
175 XALAN_CPP_NAMESPACE_END
176 
177 
178 
179 #endif // !defined(XALANSOURCETREEATTR_HEADER_GUARD_1357924680)
virtual bool isIndexed() const =0
Determine if the document is node-order indexed.
virtual const XalanNamedNodeMap * getAttributes() const =0
Gets a XalanNamedNodeMap containing the attributes of this node (if it is an XalanElement) or a null ...
virtual const XalanDOMString & getName() const =0
Returns the name of this attribute.
virtual const XalanDOMString & getNamespaceURI() const =0
Get the namespace URI of this node.
virtual const XalanDOMString & getNodeValue() const =0
Gets the value of this node, depending on its type.
virtual XalanNode * getNextSibling() const =0
Gets the node immediately following this node.
virtual XalanElement * getOwnerElement() const =0
The XalanElement node this attribute is attached to.
virtual XalanNode * getLastChild() const =0
Gets the last child of this node.
virtual const XalanDOMString & getPrefix() const =0
Get the namespace prefix of this node.
virtual const XalanDOMString & getValue() const =0
Returns the value of the attribute.
#define XALAN_XALANSOURCETREE_EXPORT
virtual NodeType getNodeType() const =0
An enum value representing the type of the underlying object.
void setIndex(IndexType theIndex)
virtual IndexType getIndex() const =0
Get the node&#39;s index.
virtual const XalanDOMString & getNodeName() const =0
Gets the name of this node, depending on its type.
void setOwnerElement(XalanSourceTreeElement *theElement)
virtual XalanNode * getParentNode() const =0
Gets the parent of this node.
virtual XalanNode * getFirstChild() const =0
Gets the first child of this node.
virtual const XalanNodeList * getChildNodes() const =0
Gets a XalanNodeList that contains all children of this node.
unsigned long IndexType
Definition: XalanNode.hpp:64
virtual const XalanDOMString & getLocalName() const =0
Returns the local part of the qualified name of this node.
bool operator==(const XalanAttr &theRHS) const
virtual XalanDocument * getOwnerDocument() const =0
Gets the XalanDocument object associated with this node.
virtual XalanNode * getPreviousSibling() const =0
Gets the node immediately preceding this node.
XalanAttr & operator=(const XalanAttr &theSource)

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo