java/sql-dk/src/info/globalcode/sql/dk/formatting/Formatter.java
author František Kučera <franta-hg@frantovo.cz>
Mon, 30 Dec 2013 00:01:39 +0100
branchv_0
changeset 101 97b0d9069133
parent 91 43e8d52091d5
child 142 da1e38386d84
permissions -rw-r--r--
Formatter is now AutoCloseable – so have chance to do some clean up and close the stream, if some error occurs (e.g. lost connection during result set reading)
     1 /**
     2  * SQL-DK
     3  * Copyright © 2013 František Kučera (frantovo.cz)
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, either version 3 of the License, or
     8  * (at your option) any later version.
     9  *
    10  * This program is distributed in the hope that it will be useful,
    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  * GNU General Public License for more details.
    14  *
    15  * You should have received a copy of the GNU General Public License
    16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
    17  */
    18 package info.globalcode.sql.dk.formatting;
    19 
    20 import info.globalcode.sql.dk.Parameter;
    21 import info.globalcode.sql.dk.configuration.DatabaseDefinition;
    22 import java.util.List;
    23 
    24 /**
    25  *
    26  * @author Ing. František Kučera (frantovo.cz)
    27  */
    28 public interface Formatter extends AutoCloseable {
    29 
    30 	void writeStartBatch();
    31 
    32 	void writeStartDatabase(DatabaseDefinition databaseDefinition);
    33 
    34 	void writeEndDatabase();
    35 
    36 	void writeStartResultSet();
    37 
    38 	void writeEndResultSet();
    39 
    40 	void writeQuery(String sql);
    41 
    42 	void writeParameters(List<? extends Parameter> parameters);
    43 
    44 	void writeColumnsHeader(ColumnsHeader header);
    45 
    46 	void writeStartRow();
    47 
    48 	void writeColumnValue(Object value);
    49 
    50 	void writeEndRow();
    51 
    52 	void writeStartUpdatesResult();
    53 
    54 	void writeUpdatedRowsCount(int updatedRowsCount);
    55 
    56 	void writeEndUpdatesResult();
    57 
    58 	void writeEndBatch();
    59 
    60 	/**
    61 	 * If an error occurs (e.g. lost connection during result set reading) this method will be
    62 	 * called even if there was no {@linkplain #writeEndBach()}.
    63 	 */
    64 	@Override
    65 	void close() throws FormatterException;
    66 }