1 package org.apache.torque.sql.objectbuilder;
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 import org.apache.torque.TorqueException;
23 import org.apache.torque.adapter.Adapter;
24 import org.apache.torque.criteria.PreparedStatementPart;
25
26 /**
27 * Builds a PreparedStatementPart from a single object
28 * (e.g. a column or a SQL value).
29 *
30 * @version $Id: ObjectPsPartBuilder.java 1355228 2012-06-29 03:38:08Z tfischer $
31 */
32 public interface ObjectPsPartBuilder
33 {
34 /**
35 * Builds a PreparedStatementPart from a single Object.
36 *
37 * @param toBuildFrom the object to build the psPart from.
38 * @param ignoreCase If true and columns represent Strings, the appropriate
39 * function defined for the database will be used to ignore
40 * differences in case.
41 * @param adapter The adapter for the database for which the SQL
42 * should be created, not null.
43 *
44 * @return the PreparedStatementPart for the object.
45 *
46 * @throws TorqueException when rendering fails.
47 */
48 PreparedStatementPart buildPs(
49 Object toBuildFrom,
50 boolean ignoreCase,
51 Adapter adapter)
52 throws TorqueException;
53 }