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  * The formatter is responsible for printing the result sets and/or updates result (count of

    26  * inserted/updated rows). The formatter can produce output in arbitrary format – text, some markup

    27  * or even binary data.

    28  *

    29  * @author Ing. František Kučera (frantovo.cz)

    30  */

    31 public interface Formatter extends AutoCloseable {

    32 

    33 	void writeStartBatch();

    34 

    35 	void writeStartDatabase(DatabaseDefinition databaseDefinition);

    36 

    37 	void writeEndDatabase();

    38 

    39 	void writeStartStatement();

    40 

    41 	void writeEndStatement();

    42 

    43 	void writeQuery(String sql);

    44 

    45 	void writeParameters(List<? extends Parameter> parameters);

    46 

    47 	void writeStartResultSet(ColumnsHeader header);

    48 

    49 	void writeEndResultSet();

    50 

    51 	void writeStartRow();

    52 

    53 	void writeColumnValue(Object value);

    54 

    55 	void writeEndRow();

    56 

    57 	void writeUpdatesResult(int updatedRowsCount);

    58 

    59 	void writeEndBatch();

    60 

    61 	/**

    62 	 * If an error occurs (e.g. lost connection during result set reading) this method will be

    63 	 * called even if there was no {@linkplain #writeEndBach()}.

    64 	 */

    65 	@Override

    66 	void close() throws FormatterException;

    67 }