← Back to branch summary

~mortenoh/+junk/dhis2-detailed-import-export

« back to all changes in this revision

Viewing changes to dhis-2/dhis-api/src/main/java/org/hisp/dhis/jdbc/BatchHandler.java

  • Committer: larshelge at gmail
  • Date: 2009-03-03 16:46:36 UTC
  • Revision ID: larshelge@gmail.com-20090303164636-2sjlrquo7ib1gf7r
Initial check-in

Show diffs side-by-side

added added

removed removed

Lines of Context:
dhis-2/dhis-api/src/main/java/org/hisp/dhis/jdbc/BatchHandler.java
 
1
package org.hisp.dhis.jdbc;
 
2
 
 
3
/*
 
4
 * Copyright (c) 2004-2007, University of Oslo
 
5
 * All rights reserved.
 
6
 *
 
7
 * Redistribution and use in source and binary forms, with or without
 
8
 * modification, are permitted provided that the following conditions are met:
 
9
 * * Redistributions of source code must retain the above copyright notice, this
 
10
 *   list of conditions and the following disclaimer.
 
11
 * * Redistributions in binary form must reproduce the above copyright notice,
 
12
 *   this list of conditions and the following disclaimer in the documentation
 
13
 *   and/or other materials provided with the distribution.
 
14
 * * Neither the name of the HISP project nor the names of its contributors may
 
15
 *   be used to endorse or promote products derived from this software without
 
16
 *   specific prior written permission.
 
17
 *
 
18
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 
20
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 
21
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 
22
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 
23
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 
24
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 
25
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
26
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 
27
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
28
 */
 
29
 
 
30
import java.util.Collection;
 
31
 
 
32
/**
 
33
 * @author Lars Helge Overland
 
34
 * @version $Id: BatchHandler.java 5452 2008-06-25 12:33:49Z larshelg $
 
35
 */
 
36
public interface BatchHandler
 
37
{
 
38
    /**
 
39
     * Initializes the BatchHandler by acquiring a database connection, creating a
 
40
     * statement object and initializing a SQL statement.
 
41
     */
 
42
    void init();
 
43
    
 
44
    /**
 
45
     * Used to set table name for generic BatchHandlers, a typical implementation
 
46
     * will set this property itself.
 
47
     * 
 
48
     * @param tableName the name of the database table.
 
49
     */
 
50
    void setTableName( String tableName );
 
51
    
 
52
    /**
 
53
     * Adds an object to the BatchHandler.
 
54
     * 
 
55
     * @param object the object to add.
 
56
     */
 
57
    void addObject( Object object );
 
58
    
 
59
    /**
 
60
     * Inserts an object directly.
 
61
     * 
 
62
     * @param object the object to insert.
 
63
     * @param returnGeneratedIdentifier return generated indentifier or not.
 
64
     * @return the generated identifier if returnGeneratedIdentifier is true, 0 elsewise.
 
65
     */
 
66
    int insertObject( Object object, boolean returnGeneratedIdentifier );
 
67
    
 
68
    /**
 
69
     * Updates an object.
 
70
     * 
 
71
     * @param object the object to update.
 
72
     */
 
73
    void updateObject( Object object );
 
74
    
 
75
    /**
 
76
     * Checks whether this object exists in the database or not.
 
77
     * 
 
78
     * @param object the object to check.
 
79
     * @return true if the object exists, false if not.
 
80
     */
 
81
    boolean objectExists( Object object );
 
82
    
 
83
    /**
 
84
     * Returns the identifier of the object with the given name.
 
85
     * 
 
86
     * @param objectName the name of the object.
 
87
     * @return the identifier of the object with the given name, 0 if object does not exist.
 
88
     */
 
89
    int getObjectIdentifier( Object objectName );
 
90
    
 
91
    /**
 
92
     * Flushes the BatchHandler by executing a potential remaining statement, and
 
93
     * closing the statement object and the database connection.
 
94
     * 
 
95
     * @return a Collection of the generated identifiers for objects with auto incrementing
 
96
     *         identifiers.
 
97
     */
 
98
    Collection<Integer> flush();
 
99
}