TML Messaging Suite  1.1.5
for Java
 All Classes Namespaces Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | List of all members
com.tmlsidex.sidex.SDXDocument Class Reference

SIDEX document. More...

Inheritance diagram for com.tmlsidex.sidex.SDXDocument:

Public Member Functions

 SDXDocument (String name) throws TmlSidexException
 constructs new SDXDocument More...
 
 SDXDocument (long sHandle, boolean thisown) throws TmlSidexException
 constructs a new instance to access an existing low level handle More...
 
long getShandle ()
 get low level handle More...
 
void clear ()
 delete all values More...
 
String getContent () throws TmlSidexException
 get content as string (XML) More...
 
void setContent (String content) throws TmlSidexException
 set content as string (XML) More...
 
String getDocumentName () throws TmlSidexException
 get document name More...
 
void setDocumentName (String name) throws TmlSidexException
 set document name More...
 
void loadFromFile (String path) throws TmlSidexException
 load content from a file More...
 
void saveToFile (String path) throws TmlSidexException
 save content to a file More...
 
SDXBase getValue (String group, String key) throws TmlSidexException
 read value More...
 
void setValue (String group, String key) throws TmlSidexException
 set SDXNone value More...
 
void setValue (String group, String key, Object sVal) throws TmlSidexException
 write value More...
 
boolean hasGroup (String group)
 check if group exists More...
 
String[] getGroups () throws TmlSidexException
 get a list of group names More...
 
boolean hasKey (String group, String key)
 check if a key exists More...
 
String[] getKeys (String group) throws TmlSidexException
 get a list of key names for a group More...
 
void deleteGroup (String group) throws TmlSidexException
 delete a group from the document More...
 
void deleteKey (String group, String key) throws TmlSidexException
 delete key/value pair from the document More...
 

Protected Member Functions

void finalize () throws Throwable
 destructor More...
 

Detailed Description

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.