SpecialDBOperation


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  
24  package com.sun.jdo.api.persistence.support;
25  
26  import java.util.List  ;
27  import java.sql.PreparedStatement  ;
28  import java.sql.SQLException  ;
29  import java.sql.DatabaseMetaData  ;
30  
31  /**
32   * SpecialDBOperation interface is defined for database specific operations.
33   * @author Shing Wai Chan
34   */
35  public interface SpecialDBOperation {
36  
37      /**
38       * This method is called immediately after an instance implementing this
39       * interface is created. The implementation can initialize itself using
40       * supplied metaData.
41       * @param metaData DatbaseMetaData of the database for which an instance
42       * implementing this interface is ingratiated.
43       * @param identifier Identifier of object used to obtain databaseMetaData.
44       * This can be null in non managed environment.
45       */
46      public void initialize(DatabaseMetaData   metaData,
47          String   identifier) throws SQLException  ;
48      /**
49       * Defines column type for result.
50       * @param ps java.sql.PreparedStatement
51       * @param columns List of ColumnElement corresponding to select clause
52       */
53      public void defineColumnTypeForResult(
54          PreparedStatement   ps, List   columns) throws SQLException  ;
55  
56      /**
57       * Binds specified value to parameter at specified index that is bound to
58       * CHAR column.
59       * @param ps java.sql.PreparedStatement
60       * @param index Index of paramater marker in <code>ps</code>.
61       * @param strVal value that needs to bound.
62       * @param length length of the column to which strVal is bound.
63       */
64      public void bindFixedCharColumn(PreparedStatement   ps,
65           int index, String   strVal, int length) throws SQLException  ;
66  
67  }
68
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags