au.org.ala.delta.editor.ui.MatrixTableModel.java Source code

Introduction

Here is the source code for au.org.ala.delta.editor.ui.MatrixTableModel.java

Source

/*******************************************************************************
 * Copyright (C) 2011 Atlas of Living Australia
 * All Rights Reserved.
 * 
 * The contents of this file are subject to the Mozilla Public
 * License Version 1.1 (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.mozilla.org/MPL/
 * 
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 ******************************************************************************/
package au.org.ala.delta.editor.ui;

import javax.swing.event.TableModelEvent;
import javax.swing.table.AbstractTableModel;

import org.apache.commons.lang.StringUtils;

import au.org.ala.delta.editor.model.EditorViewModel;
import au.org.ala.delta.model.Attribute;
import au.org.ala.delta.model.Character;
import au.org.ala.delta.model.Item;
import au.org.ala.delta.model.MultiStateAttribute;
import au.org.ala.delta.model.MultiStateCharacter;
import au.org.ala.delta.model.TextCharacter;
import au.org.ala.delta.model.impl.ControllingInfo;
import au.org.ala.delta.model.observer.AbstractDataSetObserver;
import au.org.ala.delta.model.observer.DeltaDataSetChangeEvent;
import au.org.ala.delta.rtf.RTFUtils;

/**
 * Exposes the contents of a DeltaDataSet as a TableModel for use by the MatrixView.
 */
public class MatrixTableModel extends AbstractTableModel {

    private static final long serialVersionUID = 89670522368359600L;

    /** The data set we are adapting to the TableModel interface */
    private EditorViewModel _dataSet;

    public MatrixTableModel(EditorViewModel dataSet) {
        _dataSet = dataSet;
        _dataSet.addDeltaDataSetObserver(new ModelUpdater());
    }

    @Override
    public int getColumnCount() {
        if (_dataSet.getNumberOfCharacters() == 0) {
            return 1;
        }
        return _dataSet.getNumberOfCharacters();
    }

    @Override
    public int getRowCount() {
        return _dataSet.getMaximumNumberOfItems();
    }

    @Override
    public String getColumnName(int column) {

        if (_dataSet.getNumberOfCharacters() == 0) {
            return "";
        }

        Character ch = _dataSet.getCharacter(column + 1);
        return RTFUtils.stripFormatting(ch.getDescription());
    }

    @Override
    public Class<?> getColumnClass(int columnIndex) {
        return Character.class;
    }

    @Override
    public boolean isCellEditable(int rowIndex, int columnIndex) {
        Character character = _dataSet.getCharacter(columnIndex + 1);
        if (character instanceof TextCharacter) {
            return true;
        }
        Attribute attr = _dataSet.getItem(rowIndex + 1).getAttribute(character);
        return attr == null || attr.isSimple();
    }

    public Integer getImplicitStateNo(int rowIndex, int columnIndex) {
        Character character = _dataSet.getCharacter(columnIndex + 1);
        if (character instanceof MultiStateCharacter) {
            MultiStateCharacter msc = (MultiStateCharacter) character;
            MultiStateAttribute attr = (MultiStateAttribute) _dataSet.getItem(rowIndex + 1).getAttribute(character);
            if (attr == null || attr.isImplicit()) {
                int implicit = msc.getUncodedImplicitState();
                if (implicit > 0) {
                    return implicit;
                }
            }
        }

        return null;
    }

    @Override
    public Object getValueAt(int rowIndex, int columnIndex) {

        if (_dataSet.getNumberOfCharacters() == 0) {
            return "";
        }

        String tmp = _dataSet.getAttributeAsString(rowIndex + 1, columnIndex + 1);
        Item item = _dataSet.getItem(rowIndex + 1);
        Character character = _dataSet.getCharacter(columnIndex + 1);
        ControllingInfo cont = character.checkApplicability(item);

        MatrixCellViewModel vm = new MatrixCellViewModel();
        vm.setInapplicable(cont.isInapplicable());

        if (StringUtils.isEmpty(tmp)) {
            Integer implicit = getImplicitStateNo(rowIndex, columnIndex);
            if (implicit != null) {
                vm.setText(String.format("%d", implicit));
                vm.setImplicit(true);
            } else {
                vm.setText("");
            }
        } else {
            vm.setText(RTFUtils.stripFormatting(tmp));
        }
        if (character.isMandatory() && (!item.hasAttribute(character))) {
            vm.setUncodedMandatory(true);
        }

        return vm;
    }

    public EditorViewModel getDataSet() {
        return _dataSet;
    }

    class ModelUpdater extends AbstractDataSetObserver {

        @Override
        public void characterAdded(DeltaDataSetChangeEvent event) {
            fireTableStructureChanged();
        }

        @Override
        public void characterMoved(DeltaDataSetChangeEvent event) {
            fireTableStructureChanged();
        }

        @Override
        public void characterDeleted(DeltaDataSetChangeEvent event) {
            fireTableStructureChanged();
        }

        @Override
        public void characterEdited(DeltaDataSetChangeEvent event) {
            fireTableCellUpdated(TableModelEvent.HEADER_ROW, event.getCharacter().getCharacterId() - 1);
        }

    }
}