Browser
Document Index:
XSpace Browser (this page)
1. What does the XSpace
Browser do?
The XSpace Browser is a GUI tool that allows you to:
- Create an XSpace
- Delete an XSpace
- Browse the contents of an XSpace
- Add a key/value to an XSpace
- Update the value of an existing key
- Remove a key from an XSpace
- Search for occurrences of a string within an XSpace.
The browser is event-driven; thus it reflects the state of an XSpace in real-time. This means that any changes made by a remote user will be immediately reflected in the XSpace being viewed.
2. How to run the XSpace
Browser
Execute the following commands:
- cd <xspace_home>
- ant runXSpaceBrowser
You will then see the following window:
3. Working with the XSpace
Browser
Creating an XSpace
Click on File->Create XSpace…
A pop-up dialog appears prompting for the XSpace name you wish to create.
Enter a name and click OK.
A new XSpace is created and the root node “/” appears on the left panel.
Adding nodes
Right-click on a node and select “Add”.
A pop-up appears prompting for the path (key) name.
Enter the path name, relative to the root. (e.g. aaa/bbb/ccc) Do not begin your path name with /. Click OK.
The node(s) are created.
Deleting nodes
Right-click on a node and select “Delete”.
The node (and all its descendants are deleted).
Note that you cannot delete the root node.
Assigning a value to
a node
Click on a node.
On the right panel, enter the value (can be strings or XML of any length)
Click on the Update Value button on the bottom right.
The value is then assigned permanently to the selected node.
Here is an example of a value being assigned to a node:
Browsing the tree
Click on any node.
The current value for the node is displayed on the right panel.
If the value is null, the right panel will be blank.
Opening an XSpace.
Click on File->Open XSpace…
A pop-up list appears with the names of available XSpaces.
Select an XSpace and click OK.
The tree for the selected XSpace appears in the left panel.
Deleting an XSpace
Click on File->Delete XSpace…
A pop-up list appears with the names of available XSpaces.
Select an XSpace and click OK.
The XSpace and its entire tree is deleted.
Searching an XSpace
Right click on the node where you want to start the search. Select “Search”.
A pop-up appears prompting for the search string.
Enter the search string and click OK.
If there are matches, the search results window will pop-up.
On the left panel are the keys which matched the search.
Click on a key to view its value.
Below is an example of the Search Results panel.
