Activity - xUpdateStatement

Activity Type: XML

Description

Run an XUpdate update on an XMLDB data resource. The update can be run upon an individual XMLDB resource contained within a collection in the XMLDB data resource or over an entire collection of XMLDB resources. Please note that 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).

Example

<xUpdateStatement name="statement">
  <collection>musicians/folksingers</collection>
  <resourceId>someResource</resourceId>
  <expression>
    <xu:modifications version="1.0"
      xmlns:xu="http://www.xmldb.org/xupdate">
      <xu:update select="/entry/phone">123123123123</xu:update>
    </xu:modifications>
  </expression>
  <outputStream name="statementOutput"/>
</xUpdateStatement>

Specification

Element xUpdateStatement:

• Attribute name - unique name for the activity within the scope of a request.
• Element collection (zero or one) - contains the name of the collection that the update will be performed within.
  • Relative to the data resource's base collection.
  • For example, if a data resource is configured for the db/littleblackbook collection then the example would perform the update within the db/littleblackbook/musicians/folksingers collection.
  • If this element is omitted then the update will be performed on the base collection for the data resource.
• Element resourceId (zero or one):
  • Contains the name of the XMLDB resource in the selected collection which which the update will be run.
  • If omitted then the update will be run over all the XMLDB resources in the selected collection.
• Element expression (required) - an XUpdate expression.
• outputStream (required) - output stream.
  • Attribute name - name of the activity's output stream.

Input and Output Types

• Output: outputStream — a single block of type java.lang.String of XML data describing the number of modified nodes. The following form is used:

  <modifiedNodes>N</modifiedNodes>
  

  where N is the number of modified nodes.

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/xupdate_statement.xsd

Class

uk.org.ogsadai.activity.xmldb.XUpdateStatementActivity

Client Toolkit Class

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