3 * Copyright © 2013 František Kučera (frantovo.cz)
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.
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.
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/>.
18 package info.globalcode.sql.dk.formatting;
20 import info.globalcode.sql.dk.Parameter;
21 import info.globalcode.sql.dk.configuration.DatabaseDefinition;
22 import java.util.EmptyStackException;
23 import java.util.EnumSet;
24 import java.util.List;
25 import java.util.Stack;
29 * @author Ing. František Kučera (frantovo.cz)
31 public abstract class AbstractFormatter implements Formatter {
33 private Stack<State> state = new Stack<>();
34 private FormatterContext formatterContext;
35 private ColumnsHeader currentColumnsHeader;
36 private String currentQuery;
37 private int currentColumnsCount;
38 private int currentRowCount;
40 public AbstractFormatter(FormatterContext formatterContext) {
41 this.formatterContext = formatterContext;
42 state.push(State.ROOT);
58 * ....@updatedRowsCount
60 protected enum State {
71 * Go down in hierarchy.
72 * Pushes new state and verifies the old one.
74 * @param current the new state – currently entering
75 * @param expected expected previous states (any of them is valid)
76 * @return previous state
77 * @throws IllegalStateException if previous state was not one from expected
79 private State pushState(State current, EnumSet expected) {
80 State previous = state.peek();
82 if (expected.contains(previous)) {
86 throw new IllegalStateException("Formatter was in wrong state: " + previous + " when it should be in one of: " + expected);
90 protected State peekState(EnumSet expected) {
91 State current = state.peek();
93 if (expected.contains(current)) {
96 throw new IllegalStateException("Formatter is in wrong state: " + current + " when it should be in one of: " + expected);
102 * Go up in hierarchy.
103 * Pops the superior state/branch.
105 * @param expected expected superior state
106 * @return the superior state
107 * @throws IllegalStateException if superior state was not one from expected or if there is no
108 * more superior state (we are at root level)
110 private State popState(EnumSet expected) {
113 State superior = state.peek();
114 if (expected.contains(superior)) {
117 throw new IllegalStateException("Formatter had wrong superior state: " + superior + " when it should be in one of: " + expected);
119 } catch (EmptyStackException e) {
120 throw new IllegalStateException("Formatter was already at root level – there is nothing above that.", e);
125 public void writeStartBatch() {
126 pushState(State.BATCH, EnumSet.of(State.ROOT));
130 public void writeEndBatch() {
131 popState(EnumSet.of(State.ROOT));
135 public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
136 pushState(State.DATABASE, EnumSet.of(State.BATCH));
140 public void writeEndDatabase() {
141 popState(EnumSet.of(State.BATCH));
145 public void writeStartResultSet() {
146 pushState(State.RESULT_SET, EnumSet.of(State.DATABASE));
151 public void writeEndResultSet() {
152 popState(EnumSet.of(State.DATABASE));
153 currentColumnsHeader = null;
157 public void writeQuery(String sql) {
158 peekState(EnumSet.of(State.RESULT_SET, State.UPDATES_RESULT));
160 if (currentColumnsHeader == null) {
163 throw new IllegalStateException("Query string '" + sql + "' must be set before columns header – was already set: " + currentColumnsHeader);
168 public void writeParameters(List<? extends Parameter> parameters) {
169 peekState(EnumSet.of(State.RESULT_SET, State.UPDATES_RESULT));
171 if (currentColumnsHeader != null) {
172 throw new IllegalStateException("Parameters '" + parameters + "' must be set before columns header – was already set: " + currentColumnsHeader);
175 if (currentQuery == null && parameters != null) {
176 throw new IllegalStateException("Parameters '" + parameters + "' must be set after query – was not yet set.");
181 public void writeColumnsHeader(ColumnsHeader header) {
182 peekState(EnumSet.of(State.RESULT_SET));
184 if (currentColumnsHeader == null) {
185 currentColumnsHeader = header;
187 throw new IllegalStateException("Columns header can be set only once per result set – was already set: " + currentColumnsHeader);
192 public void writeStartRow() {
193 pushState(State.ROW, EnumSet.of(State.RESULT_SET));
194 currentColumnsCount = 0;
199 public void writeEndRow() {
200 popState(EnumSet.of(State.RESULT_SET));
204 public void writeColumnValue(Object value) {
205 peekState(EnumSet.of(State.ROW));
206 currentColumnsCount++;
208 int declaredCount = currentColumnsHeader.getColumnCount();
209 if (currentColumnsCount > declaredCount) {
210 throw new IllegalStateException("Current columns count is " + currentColumnsCount + " which is more than declared " + declaredCount + " in header.");
215 public void writeStartUpdatesResult() {
216 pushState(State.UPDATES_RESULT, EnumSet.of(State.DATABASE));
220 public void writeEndUpdatesResult() {
221 popState(EnumSet.of(State.DATABASE));
222 currentColumnsHeader = null;
226 public void writeUpdatedRowsCount(int updatedRowsCount) {
227 peekState(EnumSet.of(State.UPDATES_RESULT));
231 public void close() throws FormatterException {
234 public FormatterContext getFormatterContext() {
235 return formatterContext;
238 protected ColumnsHeader getCurrentColumnsHeader() {
239 return currentColumnsHeader;
243 * @return column number, 1 = first
245 protected int getCurrentColumnsCount() {
246 return currentColumnsCount;
249 protected boolean isCurrentColumnFirst() {
250 return currentColumnsCount == 1;
253 protected boolean isCurrentColumnLast() {
254 return currentColumnsCount == currentColumnsHeader.getColumnCount();
258 * @return row number, 1 = first
260 protected int getCurrentRowCount() {
261 return currentRowCount;