dbxmlGetDocument

Home > Books > Discovered Documentation > Discovered Documentation > BDBXML Library > dbxmlGetDocument

Module

The dbxmlGetDocument accessor is exported by the urn:org:ten60:netkernel:mod:dbxml module. Import this module to gain access to the accessor.

Syntax

URI

active:dbxmlGetDocument

Argument	Rules	Description
operator	Mandatory	the get specification

Example Usage

DPML

<instr>
  <type>dbxmlGetDocument</type>
  <operator>
    <dbxml>
      <name>mydocument</name>
      <container>mycontainer</container>
    </dbxml>
  </operator>
  <target>var:myDocument</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:dbxmlGetDocument");
req.addArgument("operator", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The dbxmlGetDocument accessor gets an XML document from a container in Berkeley DBXML. The get specification is provided as the operator argument and is an XML fragment.

If successful the response is the XML document otherwise an exception is thrown.

Operator Format

The format for the operator is...

<dbxml>
  <name>someDocumentName</name>
  <container>someContainerName</container>
</dbxml>

The name tag is required and will be used to identify the document in the container. The container tag specifies the identity of the container in the BDBXML database in which the document is located.

Reference

Berkeley DBXML can be downloaded from Sleepycat Software.
Javadoc for BDBXML