KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > netui > databinding > datagrid > runtime > sql > SQLSupportConfig


1 /*
2  * Copyright 2004 The Apache Software Foundation.
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  * $Header:$
17  */
18 package org.apache.beehive.netui.databinding.datagrid.runtime.sql;
19
20 /**
21  * <p>
22  * Configuration JavaBean used in conjunction with the {@link SQLSupport} class to configure
23  * the way in which SQL statements are created. This abstract class can be implemented by
24  * subclasses to provide varying ways of configuring these properties.
25  * </p>
26  */
27 public abstract class SQLSupportConfig {
28
29     /**
30      * Set the quote character used to quote strings types when embedded inside of SQL statements.
31      * @param quoteChar the quote character
32      */
33     public abstract void setQuoteChar(String JavaDoc quoteChar);
34
35     /**
36      * Get the quote character used to wrap string types inside of SQL statements.
37      * @return the quote character
38      */
39     public abstract String JavaDoc getQuoteChar();
40
41     /**
42      * Set a boolean that enables or disables generating an ESCAPE clause when generating a
43      * LIKE clause into a SQL WHERE filter.
44      * @param supportsLikeEscapeClause boolean to support escaping a LIKE clause
45      */
46     public abstract void setSupportsLikeEscapeClause(boolean supportsLikeEscapeClause);
47
48     /**
49      * Get a boolean that enables or disables an ESCAPE clause when generating a
50      * LIKE clause in a SQL statement.
51      * @return <code>true</code> if escaping is enabled; <code>false</code> otherwise.
52      */
53     public abstract boolean getSupportsLikeEscapeClause();
54 }
55
Popular Tags