View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2000-2001,2003 (C) Exoffice Technologies Inc. All Rights Reserved.
42   */
43  
44  package org.exolab.jms.selector.parser;
45  
46  import antlr.CommonAST;
47  import antlr.CommonToken;
48  import antlr.Token;
49  import org.exolab.jms.selector.Context;
50  import org.exolab.jms.selector.Type;
51  
52  
53  /***
54   * Selector AST node. This adds expression type and context information used
55   * by the tree parser to validate expressions.
56   *
57   * @version     $Revision: 1.1 $ $Date: 2004/11/26 01:50:45 $
58   * @author      <a href="mailto:tima@intalio.com">Tim Anderson</a>
59   * @see         Context
60   * @see         SelectorParser
61   * @see         SelectorTreeParser
62   * @see         Type
63   */
64  public class SelectorAST extends CommonAST {
65  
66      /***
67       * The return type
68       */
69      private Type _type;
70  
71      /***
72       * The context of the node
73       */
74      private Context _context;
75  
76  
77      /***
78       * Construct a new <code>SelectorAST</code>
79       */
80      public SelectorAST() {
81          _type = Type.UNDEFINED;
82      }
83  
84      /***
85       * Initialise this with a token
86       *
87       * @param token the token
88       */
89      public void initialize(final Token token) {
90          super.initialize(token);
91          _context = new Context(((CommonToken) token).getLine(),
92              ((CommonToken) token).getColumn());
93      }
94  
95      /***
96       * Sets the return type of the expression
97       *
98       * @param type the return type
99       */
100     public void setReturnType(final Type type) {
101         _type = type;
102     }
103 
104     /***
105      * Returns the return type of the expression
106      *
107      * @return the return type of the expression
108      */
109     public Type getReturnType() {
110         return _type;
111     }
112 
113     /***
114      * Returns the context of the expression
115      *
116      * @return the context of the expression
117      */
118     public Context getContext() {
119         return _context;
120     }
121 
122 } //-- SelectorAST