This view displays the contents of a XML Library Group as a tree.
The view displays the following objects:
XML Library Group : the currently opened group of Libraries.
XML Library : a library belonging to the group
Collection : a Collection inside a Library. May contain other collections.
Document : a well-formed XML document stored and indexed in a Collection.
Each kind of object has an associated right-click menu, which gives access to a number of operations:
XML Library Group right-click menu:
Open Library Group: opens a group of XML Libraries located in a directory. A file chooser appears to select that directory.
In this mode, Qizx Studio has exclusive access to the XML Libraries. If another application or server already has locked the Libraries, an error panel will appear.
This command also allows opening a single XML Library by selecting its root directory: It is a special case where the Library Group has no defined location, and therefore creating other libraries is not possible.
Connect to Server: opens a client connection to a Qizx Server.
This will likely present an authentication dialog asking for a user name and a password (depending on the configuration of the server).
Close Library Group: closes the current group of Libraries. If currently connected to
Passes in a mode where no Library is available. Note that it is still possible to run XQuery expressions, as long as they don't perform queries on a Library. This is equivalent to using Qizx/open.
Create Library Group: creates a group of Libraries in a directory. This directory is first selected by a file chooser. It must be empty or non-existent. The Library Group is created in the directory, then a dialog asks for the name of the first Library to be created inside the group.
Create Library: allows creating more XML Libraries inside the current group.
XML Library right-click menu:
Import Documents: to store XML documents into the selected Library (in the root Collection); see the Import Documents dialog.
Use Library as Query domain: query domain means the default root of a XQuery/XPath path expression. For example, assume that you have a Library containing the plays of Shakespeare (as marked up by Jon Bosak), that you select the Library as the query domain, then the query //SCENE
will return all SCENE
elements in the Library. Note the particular query //SCENE
has no explicit root or start-point. It uses here the default query domain.
This feature is not supported in client-server mode (because it does not make much sense).
Indexing: a sub-menu that deals with indexing specifications.
Indexing Specification: load a new specification written in XML. See details here.
Rebuild all indexes: this operation is normally required after changing the indexing specifications.
Optimize Library: this a compaction operation that can slightly improve the performance of queries on the Library. It is normally performed automatically after a certain number of transactions.
Backup Library: this command makes a backup copy of a Library to an external directory.
Delete Library: this command physically destroys the selected Library.
Refresh: useful in client mode to see the latest state of the Library: another client may have modified it.
Notice there is currently no notification mechanism that would allow an automatic refresh on update of an XML Library.
Collection right-click menu:
Use as Query domain: query domain means the default root of a XQuery/XPath path expression (See here for more details). If a Collection is used as query domain, the query is restricted to all documents contained within the Collection at any level.
Import Documents: command used to store XML documents into the Collection. Invokes the Import Documents dialog.
Create Sub-Collection: asks for the name of a Collection which will be child of the selected collection..
Copy Collection: this command allows copying the selected Collection and all its contents (sub-collections and documents) to another location in the same Library.
Rename Collection: this command allows changing the name or the location of the collection.
Delete Collection: this command destroys the selected Collection and all its contents (sub-collections and documents).
Refresh: useful in client mode to see the latest state of the Collection: another client may have modified it.
Document right-click menu:
Use as Query domain: query domain means the default root of a XQuery/XPath path expression (See here for more details). If a Document is used as query domain, the query is restricted to this particular document. For example if the query domain is the document /coll/doc1.xml
, the query //TITLE
is equivalent to doc("/coll/doc1.xml")//TITLE
.
Export Document: command used to extract the XML contents of the document into a local file. Invokes the Export Document dialog which allows choosing serialization options.
Copy Document: this command allows copying the selected Document to another location in the same Library.
Rename Document: this command allows changing the name or the location of the document.
Delete Document: this command destroys the selected Document.
Refresh: useful in client mode to see the latest state of the document: another client may have modified it.