XPathQueryService


1   package org.xmldb.api.modules;
2   
3   /*
4    *  The XML:DB Initiative Software License, Version 1.0
5    *
6    *
7    * Copyright (c) 2000-2001 The XML:DB Initiative.  All rights
8    * reserved.
9    *
10   * Redistribution and use in source and binary forms, with or without
11   * modification, are permitted provided that the following conditions
12   * are met:
13   *
14   * 1. Redistributions of source code must retain the above copyright
15   *    notice, this list of conditions and the following disclaimer.
16   *
17   * 2. Redistributions in binary form must reproduce the above copyright
18   *    notice, this list of conditions and the following disclaimer in
19   *    the documentation and/or other materials provided with the
20   *    distribution.
21   *
22   * 3. The end-user documentation included with the redistribution,
23   *    if any, must include the following acknowledgment:
24   *       "This product includes software developed by the
25   *        XML:DB Initiative (http://www.xmldb.org/)."
26   *    Alternately, this acknowledgment may appear in the software itself,
27   *    if and wherever such third-party acknowledgments normally appear.
28   *
29   * 4. The name "XML:DB Initiative" must not be used to endorse or
30   *    promote products derived from this software without prior written
31   *    permission. For written permission, please contact info@xmldb.org.
32   *
33   * 5. Products derived from this software may not be called "XML:DB",
34   *    nor may "XML:DB" appear in their name, without prior written
35   *    permission of the XML:DB Initiative.
36   *
37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48   * SUCH DAMAGE.
49   * ====================================================================
50   *
51   * This software consists of voluntary contributions made by many
52   * individuals on behalf of the XML:DB Initiative. For more information
53   * on the XML:DB Initiative, please see <http://www.xmldb.org/>.
54   */
55   
56  import org.xmldb.api.base.*;
57  
58  /**
59   * XPathQueryService is a <code>Service</code> that enables the execution of
60   * XPath queries within the context of a <code>Collection</code>.
61   */
62  public interface XPathQueryService extends Service {
63     /**
64      * Run an XPath query againt the <code>Collection</code>. The result is a 
65      * <code>ResourceIterator</code> containing the results of the query. 
66      *
67      * @param query The XPath query string to use.
68      * @return A ResourceIterator containing the results of the query.
69      * @exception XMLDBException with expected error codes.<br />
70      *  <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
71      *  specific errors that occur.<br />
72      */
73     ResourceIterator query(String   query) throws XMLDBException;
74  }
75  
76
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags