View Javadoc

1   package org.apache.torque.util;
2   
3   /* ====================================================================
4    * The Apache Software License, Version 1.1
5    *
6    * Copyright (c) 2001 The Apache Software Foundation.  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   *        Apache Software Foundation (http://www.apache.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 names "Apache" and "Apache Software Foundation" and
29   *    "Apache Turbine" must not be used to endorse or promote products
30   *    derived from this software without prior written permission. For
31   *    written permission, please contact apache@apache.org.
32   *
33   * 5. Products derived from this software may not be called "Apache",
34   *    "Apache Turbine", nor may "Apache" appear in their name, without
35   *    prior written permission of the Apache Software Foundation.
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 Apache Software Foundation.  For more
53   * information on the Apache Software Foundation, please see
54   * <http://www.apache.org/>.
55   */
56  
57  
58  /***
59   * A typesafe enum of SQL string fragments.  Used by Criteria and SqlExpression
60   * to build queries.  Criteria also makes most of the constants available
61   * in order to specify a criterion.
62   *
63   * @author <a href="mailto:jmcnally@collab,net"></a>
64   * @version $Id: SqlEnum.java,v 1.1 2004/10/22 17:34:13 tassos Exp $
65   * @since 3.0
66   */
67  class SqlEnum implements java.io.Serializable
68  {
69      private final String s;
70      
71      private SqlEnum(String s) 
72      { 
73          this.s = s;
74      }
75  
76      public final String toString()  
77      { 
78          return s;
79      }
80      
81      public static final SqlEnum EQUAL = 
82          new SqlEnum("=");
83      public static final SqlEnum NOT_EQUAL = 
84              new SqlEnum("<>");
85      public static final SqlEnum ALT_NOT_EQUAL = 
86          new SqlEnum("!=");
87      public static final SqlEnum GREATER_THAN =
88          new SqlEnum(">");
89      public static final SqlEnum LESS_THAN =
90          new SqlEnum("<");
91      public static final SqlEnum GREATER_EQUAL =
92          new SqlEnum(">=");
93      public static final SqlEnum LESS_EQUAL =
94          new SqlEnum("<=");  
95      public static final SqlEnum LIKE =
96          new SqlEnum(" LIKE ");
97      public static final SqlEnum ILIKE =
98          new SqlEnum(" ILIKE ");
99      public static final SqlEnum NOT_LIKE =
100         new SqlEnum(" NOT LIKE ");
101     public static final SqlEnum IN =
102         new SqlEnum(" IN ");
103     public static final SqlEnum NOT_IN =
104         new SqlEnum(" NOT IN ");
105     public static final SqlEnum CUSTOM =
106         new SqlEnum("CUSTOM");
107     public static final SqlEnum JOIN =
108         new SqlEnum("JOIN");
109     public static final SqlEnum DISTINCT =
110         new SqlEnum("DISTINCT ");
111     public static final SqlEnum ALL =
112         new SqlEnum("ALL ");
113     public static final SqlEnum ASC =
114         new SqlEnum("ASC");
115     public static final SqlEnum DESC =
116         new SqlEnum("DESC");
117     public static final SqlEnum ISNULL =
118         new SqlEnum(" IS NULL ");
119     public static final SqlEnum ISNOTNULL =
120         new SqlEnum(" IS NOT NULL ");
121     public static final SqlEnum CURRENT_DATE =
122         new SqlEnum("CURRENT_DATE");
123     public static final SqlEnum CURRENT_TIME =
124         new SqlEnum("CURRENT_TIME");
125 }