View Javadoc

1   package org.apache.torque.criteria;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  /**
22   *
23   * The possible explicit join types.
24   *
25   * @version $Id: JoinType.java 1331333 2012-04-27 10:13:10Z tfischer $
26   */
27  public enum JoinType
28  {
29      /** SQL Expression " LEFT JOIN ". */
30      LEFT_JOIN(" LEFT JOIN "),
31      /** SQL Expression " RIGHT JOIN ". */
32      RIGHT_JOIN(" RIGHT JOIN "),
33      /** SQL Expression " INNER JOIN ". */
34      INNER_JOIN(" INNER JOIN ");
35  
36      /** The SQL expression for the join type. */
37      private String sql;
38  
39      /**
40       * Constructor.
41       *
42       * @param sql The SQL expression for the join type.
43       */
44      private JoinType(String sql)
45      {
46          this.sql = sql;
47      }
48  
49      /**
50       * Returns the SQL expression for the join type.
51       *
52       * @return the SQL expression, not null.
53       */
54      public String toString()
55      {
56          return sql;
57      }
58  
59  }