blob: 757ba2113a75e04e4a3bf46aa665de31bbcfb874 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/* $Rev$ $Date$ */
#ifndef _XMLDOCUMENT_H_
#define _XMLDOCUMENT_H_
#include "commonj/sdo/export.h"
#include "commonj/sdo/DataObject.h"
namespace commonj
{
namespace sdo
{
/** XMLDocument - place for holding a graph
*
* The XMLDocument class provides a place to hold a loaded
* graph of data. The root element name is maintained here so that
* the graph can be serialized to the same name later.
*/
class XMLDocument : public RefCountingObject
{
public:
SDO_API virtual ~XMLDocument();
/** getRootDataObject- return the topmost data object
*
* When XML data is loaded, there is one base element which becomes
* the root data object. As this data object is not a property of any
* other data object, it has no name
* The XMLDocument stores the name which was in the XML file.
* This root data object has a URI and a Name only within this
* XMLDocument
*/
SDO_API virtual DataObjectPtr getRootDataObject() const = 0;
/** getRootElementName- return the topmost data objects name
*
* When XML data is loaded, there is one base element which becomes
* the root data object. As this data object is not a property of any
* other data object, it has no name
* The XMLDocument stores the name/uri which was in the XML file.
*/
SDO_API virtual const char* getRootElementURI() const = 0;
/** getRootElementURI- return the topmost data objects uri
*
* When XML data is loaded, there is one base element which becomes
* the root data object. As this data object is not a property of any
* other data object, it has no name
* The XMLDocument stores the name/uri which was in the XML file.
*/
SDO_API virtual const char* getRootElementName() const = 0;
/** getEncoding- return the encoding for this document
*
* NOT IMPLEMENTED
* This returns the encoding specified in the original XML.
*/
SDO_API virtual const char* getEncoding() const = 0;
/** setEncoding- set the encoding to save this document
*
* This sets the encoding to save this data to XML.
*/
SDO_API virtual void setEncoding(const char* encoding) = 0;
SDO_API virtual void setEncoding(const SDOString& encoding) = 0;
/** getXMLDeclaration
*
* NOT IMPLEMENTED
*/
SDO_API virtual bool getXMLDeclaration() const = 0;
/** setXMLDeclaration
*
* Sets the XMLDeclaration
*/
SDO_API virtual void setXMLDeclaration(bool xmlDeclaration) = 0;
/** getXMLVersion- return the xml version for this document
*
* NOT IMPLEMENTED
*/
SDO_API virtual const char* getXMLVersion() const = 0;
/** setXMLVersion- sets the version for this document
*
* NOT IMPLEMENTED
*/
SDO_API virtual void setXMLVersion(const char* xmlVersion) = 0;
SDO_API virtual void setXMLVersion(const SDOString& xmlVersion) = 0;
/** getSchemaLocation- return the schema location
*
* NOT IMPLEMENTED
*/
SDO_API virtual const char* getSchemaLocation() const = 0;
/** setSchemaLocation
*
* Sets the XML Schema location.
*/
SDO_API virtual void setSchemaLocation(const char* schemaLocation) = 0;
SDO_API virtual void setSchemaLocation(const SDOString& schemaLocation) = 0;
/** getNoNamespaceSchemaLocation
*
* NOT IMPLEMENTED
*/
SDO_API virtual const char* getNoNamespaceSchemaLocation() const = 0;
/** setNoNamespaceSchemaLocation
*
* Sets the nonamespace schema location
*/
SDO_API virtual void setNoNamespaceSchemaLocation(const char* noNamespaceSchemaLocation) = 0;
SDO_API virtual void setNoNamespaceSchemaLocation(const SDOString& noNamespaceSchemaLocation) = 0;
SDO_API friend std::istream& operator>>(std::istream& input, XMLDocument& doc);
};
} // End - namespace sdo
} // End - namespace commonj
#endif //_XMLDOCUMENT_H_
|
