XML:DB Home

Index
Requirements
Working Draft
API Use Cases

Mail List
Mail Archive
Authors
Members of the XML:DB API Mailing List - xapi-dev@xmldb.org
Kimbro Staken (Editor) - kstaken@dbxmlgroup.com
Status
Working Draft (Experimental) - 2001-03-16
Notice
This is a XML:DB Working Draft for review by all interested parties. It is a draft document and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Working Drafts as reference material or to cite them as other than "work in progress". This work is part of the XML:DB Project. Comments on this specification should be sent to XML:DB API mailing list xapi-dev@xmldb.org.
Abstract
This document defines a draft specification for the XML Database API. This API is being developed through the mailing lists of the XML:DB organization and the contents are attributed to the members of those lists.

Table of Contents


1 XPathQueryService Module
    1.1 XPathQueryService
        1.1.1 IDL Specification
        1.1.2 Methods

Appendices



XPathQueryService Module

XPathQueryService provides a service to query a collection using XPath expressions. The query is applied across all documents in the collection and a ResourceIterator is returned containing the results.

XPathQueryService

IDL Specification


 interface XPathQueryService : base::Service {
   const string serviceName = "XPathQueryService";
   const string version = "1.0";
   base::ResourceIterator query( in string query );
};
            

Methods

query

Executes an XPath query within the context of a Collection.

NoteIt isn't clear if a query execution should return a whole document or just the matched nodes. I can see cases where either may be necessary

Parameters

query The XPath string to execute.


Return Value

A ResourceIterator containing the results of the query evaluation. If no match is found and empty ResourceIterator is returned.


Exceptions

To be defined






Copyright © 2000,2001 The XML:DB Initiative. All Rights Reserved.