1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/java/sql-dk/src/main/java/info/globalcode/sql/dk/formatting/Formatter.java	Mon Mar 04 20:15:24 2019 +0100
     1.3 @@ -0,0 +1,67 @@
     1.4 +/**
     1.5 + * SQL-DK
     1.6 + * Copyright © 2013 František Kučera (frantovo.cz)
     1.7 + *
     1.8 + * This program is free software: you can redistribute it and/or modify
     1.9 + * it under the terms of the GNU General Public License as published by
    1.10 + * the Free Software Foundation, either version 3 of the License, or
    1.11 + * (at your option) any later version.
    1.12 + *
    1.13 + * This program is distributed in the hope that it will be useful,
    1.14 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.15 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    1.16 + * GNU General Public License for more details.
    1.17 + *
    1.18 + * You should have received a copy of the GNU General Public License
    1.19 + * along with this program. If not, see <http://www.gnu.org/licenses/>.
    1.20 + */
    1.21 +package info.globalcode.sql.dk.formatting;
    1.22 +
    1.23 +import info.globalcode.sql.dk.Parameter;
    1.24 +import info.globalcode.sql.dk.configuration.DatabaseDefinition;
    1.25 +import java.util.List;
    1.26 +
    1.27 +/**
    1.28 + * The formatter is responsible for printing the result sets and/or updates result (count of
    1.29 + * inserted/updated rows). The formatter can produce output in arbitrary format – text, some markup
    1.30 + * or even binary data.
    1.31 + *
    1.32 + * @author Ing. František Kučera (frantovo.cz)
    1.33 + */
    1.34 +public interface Formatter extends AutoCloseable {
    1.35 +
    1.36 +	void writeStartBatch();
    1.37 +
    1.38 +	void writeStartDatabase(DatabaseDefinition databaseDefinition);
    1.39 +
    1.40 +	void writeEndDatabase();
    1.41 +
    1.42 +	void writeStartStatement();
    1.43 +
    1.44 +	void writeEndStatement();
    1.45 +
    1.46 +	void writeQuery(String sql);
    1.47 +
    1.48 +	void writeParameters(List<? extends Parameter> parameters);
    1.49 +
    1.50 +	void writeStartResultSet(ColumnsHeader header);
    1.51 +
    1.52 +	void writeEndResultSet();
    1.53 +
    1.54 +	void writeStartRow();
    1.55 +
    1.56 +	void writeColumnValue(Object value);
    1.57 +
    1.58 +	void writeEndRow();
    1.59 +
    1.60 +	void writeUpdatesResult(int updatedRowsCount);
    1.61 +
    1.62 +	void writeEndBatch();
    1.63 +
    1.64 +	/**
    1.65 +	 * If an error occurs (e.g. lost connection during result set reading) this method will be
    1.66 +	 * called even if there was no {@linkplain #writeEndBach()}.
    1.67 +	 */
    1.68 +	@Override
    1.69 +	void close() throws FormatterException;
    1.70 +}