Resource Management

 Database Explorer View

This view presents in a tree-like fashion the database connections configured in Preferences -> Data Sources. You can connect to a database simply by expanding the connection node. The database structure can be expanded up to column level. <oXygen/> supports multiple simultaneous database connections and the connections tree provides an easy way to browse them.

Some of the basic components employed by the XML:DB API are collections and resources, and they appear in the tree sorted in alphabetical order.

A collection is a hierarchical container for resources and further sub-collections.

There are two types of resources: XML resource and non XML resource . An XML resource represents an xml document or a document fragment, selected by a previously executed XPath query.

 

Figure 13.17. The Database Explorer View

The Database Explorer View

Below you can find a description of the contextual menu actions available on the Database Explorer levels (explained for each connection). Please note that you can open in the editor a resource or a schema component by double-clicking it.

 Oracle XML DB Browser

Oracle XML DB is a feature of the Oracle Database. It provides a high-performance, native XML storage and retrieval technology.

<oXygen/> allows the user to browse the native Oracle XML Repository and perform various operations on the resources in the repository.

 

Figure 13.18. Browsing the Oracle XML DB Repository

Browsing the Oracle XML DB Repository


 Actions available at XML Repository level
  • Refresh - performs a refresh of the XML Repository.

  • Add container - add a new child container to the XML Repository

  • Add resource - adds a new resource to the XML Repository.

 Actions available at container level
  • Refresh - performs a refresh of the selected container.

  • Add container - add a new child container to the current one

  • Add resource - adds a new resource to the folder.

  • Delete - delete the current container.

  • Properties - shows various properties of the current container.

 Actions available at resource level
  • Refresh - performs a refresh of the selected resource.

  • Open - opens the selected resource in the editor.

  • Rename - rename the current resource.

  • Move - move the current resource to a new container.

  • Delete - delete the current resource.

  • Copy location - allows you to copy to clipboard an application specific URL for the resource which can then be used for various actions like opening or transforming the resources.

  • Properties - shows various properties of the current resource.

 Berkeley DB XML Connection
 Actions available at connection level
  • Refresh - performs a refresh of the selected node's subtree.

  • Configure Database Sources - opens the Data Sources preferences page where you can configure both data sources and connections.

  • Add container - allows adding a new container.

     

    Figure 13.19. Add Container Dialog

    Add Container Dialog


    Name

    The name of the new container.

    Container type

    At creation time, every container must have a type defined for it. This container type identifies how XML documents are stored in the container. As such, the container type can only be determined at container creation time; you cannot change it on subsequent container opens.

    Containers can have one of the following types specified for them:

    Node container

    Xml documents are stored as individual nodes in the container. That is, each record in the underlying database contains a single leaf node, its attributes and attribute values if any, and its text nodes, if any. BDB XML also keeps the information it needs to reassemble the document from the individual nodes stored in the underlying databases. This is the default, and preferred, container type.

    Whole document container

    The container contains entire documents; the documents are stored without any manipulation of line breaks or whitespace.

    Allow validation

    If checked it causes documents to be validated when they are loaded into the container. The default behavior is to not validate documents.

    Index nodes

    If checked it causes indices for the container to return nodes rather than documents. The default is to index at the document level. This property has no meaning if the container type is whole document container.

 Actions available at container level
  • Refresh - performs a refresh of the selected node's subtree.

  • Add Resource - adds a new XML resource to the selected container.

  • Rename - allows you to specify a new name for the selected container.

  • Delete - removes the selected container from the database tree.

  • Edit indices - allows you to edit the indices for the selected container.

     

    Figure 13.20. Container indices

    Container indices


    • Specifying the granularity:

      • Document granularity is good for retrieving large documents

      • Node granularity is good for retrieving nodes from within documents

    • Adding/editing indices:

       

      Figure 13.21. Adding/editing indices

      Adding/editing indices


      • Node - the node name

      • Namespace - the index namespace

      • Index strategy:

        • Index type:

          • Uniqueness - indicates whether the indexed value must be unique within the container

          • Path type:

            • node - indicates that you want to index a single node in the path

            • edge - indicates that you want to index the portion of the path where two nodes meet

          • Node type:

            • element - an element node in the document content

            • attribute - an attribute node in the document content

            • metadata - a node found only in a document's metadata content.

          • Key type:

            • equality - improves the performances of tests that look for nodes with a specific value

            • presence - improves the performances of tests that look for the existence of a node regardless of its value

            • substring - improves the performance of tests that look for a node whose value contains a given substring

        • Syntax types - the syntax describes what sort of data the index will contain and is mostly used to determine how indexed values are compared

 Actions available at resource level
  • Refresh - performs a refresh of the selected resource.

  • Open - opens the selected resource in the editor.

  • Rename - allows you to change the name of the selected resource.

  • Move - allows you to move the selected resource in a different container in the database tree.

  • Delete - removes the selected resource from the container.

  • Copy location - allows you to copy to clipboard an application specific URL for the resource which can then be used for various actions like opening or transforming the resources.

 eXist Connection
 Actions available at connection level
  • Refresh - performs a refresh of the selected node's subtree.

  • Configure Database Sources - opens the Data Sources preferences page where you can configure both data sources and connections.

 Actions available at container level
  • Refresh - performs a refresh of the selected node's subtree.

  • Add Resource - adds a new XML resource to the selected container.

  • Add Container - creates a new collection in the selected one.

  • Delete - removes the selected collection.

  • Rename - allows you to change the name of the selected collection.

  • Move - allows you to move the selected collection in a different location in the database tree.

 Actions available at resource level
  • Refresh - performs a refresh of the selected resource.

  • Open - opens the selected resource in the editor.

  • Rename - allows you to change the name of the selected resource.

  • Move - allows you to move the selected resource in a different collection in the database tree.

  • Delete - removes the selected resource from the collection.

  • Copy location - allows you to copy to clipboard an application specific URL for the resource which can then be used for various actions like opening or transforming the resources.

  • Properties - allows the user to view various useful properties associated with the resource.

  • Save As - allows you to save the name of the selected binary resource as a file on disk.

 MarkLogic Connection

Resource management for MarkLogic database ca be done through WebDAV. For this the WebDAV url must be configured in the MarkLogic connection. The actions that can be performed on MarkLogic resources through WebDAV are the same used for a WebDAV connection (see more about this in WebDAV Connection section).

[Note]Note

The interaction with the database is also made using XQuery .

 Software AG Tamino Connection
 Actions available at connection level
  • Refresh - performs a refresh of the selected node's subtree.

  • Configure Database Sources - opens the Data Sources preferences page where you can configure both data sources and connections.

  • Add container - allows you to create a new collection in the database.

 Actions available at collection level

For every new Tamino collection, you can specify if a schema is required, optional or prohibited. The following actions are available:

  • Refresh - performs a refresh of the selected node's subtree.

  • Filter ... - An XQuery expression can be specified for filtering the nodes displayed in the selected Tamino container. It is only possible to specify one predicate. In the XQuery syntax a predicate is enclosed in square brackets. The square brackets, however, must not be specified in the dialog box displayed by this action. Only the predicate must be specified and it will be applied on the selected doctype. For example:

    name/surname between 'B', 'C'
  • Insert XML instance - allows you to load a new XML document.

  • Insert non XML instance - allows you to load a non XML document.

  • Modify Collection Properties - allows you to change the schema usage for the selected collection to optional. This action is available on collections with required and prohibited schema usage.

  • Define schema - allows you to add a new schema in the Schema Repository. This action is available on collections with optional and required schema usage.

  • Delete - removes the selected collection. If it is a Tamino doctype then the action removes all the XML instances contained in the doctype.

  • Set default - Sets this collection as the default collection for running queries with the input() function.

 Actions available at schema level
  • Refresh - performs a refresh of the selected schema.

  • Open - opens the selected schema in the editor. There are supported schema changes that preserve the validity relative to the existent instances.

  • Delete - removes the selected schema from the Schema Repository.

 Actions available at resource level
  • Refresh - performs a refresh of the selected resource.

  • Open - opens the selected resource in the editor.

  • Rename - allows you to change the name of the selected resource.

  • Delete - removes the selected resource.

  • Copy location - allows you to copy to clipboard an application specific URL for the resource which can then be used for various actions like opening or transforming the resources.

  • Properties - allows the user to view various useful properties associated with the resource.

  • Save As - allows you to save the name of the selected binary resource as a file on disk.

Validation of an XML resource stored in a Tamino database is done against the schema associated with the resource in the database.

[Note]Note

<oXygen/> also displays the contents of the WebDAV enabled collection ino:dav. The actions that can be performed on Tamino resources through WebDAV are the same used for a WebDAV connection (see more about this in WebDAV Connection section).

 Raining Data TigerLogic Connection
[Note]Note

Resource management is unavailable (no browsing support is offered). The interaction with the database is made using XQuery .

 X-Hive/DB Connection
 Actions available at connection level
  • Refresh - performs a refresh of the selected node's subtree.

  • Configure Database Sources - opens the Data Sources preferences page where you can configure both data sources and connections.

  • Add library - allows you to add a new library.

  • Insert XML Instance - allows you to add a new xml resource directly into the database root. See X-Hive Parser Configuration for more details.

  • Insert non XML Instance - allows you to add a new non xml resource directly into the database root.

  • Properties - displays the connection properties.

 Actions available at catalog level
  • Refresh - performs a refresh of the selected catalog.

  • Add AS models - allows you to add a new abstract schema model to the selected catalog.

  • Set default schema - allows you to set a default DTD to be used for parsing. It is not possible to set a default XML Schema.

  • Clear default schema - allows you to clear the default DTD. The action is available only if there is a DTD set as default.

  • Properties - displays the catalog properties.

 Actions available at schema resource level
  • Refresh - performs a refresh of the selected schema resource.

  • Open - opens the selected schema resource in the editor.

  • Rename - allows you to change the name of the selected schema resource.

  • Save As - allows you to save the selected schema resource as a file on disk.

  • Delete - removes the selected schema resource from the catalog

  • Copy location - allows you to copy to clipboard the URL of the selected schema resource.

  • Set default schema - allows you to set the selected DTD to be used as default for parsing. The action is available only for DTD.

  • Clear default schema - allows you to unset the selected DTD. The action is available only if the selected DTD is the current default to be used for parsing.

 Actions available at library level
  • Refresh - performs a refresh of the selected library.

  • Add library - adds a new library as child of the selected library.

  • Add local catalog - adds a catalog to the selected library. By default, only the root-library has a catalog, and all models would be stored there.

  • Insert XML Instance - allows you to add a new xml resource to the selected library. See X-Hive Parser Configuration for more details.

  • Insert non XML Instance - allows you to add a new non xml resource to the selected library.

  • Rename - allows you to specify a new name for the selected library.

  • Move - allows you to move the selected library to a different one.

  • Delete - removes the selected library.

  • Properties - displays the library properties.

 Actions available at resource level
  • Refresh - performs a refresh of the selected resource.

  • Open - opens the selected resource in the editor.

  • Rename - allows you to change the name of the selected resource.

  • Move - allows you to move the selected resource in a different library in the database tree.

  • Save As - allows you to save the selected binary resource as a file on disk.

  • Delete - removes the selected resource from the library.

  • Copy location - allows you to copy to clipboard the URL of the selected resource.

  • Add AS model - allows you to add an XML schema to the selected XML resource.

  • Set AS model - allows you to set an active AS model for the selected XML resource.

  • Clear AS model - allows you to clear the active AS model of the selected XML resource.

  • Properties - displays the resource properties. Available only for XML resources.

Validation of an XML resource stored in an X-Hive database is done against the schema associated with the resource in the database.

 X-Hive parser configuration for adding XML instances
 

Figure 13.22. Parser configuration

Parser configuration

  • DOM Level 3 parser configuration parameters. More about each parameter can be found here: DOM Level 3 Configuration

  • X-Hive specific parser parameters (for more information please consult the X-Hive manual):

    • xhive-store-schema - During validated parsing, the corresponding DTD's or XML schemas are or are not stored in the catalog.

    • xhive-store-schema-only-internal-subset - Store only the internal subset of the document (not any external subset). Modifier for xhive-store-schema (only has a function when that parameter is set to true, and when DTDs are involved). Use this option if you only want to store the internal subset of the document (not the external subset).

    • xhive-ignore-catalog - During validated parsing, the corresponding DTD's and XML schemas in the catalog are ignored.

    • xhive-psvi - Store psvi information on elements and attributes. Documents parsed with this feature turned on, give access to psvi information and enable support of data types by XQuery queries.

    • xhive-sync-features - Convenience setting. With this setting turned on, parameter settings of XhiveDocumentIf are synchronized with the parameter settings of LSParser. Note that parameter settings "xhive-psvi" and "schema-location" are always synchronized.