cz.lbenda.dbapp.rc.db.ComboBoxTDExtension.java Source code

Introduction

Here is the source code for cz.lbenda.dbapp.rc.db.ComboBoxTDExtension.java

Source

/*
 * Copyright 2014 Lukas Benda <lbenda at lbenda.cz>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package cz.lbenda.dbapp.rc.db;

import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import cz.lbenda.dbapp.rc.AbstractHelper;
import org.jdom2.Element;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** When the table is show then on defined column is select box
 * Created by Lukas Benda <lbenda @ lbenda.cz> on 9/16/14.
 */
public class ComboBoxTDExtension implements TableDescriptionExtension {

    private static final Logger LOG = LoggerFactory.getLogger(ComboBoxTDExtension.class);

    private final TableDescription td;

    public final TableDescription getTableDescription() {
        return td;
    }

    /** Name of column which is substitued by select box */
    private String columnName;

    public final String getColumnName() {
        return columnName;
    }

    public final void setColumnName(final String columnName) {
        this.columnName = columnName;
    }

    /** SQL which return three fields with identifier which is write to column, showed value and tool tipe. */
    private String tableOfKeySQL;

    public final String getTableOfKeySQL() {
        return tableOfKeySQL;
    }

    public final void setTableOfKeySQL(final String tableOfKeySQL) {
        this.tableOfKeySQL = tableOfKeySQL;
    }

    private String columnValue;

    public final String getColumnValue() {
        return columnValue;
    }

    public final void setColumnValue(final String columnValue) {
        this.columnValue = columnValue;
    }

    private String columnChoice;

    public final String getcColumnChoice() {
        return columnChoice;
    }

    public final void setColumnChoice(final String columnChoice) {
        this.columnChoice = columnChoice;
    }

    private String columnTooltip;

    public final String getColumnTooltip() {
        return columnTooltip;
    }

    public final void setColumnTooltip(final String columnTooltip) {
        this.columnTooltip = columnTooltip;
    }

    /** Flag which inform if combo box have already downloaded data */
    private boolean initialized = false;

    /** List of items which will be show in combo box */
    private final List<ComboBoxItem> items = new ArrayList<>();

    public synchronized final List<ComboBoxItem> getItems() {
        if (!initialized) {
            try {
                loadSelectBoxData();
            } catch (SQLException e) {
                LOG.error("Loading data of combo box failed: " + this, e);
                throw new RuntimeException("Loading data of combo box failed: " + this, e);
            }
        }
        return items;
    }

    public ComboBoxTDExtension(TableDescription td, String columnName, String tableOfKeySQL) {
        this.td = td;
        this.columnName = columnName;
        this.tableOfKeySQL = tableOfKeySQL;
    }

    /** Return the extended column */
    public Column getColumn() {
        return this.td.getColumn(this.columnName);
    }

    @Override
    public final List<Column> getColumns() {
        return Collections.singletonList(getColumn());
    }

    /** This method read data of selectbox
     * @throws java.sql.SQLException exception when data from conneciton is readed
     */
    public synchronized final void loadSelectBoxData() throws SQLException {
        initialized = true;
        LOG.trace("load data to select box");
        final List<Object[]> rows;
        String sql = td.getSessionConfiguration().getTableOfKeysSQL().get(this.tableOfKeySQL);
        if (columnValue == null || columnChoice == null || columnTooltip == null) {
            LOG.info("The name of column isn't defined, so the position of column 1, 2 and 3 is used.");
            rows = td.getSessionConfiguration().getReader().getSQLRows(sql, 1, 2, 3);
        } else {
            rows = td.getSessionConfiguration().getReader().getSQLRows(sql, columnValue, columnChoice,
                    columnTooltip);
        }
        items.clear();
        items.add(ComboBoxItem.EMPTY);
        for (Object[] row : rows) {
            items.add(new ComboBoxItem(row[0], (String) row[1], (String) row[2]));
        }
    }

    @Override
    public void tableWasChanged(TableDescription td, TableAction action) {
        switch (action) {
        case UPDATE:
        case DELETE:
        case INSERT:
            try {
                loadSelectBoxData();
            } catch (SQLException e) {
                LOG.error(String.format("The selctbox extension '%s.%s.%s' wasn't reloaded.", td.getSchema(),
                        td.getName(), this.columnName), e);
            }
            break;
        }
    }

    @Override
    public final Element storeToElement() {
        Element res = new Element("selectBox");
        res.setAttribute("column", columnName).setAttribute("tableOfKeySQL", tableOfKeySQL)
                .setAttribute("column_value", columnValue).setAttribute("column_choice", columnChoice)
                .setAttribute("column_tooltip", columnTooltip);
        return res;
    }

    public final ComboBoxItem itemForValue(Object value) {
        for (ComboBoxItem item : getItems()) {
            if (AbstractHelper.nullEquals(item.getValue(), value)) {
                return item;
            }
        }
        return null;
    }

    public final ComboBoxItem itemForChoice(String choice) {
        for (ComboBoxItem item : getItems()) {
            if (AbstractHelper.nullEquals(item.getChoice(), choice)) {
                return item;
            }
        }
        return null;
    }

    @Override
    public String toString() {
        return "ComboBox: " + columnName + ", " + tableOfKeySQL;
    }

    public static class ComboBoxItem {

        public static final ComboBoxItem EMPTY = new ComboBoxItem(null, "", "");

        private final Object value;

        public final Object getValue() {
            return value;
        }

        private final String choice;

        public final String getChoice() {
            return choice;
        }

        private final String tooltip;

        public final String getTooltip() {
            return tooltip;
        }

        public ComboBoxItem(Object value, String choice, String tooltip) {
            this.value = value;
            this.choice = choice;
            this.tooltip = tooltip;
        }

        @Override
        public String toString() {
            return choice;
        }
    }
}