1   /*
2    * Copyright 2003 - 2013 The eFaps Team
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   * Revision:        $Rev$
17   * Last Changed:    $Date$
18   * Last Changed By: $Author$
19   */
20  
21  
22  package org.efaps.db.search;
23  
24  import org.efaps.db.AbstractObjectQuery;
25  import org.efaps.db.wrapper.SQLSelect;
26  import org.efaps.util.EFapsException;
27  
28  /**
29   * Part of a statement.
30   *
31   * @author The eFaps Team
32   * @version $Id$
33   */
34  public abstract class AbstractQPart
35  {
36  
37      /**
38       * Method adds the sql statement parts to the given StringBuilder.
39       *
40       * @param _sql StringBuilder to append to
41       * @return this AbstractPart
42       * @throws EFapsException on any error
43       */
44      public abstract AbstractQPart appendSQL(final SQLSelect _sql)
45          throws EFapsException;
46  
47      /**
48       * Method is executed to prepare the different parts for execution
49       * of the sql statement.
50       * @param _query    query the part belong to
51       * @param _part     Part this part is nested in
52       * @return this AbstractPart
53       * @throws EFapsException on any error
54       */
55      public abstract AbstractQPart prepare(final AbstractObjectQuery<?> _query,
56                                            final AbstractQPart _part)
57          throws EFapsException;
58  }