Activity - xmlBulkLoad

Activity Type: XML

Description

Bulk load a set of XMLDB resources into a collection. XMLDB resources are XML documents which are stored within XMLDB collections (not to be confused with an XMLDB data resource itself or data service resources). The XMLDB resources can be provided by a client or produced via another activity.

Example

<xmlBulkLoad name="bulk">
  <collection createIfNotExists="true">
    newCollection
  </collection>
  <resourceSet>
    <resource>
      <resource1>Some Content</resource1>
    </resource>
    <resource>
      <resource2>Some Content</resource2>
    </resource>
  </resourceSet>
  <output name="outputStream"/>
</xmlBulkLoad>

<xmlBulkLoad name="bulk">
  <collection createIfNotExists="true">
    newCollection
  </collection>
  <fromLocal from="dataToInsert"/>
  <output name="outputStream"/>
</xmlBulkLoad>

Specification

Element xmlBulkLoad:

• Attribute name - unique name for the activity within the scope of a request.
• Element collection (optional) - name of the collection into which the XMLDB resources are to be inserted. If ommited the XMLDB resources will be loaded into the data collection for the data resource.
  • Attribute createIfNotExists - boolean value indicating whether the collection is to be created if it does not exist.
• One of:
  • Element fromLocal - stream from which the XMLDB resources to be bulk-loaded originates.
    • Attribute from - name of an input stream providing XMLDB resources.
  • Element resourceSet - the XMLDB resources to be loaded:
    • Element resource (1 or more) - an XMLDB resource to be loaded. This element can contain arbitrary XML.
• output (required) - output stream, which will output the number of inserted XMLDB resources.
  • Attribute name - name of the activity's output stream.

Input and Output Types

• Input: fromLocal — sequence of java.lang.String blocks of XML data specifing a set of resources. The first block must be a resource set header in the following format:

  <resourceSet>
  

  The final block must be a resource set footer in the following format:

  </resourceSet>
  

  These header and footer blocks must contain no other data. They must be terminated by the '\n' character and must contain no other whitespace.

  The data blocks between the header and footer blocks must contain the XML of the resources to be added. Each block must contain a single resource and each resource must be within a single block. The single root element of each XML block must be called resource. This root element will be stripped off when the resource is added to the collection. An example of a data block is:

  <resource>
    <entry id="1">
      <name>Ally Antonioletti</name>
      <address>826 Hume Crescent, Southampton</address>
      <phone>01670061244</phone>
    </entry>
  </resource>
  

• Output: output — a single block of type java.lang.String of XML data describing the number of resources created. The following form is used:

  <resultCount>N</resultCount>
  

  where N is the number of resources inserted.

Data Resource Accessor

This activity requires a data resource accessor that implements the following interface: uk.org.ogsadai.dataresource.XMLDBCollectionProvider

Required Libraries

The use of this activity requires the following jar to be loaded on the server:

• xmldb.jar (from eXist build 20051203) — handles access to XML database

XML Schema

OGSA-DAI/schema/ogsadai/xsd/activities/xml_bulk_load.xsd

Class

uk.org.ogsadai.activity.xmldb.XMLBulkLoadActivity

Client Toolkit Class

uk.org.ogsadai.client.toolkit.activity.xmldb.XMLBulkLoad