XObject


1   package org.xmldb.common.xml.queries;
2   /*
3    *  The XML:DB Initiative Software License, Version 1.0
4    *
5    *
6    * Copyright (c) 2000-2003 The XML:DB Initiative.  All rights
7    * reserved.
8    *
9    * Redistribution and use in source and binary forms, with or without
10   * modification, are permitted provided that the following conditions
11   * are met:
12   *
13   * 1. Redistributions of source code must retain the above copyright
14   *    notice, this list of conditions and the following disclaimer.
15   *
16   * 2. Redistributions in binary form must reproduce the above copyright
17   *    notice, this list of conditions and the following disclaimer in
18   *    the documentation and/or other materials provided with the
19   *    distribution.
20   *
21   * 3. The end-user documentation included with the redistribution,
22   *    if any, must include the following acknowledgment:
23   *       "This product includes software developed by the
24   *        XML:DB Initiative (http://www.xmldb.org/)."
25   *    Alternately, this acknowledgment may appear in the software itself,
26   *    if and wherever such third-party acknowledgments normally appear.
27   *
28   * 4. The name "XML:DB Initiative" must not be used to endorse or
29   *    promote products derived from this software without prior written
30   *    permission. For written permission, please contact info@xmldb.org.
31   *
32   * 5. Products derived from this software may not be called "XML:DB",
33   *    nor may "XML:DB" appear in their name, without prior written
34   *    permission of the XML:DB Initiative.
35   *
36   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47   * SUCH DAMAGE.
48   * ====================================================================
49   *
50   * This software consists of voluntary contributions made by many
51   * individuals on behalf of the XML:DB Initiative. For more information
52   * on the XML:DB Initiative, please see <http://www.xmldb.org/>.
53   */
54  import org.w3c.dom.DocumentFragment  ;
55  import org.w3c.dom.NodeList  ;
56  
57  import java.io.Serializable  ;
58  
59  
60  /**
61   * @version $Revision: 1.3 $ $Date: 2003/04/24 14:14:10 $
62   * @author <a HREF="http://www.softwarebuero.de">SMB</a>
63   */
64  public interface XObject extends Serializable   {
65  
66      //
67      // Constants
68      //
69  
70      /** Result is null. */
71      public final static int CLASS_NULL = -1;
72  
73      /** Result type is not known. */
74      public final static int CLASS_UNKNOWN = 0;
75  
76      /** Result type is a boolean. */
77      public final static int CLASS_BOOLEAN = 1;
78  
79      /** Result type is a Integer. */
80      public final static int CLASS_NUMBER = 2;
81  
82      /** Result type is a String. */
83      public final static int CLASS_STRING = 3;
84  
85      /** Result type is a NodeSet. */
86      public final static int CLASS_NODESET = 4;
87  
88      /** Result type is a Document Fragment. */
89      public final static int CLASS_RTREEFRAG = 5;
90  
91  
92      /**
93       */
94      public int getType() throws Exception  ;
95  
96  
97      /**
98       * Cast result object to a boolean.
99       * @return The Object casted to boolean
100      * @exception org.xml.sax.SAXException If any error occurs.
101      */
102     public boolean bool() throws Exception  ;
103 
104 
105     /**
106      * Cast result object to a number.
107      * @return The Object casted to double.
108      * @exception org.xml.sax.SAXException If any error occurs.
109      */
110     public double num() throws Exception  ;
111 
112 
113     /**
114      * Cast result object to a string.
115      * @return The Object casted to string.
116      */
117     public String   str() throws Exception  ;
118 
119 
120     /**
121      * Cast result object to a nodelist.
122      * @return The Object casted to NodeList.
123      * @exception org.xml.sax.SAXException If any error occurs.
124      */
125     public NodeList   nodeset() throws Exception  ;
126 
127 
128     /**
129      * Cast result object to a result tree fragment.
130      * @return The Object casted to DocumentFragment.
131      */
132     public DocumentFragment   rtree() throws Exception  ;
133 
134 }
135
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags