Repository navigation
Expand file tree
/
Copy pathSDXDocument.java
More file actions
388 lines (352 loc) · 10.2 KB
/
Copy pathSDXDocument.java
File metadata and controls
388 lines (352 loc) · 10.2 KB
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
/*
* libTML: A BEEP based Messaging Suite
* Copyright (C) 2015 wobe-systems GmbH
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307 USA
*
* You may find a copy of the license under this software is released
* at COPYING file. This is LGPL software: you are welcome to develop
* proprietary applications using this library without any royalty or
* fee but returning back any change, improvement or addition in the
* form of source code, project image, documentation patches, etc.
*
* Homepage:
* http://www.libtml.org
*
* For professional support contact us:
*
* wobe-systems GmbH
*/
package com.tmlsidex.sidex;
import java.util.Dictionary;
import java.util.Enumeration;
import com.tmlsidex.jni.Sidex;
import com.tmlsidex.jni.SidexErr;
import com.tmlsidex.jni.SidexType;
import com.tmlsidex.jni.TmlSidexException;
/**
* @ingroup sdxClasses
* @brief SIDEX document
*
* The SIDEX document manages a group/key based data container.
* Datatypes are handled automatically by the document class and
* the variant data objects to ensure the type is saved together with the data.
*/
public class SDXDocument extends Object{
// Member
long m_var = 0;
Sidex m_sidex = null;
boolean m_bThisOwn = false;
/**
* @brief constructs new SDXDocument
*
* @param name name of the document
*
* @throws TmlSidexException
*/
public SDXDocument(String name) throws TmlSidexException{
m_sidex = new Sidex();
m_bThisOwn = true;
m_var = m_sidex.sidex_Create(name);
}
/**
* @brief constructs a new instance to access an existing low level handle
*
* @param sHandle SIDEX handle value
* @param thisown instance is owner of SIDEX variant handle
*
* @throws TmlSidexException
*/
public SDXDocument(long sHandle, boolean thisown) throws TmlSidexException{
m_sidex = new Sidex();
m_bThisOwn = thisown;
m_var = sHandle;
}
/**
* @brief destructor
*/
protected void finalize() throws Throwable {
// Internal destructrion:
if (m_bThisOwn && 0 != m_var){
m_sidex.sidex_Free(m_var);
}
m_var = 0;
m_sidex = null;
// Super destructrion
super.finalize();
}
/**
* @brief get low level handle
*
* @return SIDEX handle
*/
public long getShandle(){
return m_var;
}
/**
* @brief delete all values
*/
public void clear(){
m_sidex.sidex_Clear(m_var);
}
/**
* @brief get content as string (XML)
*
* @return SIDEX XML String
*
* @throws TmlSidexException
*/
public String getContent() throws TmlSidexException{
String sRet = m_sidex.sidex_Get_Content(m_var);
return sRet;
}
/**
* @brief set content as string (XML)
*
* @param content SIDEX XML String
*
* @throws TmlSidexException
*/
public void setContent(String content) throws TmlSidexException{
m_sidex.sidex_Set_Content(m_var, content);
}
/**
* @brief get document name
*
* @return Document name
*
* @throws TmlSidexException
*/
public String getDocumentName() throws TmlSidexException{
String sRet = m_sidex.sidex_Get_DocumentName(m_var);
return sRet;
}
/**
* @brief set document name
*
* @param name document name
*
* @throws TmlSidexException
*/
public void setDocumentName(String name) throws TmlSidexException{
m_sidex.sidex_Set_DocumentName(m_var, name);
}
/**
* @brief load content from a file
*
* @param path filename and path
*
* @throws TmlSidexException
*/
public void loadFromFile(String path) throws TmlSidexException{
m_sidex.sidex_Load_Content(m_var, path);
}
/**
* @brief save content to a file
*
* @param path filename and path
*
* @throws TmlSidexException
*/
public void saveToFile(String path) throws TmlSidexException{
m_sidex.sidex_Save_Content(m_var, path);
}
/**
* @brief read value
*
* @param group group name
* @param key key name
*
* @return SDXBase driven data object
*
* @throws TmlSidexException
*/
public SDXBase getValue(String group, String key) throws TmlSidexException{
SDXBase retValue = null;
long variant = m_sidex.sidex_Variant_Read(m_var, group, key);
retValue = SDXUtils.sidexVariantAsJavaObject(m_sidex, variant);
return retValue;
}
/**
* @brief set SDXNone value
*
* @param group group name
* @param key key name
*
* @throws TmlSidexException
*/
public void setValue(String group, String key) throws TmlSidexException{
long variant = m_sidex.sidex_Variant_New_None();
m_sidex.sidex_Variant_Write(m_var, group, key, variant);
m_sidex.sidex_Variant_DecRef(variant);
}
/**
* @brief write value
*
* @param group group name
* @param key key name
* @param sVal the Object data to write of type
* integer, long, float, double, boolean, Integer, Long, Float, Double, Boolean, String or SDXBase
*
* @throws TmlSidexException
*/
public void setValue(String group, String key, Object sVal) throws TmlSidexException{
long variant = SDXUtils.javaObjectAsSidexVariant(m_sidex, sVal);
m_sidex.sidex_Variant_Write(m_var, group, key, variant);
m_sidex.sidex_Variant_DecRef(variant);
}
/**
* @brief check if group exists
*
* @param group name of the request
*
* @return True if the group exists
*/
public boolean hasGroup(String group){
return m_sidex.sidex_HasGroup(m_var, group);
}
/**
* @brief get a list of group names
*
* @return String array of group names
*
* @throws TmlSidexException
*/
public String[] getGroups() throws TmlSidexException{
long groups = m_sidex.sidex_GetGroups(m_var);
int length = m_sidex.sidex_Variant_List_Size (groups);
String[] strRet = new String[length];
for (int i = 0; i < length; ++i){
long variant = m_sidex.sidex_Variant_List_Get (groups, i);
String sGroup = m_sidex.sidex_Variant_As_String (variant);
strRet[i] = sGroup;
}
m_sidex.sidex_Variant_DecRef(groups);
return strRet;
}
/**
* @brief check if a key exists
*
* @param group name of the request
* @param key name of the request
*
* @return True if the key exists
*/
public boolean hasKey(String group, String key){
return m_sidex.sidex_HasKey(m_var, group, key);
}
/**
* @brief get a list of key names for a group
*
* @param group name of the request
*
* @return String array of key names
*
* @throws TmlSidexException
*/
public String[] getKeys(String group) throws TmlSidexException{
long keys = m_sidex.sidex_GetKeys(m_var, group);
int length = m_sidex.sidex_Variant_List_Size (keys);
String[] strRet = new String[length];
for (int i = 0; i < length; ++i){
long key = m_sidex.sidex_Variant_List_Get (keys, i);
String sKey = m_sidex.sidex_Variant_As_String (key);
strRet[i] = sKey;
}
m_sidex.sidex_Variant_DecRef(keys);
return strRet;
}
/**
* @brief delete a group from the document
*
* @param group group name
*
* @throws TmlSidexException
*/
public void deleteGroup(String group) throws TmlSidexException{
m_sidex.sidex_DeleteGroup(m_var, group);
}
/**
* @brief delete key/value pair from the document
*
* @param group group name
* @param key key name
*
* @throws TmlSidexException
*/
public void deleteKey(String group, String key) throws TmlSidexException{
m_sidex.sidex_DeleteKey(m_var, group, key);
}
/**
* @brief write a group of values
*
* @param group group name
* @param dict dictionary with string keys and values
*
* @throws TmlSidexException
*/
// maybe for later use:
private void setGroup(String group, Dictionary<String, Object> dict) throws TmlSidexException{
Enumeration<String> keys = dict.keys();
if (this.hasGroup(group)){
this.deleteGroup(group);
}
while (keys.hasMoreElements()){
Object keyObj = keys.nextElement();
Object valObj = dict.get(keyObj);
if (valObj instanceof SDXBase){
long variant = 0;
variant = ((SDXBase)valObj).getVhandle();
m_sidex.sidex_Variant_Write(m_var, group, (String)keyObj, variant);
}
else{
if (valObj instanceof Integer){
m_sidex.sidex_Integer_Write(m_var, group, (String)keyObj, ((Integer)valObj).longValue());
}
else{
if (valObj instanceof Long){
m_sidex.sidex_Integer_Write(m_var, group, (String)keyObj, ((Long)valObj).longValue());
}
else{
if (valObj instanceof Float){
m_sidex.sidex_Float_Write(m_var, group, (String)keyObj, ((Float)valObj).doubleValue());
}
else{
if (valObj instanceof Double){
m_sidex.sidex_Float_Write(m_var, group, (String)keyObj, ((Double)valObj).doubleValue());
}
else{
if (valObj instanceof Boolean){
m_sidex.sidex_Boolean_Write(m_var, group, (String)keyObj, ((Boolean)valObj).booleanValue());
}
else{
if (valObj instanceof String){
m_sidex.sidex_String_Write(m_var, group, (String)keyObj, (String)valObj);
}
else{
TmlSidexException e = new TmlSidexException("SDXDocument::writeGroup / unsupported value type", SidexErr.SIDEX_ERR_WRONG_PARAMETER);
throw e;
}
}
}
}
}
}
}
}
}
}