package jmri.jmrit.symbolicprog;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

import static java.nio.charset.Charset.defaultCharset;
import static java.nio.charset.Charset.isSupported;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.Vector;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextField;
import javax.swing.table.AbstractTableModel;

import jmri.AddressedProgrammer;
import jmri.jmrit.decoderdefn.DecoderFile;
import jmri.util.CvUtil;
import jmri.util.jdom.LocaleSelector;
import jmri.util.swing.JmriJOptionPane;

import org.jdom2.Attribute;
import org.jdom2.Content;
import org.jdom2.Element;
import org.jdom2.util.IteratorIterable;

/**
 * Table data model for display of variables in symbolic programmer. Also
 * responsible for loading from the XML file.
 *
 * @author Bob Jacobsen Copyright (C) 2001, 2006, 2010
 * @author Howard G. Penny Copyright (C) 2005
 * @author Daniel Boudreau Copyright (C) 2007
 * @author Dave Heap Copyright (C) 2012 Added support for Marklin mfx style
 * speed table
 */
public class VariableTableModel extends AbstractTableModel implements ActionListener, PropertyChangeListener {

    private String[] headers;

    private Vector<VariableValue> rowVector = new Vector<>();  // vector of Variable items
    private CvTableModel _cvModel;          // reference to external table model
    private Vector<JButton> _writeButtons = new Vector<>();
    private Vector<JButton> _readButtons = new Vector<>();
    private JLabel _status;
    protected transient volatile DecoderFile _df = null;

    /**
     * Define the columns.
     * <p>
     * Values understood are: "Name", "Value", "Range", "Read", "Write",
     * "Comment", "CV", "Mask", "State".
     * <p>
     * For each, a property key in SymbolicProgBundle by the same name allows
     * i18n.
     *
     * @param status  variable status.
     * @param h       values headers array.
     * @param cvModel cv table model to use.
     */
    public VariableTableModel(JLabel status, String[] h, CvTableModel cvModel) {
        super();
        _status = status;
        _cvModel = cvModel;
        headers = Arrays.copyOf(h, h.length);
    }

    // basic methods for AbstractTableModel implementation
    @Override
    public int getRowCount() {
        return rowVector.size();
    }

    @Override
    public int getColumnCount() {
        return headers.length;
    }

    @Override
    public String getColumnName(int col) {
        log.debug("getColumnName {}", col);
        return Bundle.getMessage(headers[col]); // I18N
    }

    @Override
    public Class<?> getColumnClass(int col) {
        // log.debug("getColumnClass {}", col;
        switch (headers[col]) {
            case "Value":
                return JTextField.class;
            case "Read":
            case "Write":
                return JButton.class;
            default:
                return String.class;
        }
    }

    @Override
    public boolean isCellEditable(int row, int col) {
        log.debug("isCellEditable {}", col);
        if (headers[col].equals("Value")) {
            return true;
        } else if (headers[col].equals("Read")) {
            return true;
        } else
            return headers[col].equals("Write") && !((rowVector.elementAt(row))).getReadOnly();
    }

    public VariableValue getVariable(int row) {
        return (rowVector.elementAt(row));
    }

    public String getLabel(int row) {
        return (rowVector.elementAt(row)).label();
    }

    public String getItem(int row) {
        return (rowVector.elementAt(row)).item();
    }

    public String getCvName(int row) {
        return (rowVector.elementAt(row)).cvName();
    }

    public String getValString(int row) {
        return (rowVector.elementAt(row)).getValueString();
    }

    public void setIntValue(int row, int val) {
        (rowVector.elementAt(row)).setIntValue(val);
    }

    public void setState(int row, AbstractValue.ValueState val) {
        log.debug("setState row: {} val: {}", row, val);
        (rowVector.elementAt(row)).setState(val);
    }

    public AbstractValue.ValueState getState(int row) {
        return (rowVector.elementAt(row)).getState();
    }

    /*
     * Request a "unique representation", e.g. something we can show
     * for the row-th variable.
     */
    public Object getRep(int row, String format) {
        VariableValue v = rowVector.elementAt(row);
        return v.getNewRep(format);
    }

    @Override
    public Object getValueAt(int row, int col) {
        // log.debug("getValueAt {} {}", row, col;
        if (row >= rowVector.size()) {
            log.debug("row index greater than row vector size");
            return "Error";
        }
        VariableValue v = rowVector.elementAt(row);
        if (v == null) {
            log.debug("v is null!");
            return "Error value";
        }
        switch (headers[col]) {
            case "Value":
                return v.getCommonRep();
            case "Read":
                // NOI18N
                return _readButtons.elementAt(row);
            case "Write":
                // NOI18N
                return _writeButtons.elementAt(row);
            case "CV":
                // NOI18N
                return "" + v.getCvNum();
            case "Name":
                // NOI18N
                return "" + v.label();
            case "Comment":
                // NOI18N
                return v.getComment();
            case "Mask":
                // NOI18N
                return v.getMask();
            case "State":
                // NOI18N
                AbstractValue.ValueState state = v.getState();
                switch (state) {
                    case UNKNOWN:
                        return "Unknown";
                    case READ:
                        return "Read";
                    case EDITED:
                        return "Edited";
                    case STORED:
                        return "Stored";
                    case FROMFILE:
                        return "From file, known previously valid";
                    case FROMFILEUNKNOWN:
                        return "From file, possibly still at default";
                    case FROMDEFAULT:
                        return "From decoder definition defaults";
                    default:
                        return "inconsistent";
                }
            case "Range":
                return v.rangeVal();
            default:
                return "Later, dude";
        }
    }

    @Override
    public void setValueAt(Object value, int row, int col) {
        log.debug("setvalueAt {} {} {}", row, col, value);
        setFileDirty(true);
    }

    /**
     * Load one row in the VariableTableModel, by reading in the Element
     * containing its definition.
     * <p>
     * Note that this method does not pass a reference to a {@link DecoderFile}
     * instance, hence include/exclude processing at the sub-variable level is
     * not possible and will be ignored.
     * <p>
     * Use of {@link #setRow(int row, Element e, DecoderFile df)} is preferred.
     *
     * @param row number of row to fill
     * @param e   Element of type "variable"
     */
    public void setRow(int row, Element e) {
        this.setRow(row, e, null);
    }

    /**
     * Load one row in the VariableTableModel, by reading in the Element
     * containing its definition.
     * <p>
     * Invoked from {@link DecoderFile}
     *
     * @param row number of row to fill
     * @param e   Element of type "variable"
     * @param df  the source {@link DecoderFile} instance (needed for
     *            include/exclude processing at the sub-variable level)
     */
    public void setRow(int row, Element e, DecoderFile df) {    
        // get the values for the VariableValue ctor
        _df = df;
        String name = LocaleSelector.getAttribute(e, "label");  // Note the name variable is actually the label attribute
        log.debug("Starting to setRow \"{}\"", name);
        String item = (e.getAttribute("item") != null
                ? e.getAttribute("item").getValue()
                : null);
        // as a special case, if no item, use label
        if (item == null) {
            item = name;
            log.debug("no item attribute, used label \"{}\"", name);
        }
        // as a special case, if no label, use item
        if (name == null) {
            name = item;
            log.debug("no label attribute, used item attribute \"{}\"", item);
        }

        String comment = LocaleSelector.getAttribute(e, "comment");

        String CV = "";
        if (e.getAttribute("CV") != null) {
            CV = e.getAttribute("CV").getValue();
        }
        String mask;
        if (e.getAttribute("mask") != null) {
            mask = e.getAttribute("mask").getValue();
        } else {
            mask = "VVVVVVVV"; // default mask is 8 bits
            // for some VariableValue types this is replaced in #processDecVal() by larger mask if maxVal>256
        }

        boolean readOnly = e.getAttribute("readOnly") != null && e.getAttribute("readOnly").getValue().equals("yes");
        boolean infoOnly = e.getAttribute("infoOnly") != null && e.getAttribute("infoOnly").getValue().equals("yes");
        boolean writeOnly = e.getAttribute("writeOnly") != null && e.getAttribute("writeOnly").getValue().equals("yes");
        boolean opsOnly = e.getAttribute("opsOnly") != null && e.getAttribute("opsOnly").getValue().equals("yes");

        // Handle special case of opsOnly mode & specific programmer type
        if (_cvModel.getProgrammer() != null) {
            if (opsOnly && !AddressedProgrammer.class.isAssignableFrom(_cvModel.getProgrammer().getClass())) {
                // opsOnly but not Ops mode, so adjust
                readOnly = false;
                writeOnly = false;
                infoOnly = true;
            }
        }

        JButton bw = new JButton(Bundle.getMessage("ButtonWrite"));
        _writeButtons.addElement(bw);
        JButton br = new JButton(Bundle.getMessage("ButtonRead"));
        _readButtons.addElement(br);
        setButtonsReadWrite(readOnly, infoOnly, writeOnly, bw, br, row);

        if (_cvModel == null) {
            log.error("CvModel reference is null; cannot add variables");
            return;
        }
        if (!CV.equals("")) { // some variables have no CV per se
            List<String> cvList = CvUtil.expandCvList(CV);
            if (cvList.isEmpty()) {
                _cvModel.addCV(CV, readOnly, infoOnly, writeOnly);
            } else { // or require expansion
                for (String s : cvList) {
                    _cvModel.addCV(s, readOnly, infoOnly, writeOnly);
                }
            }
        }

        // decode and handle specific types
        Element child;
        VariableValue v;
        if ((child = e.getChild("decVal")) != null) {
            v = processDecVal(child, name, comment, readOnly, infoOnly, writeOnly, opsOnly, CV, mask, item);

        } else if ((child = e.getChild("hexVal")) != null) {
            v = processHexVal(child, name, comment, readOnly, infoOnly, writeOnly, opsOnly, CV, mask, item);

        } else if ((child = e.getChild("enumVal")) != null) {
            v = processEnumVal(child, name, comment, readOnly, infoOnly, writeOnly, opsOnly, CV, mask, item);

        } else if ((child = e.getChild("compositeVal")) != null) {
            // loop over the choices
            v = processCompositeVal(child, name, comment, readOnly, infoOnly, writeOnly, opsOnly, CV, mask, item);

        } else if ((child = e.getChild("speedTableVal")) != null) {
            v = processSpeedTableVal(child, CV, readOnly, infoOnly, writeOnly, name, comment, opsOnly, mask, item);

        } else if ((child = e.getChild("longAddressVal")) != null) {
            v = processLongAddressVal(CV, readOnly, infoOnly, writeOnly, name, comment, opsOnly, mask, item);

        } else if ((child = e.getChild("shortAddressVal")) != null) {
            v = processShortAddressVal(name, comment, readOnly, infoOnly, writeOnly, opsOnly, CV, mask, item, child);

        } else if ((child = e.getChild("splitVal")) != null) {
            v = processSplitVal(child, CV, readOnly, infoOnly, writeOnly, name, comment, opsOnly, mask, item);

        } else if ((child = e.getChild("splitHexVal")) != null) {
            v = processSplitHexVal(child, CV, readOnly, infoOnly, writeOnly, name, comment, opsOnly, mask, item);

        } else if ((child = e.getChild("splitHundredsVal")) != null) {
            v = processSplitHundredsVal(child, CV, readOnly, infoOnly, writeOnly, name, comment, opsOnly, mask, item);

        } else if ((child = e.getChild("splitTextVal")) != null) {
            v = processSplitTextVal(child, CV, readOnly, infoOnly, writeOnly, name, comment, opsOnly, mask, item);

        } else if ((child = e.getChild("splitDateTimeVal")) != null) {
            v = processSplitDateTimeVal(child, CV, readOnly, infoOnly, writeOnly, name, comment, opsOnly, mask, item);

        } else if ((child = e.getChild("splitEnumVal")) != null) {
            v = processSplitEnumVal(child, CV, readOnly, infoOnly, writeOnly, name, comment, opsOnly, mask, item);

        } else {
            reportBogus(e);
            return;
        }

        processModifierElements(e, v);

        setToolTip(e, v);

        // record new variable, update state, hook up listeners
        rowVector.addElement(v);
        v.setState(AbstractValue.ValueState.FROMDEFAULT);
        v.addPropertyChangeListener(this);

        // set to default value if specified (CV load may later override this)
        if (setDefaultValue(e, v)) {
            // need to correct state of associated CV(s) & handle a possible CV List
            List<String> cvList = CvUtil.expandCvList(CV);  // see if CV is in list format
            if (cvList.isEmpty()) {
                cvList.add(CV);  // it's an ordinary CV so add it as such
            }
            for (String theCV : cvList) {
                log.debug("Setting CV={} of '{}'to {}", theCV, CV, AbstractValue.ValueState.FROMDEFAULT.getName());
                _cvModel.getCvByNumber(theCV).setState(AbstractValue.ValueState.FROMDEFAULT); // correct for transition to "edited"
            }
        }
    }

    /**
     * If there are any modifier elements, process them by e.g. setting
     * attributes on the VariableValue.
     *
     * @param e        Element that's source of info
     * @param variable Variable to load
     */
    protected void processModifierElements(final Element e, final VariableValue variable) {
        QualifierAdder qa = new QualifierAdder() {
            @Override
            protected Qualifier createQualifier(VariableValue variable2, String relation, String value) {
                return new ValueQualifier(variable, variable2, Integer.parseInt(value), relation);
            }

            @Override
            protected void addListener(java.beans.PropertyChangeListener qc) {
                variable.addPropertyChangeListener(qc);
            }
        };

        qa.processModifierElements(e, this);
    }

    /**
     * If there's a "default" attribute, or matching defaultItem element, set
     * that value to start.
     *
     * @param e        Element that's source of info
     * @param variable Variable to load
     * @return true if the value was set
     */
    boolean setDefaultValue(Element e, VariableValue variable) {
        Attribute a;
        boolean set = false;
        if ((a = e.getAttribute("default")) != null) {
            String val = a.getValue();
            variable.setValue(val);
            set = true;
        }
        // check for matching child
        List<Element> elements = e.getChildren("defaultItem");
        for (Element defaultItem : elements) {
            if (_df != null && DecoderFile.isIncluded(defaultItem, _df.getProductID(), _df.getModel(), _df.getFamily(), "", "")) {
                log.debug("element included by productID={} model={} family={}", _df.getProductID(), _df.getModel(), _df.getFamily());
                variable.setValue(defaultItem.getAttribute("default").getValue());
                return true;
            }
        }
        return set;
    }

    protected VariableValue processCompositeVal(Element child, String name, String comment, boolean readOnly, boolean infoOnly, boolean writeOnly, boolean opsOnly, String CV, String mask, String item) {
        int count = 0;
        IteratorIterable<Content> iterator = child.getDescendants();
        while (iterator.hasNext()) {
            Object ex = iterator.next();
            if (ex instanceof Element) {
                if (((Element) ex).getName().equals("compositeChoice")) {
                    count++;
                }
            }
        }

        VariableValue v;
        CompositeVariableValue v1 = new CompositeVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, 0, count, _cvModel.allCvMap(), _status, item);
        v = v1; // v1 is of CompositeVariableType, so doesn't need casts

        v1.nItems(count);
        handleCompositeValChildren(child, v1);
        v1.lastItem();
        return v;
    }

    /**
     * Recursively walk the child compositeChoice elements, working through the
     * compositeChoiceGroup elements as needed.
     * <p>
     * Adapted from handleEnumValChildren for use in LocoIO Legacy tool.
     *
     * @param e   Element that's source of info
     * @param var Variable to load
     */
    protected void handleCompositeValChildren(Element e, CompositeVariableValue var) {
        List<Element> local = e.getChildren();
        for (Element el : local) {
            log.debug("processing element='{}' name='{}' choice='{}' value='{}'", el.getName(), LocaleSelector.getAttribute(el, "name"), LocaleSelector.getAttribute(el, "choice"), el.getAttribute("value"));
            if (_df != null && !DecoderFile.isIncluded(el, _df.getProductID(), _df.getModel(), _df.getFamily(), "", "")) {
                log.debug("element excluded by productID={} model={} family={}", _df.getProductID(), _df.getModel(), _df.getFamily());
                continue;
            }
            if (el.getName().equals("compositeChoice")) {
                // Create the choice
                String choice = LocaleSelector.getAttribute(el, "choice");
                var.addChoice(choice);
                // for each choice, capture the settings
                List<Element> lSetting = el.getChildren("compositeSetting");
                for (Element settingElement : lSetting) {
                    String varName = LocaleSelector.getAttribute(settingElement, "label");
                    String value = settingElement.getAttribute("value").getValue();
                    var.addSetting(choice, varName, findVar(varName), value);
                }
            } else if (el.getName().equals("compositeChoiceGroup")) {
                // no tree to manage as in enumGroup
                handleCompositeValChildren(el, var);
            }
            log.debug("element processed");
        }
    }

    protected VariableValue processDecVal(Element child, String name, String comment, boolean readOnly, boolean infoOnly,
                                          boolean writeOnly, boolean opsOnly, String CV, String mask, String item)
            throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        if ((a = child.getAttribute("min")) != null) {
            minVal = Integer.parseInt(a.getValue());
        }
        if ((a = child.getAttribute("max")) != null) {
            maxVal = Integer.parseInt(a.getValue());
        }
        int factor = 1;
        if ((a = child.getAttribute("factor")) != null) {
            factor = Integer.parseInt(a.getValue());
        }
        int offset = 0;
        if ((a = child.getAttribute("offset")) != null) {
            offset = Integer.parseInt(a.getValue());
        }
        if (maxVal > 255 && Objects.equals(mask, "VVVVVVVV")) {
            mask = VariableValue.getMaxMask(maxVal); // replaces the default 8 bit mask when no mask is provided in xml
            log.debug("Created mask {} for DecVar CV {}", mask, name);
        }
        v = new DecVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly,
                CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, offset, factor);
        _cvModel.registerCvToVariableMapping(CV, name);
        return v;
    }

    protected VariableValue processEnumVal(Element child, String name, String comment, boolean readOnly, boolean infoOnly,
                                           boolean writeOnly, boolean opsOnly, String CV, String mask, String item)
            throws NumberFormatException {
        VariableValue v;
        int count = 0;
        IteratorIterable<Content> iterator = child.getDescendants();
        while (iterator.hasNext()) {
            Object ex = iterator.next();
            if (ex instanceof Element) {
                if (((Element) ex).getName().equals("enumChoice")) {
                    count++;
                }
            }
        }
        Attribute a;
        int maxVal = 255;
        if ((a = child.getAttribute("max")) != null) {
            // requires explicit max attribute for Radix mask if not all options are filled by enum
            maxVal = Integer.parseInt(a.getValue());
        } else {
            maxVal = count;
        }
        EnumVariableValue v1 = new EnumVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly,
                CV, mask, 0, maxVal, _cvModel.allCvMap(), _status, item);
        v = v1; // v1 is of EnumVariableValue type, so doesn't need casts
        _cvModel.registerCvToVariableMapping(CV, name);

        v1.nItems(count);
        handleEnumValChildren(child, v1);
        v1.lastItem();
        return v;
    }

    protected VariableValue processSplitEnumVal(Element child, String CV, boolean readOnly, boolean infoOnly, boolean writeOnly, String name, String comment, boolean opsOnly, String mask, String item) throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        String highCV = null;

        int count = 0;
        IteratorIterable<Content> iterator = child.getDescendants();
        while (iterator.hasNext()) {
            Object ex = iterator.next();
            if (ex instanceof Element) {
                if (((Element) ex).getName().equals("enumChoice")) {
                    count++;
                }
            }
        }

        if ((a = child.getAttribute("highCV")) != null) {
            highCV = a.getValue();
            _cvModel.addCV("" + (highCV), readOnly, infoOnly, writeOnly); // ensure 2nd CV exists
            _cvModel.registerCvToVariableMapping(highCV, name);
        }
        int factor = 1;
        if ((a = child.getAttribute("factor")) != null) {
            factor = Integer.parseInt(a.getValue());
        }
        int offset = 0;
        if ((a = child.getAttribute("offset")) != null) {
            offset = Integer.parseInt(a.getValue());
        }
        String uppermask = "VVVVVVVV";
        if ((a = child.getAttribute("upperMask")) != null) {
            uppermask = a.getValue();
        }
        String extra3 = "0";
        if ((a = child.getAttribute("min")) != null) {
            extra3 = a.getValue();
        }
        String extra4 = Long.toUnsignedString(~0);
        if ((a = child.getAttribute("max")) != null) {
            extra4 = a.getValue();
        }

        SplitEnumVariableValue v1 = new SplitEnumVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, highCV, factor, offset, uppermask, null, null, extra3, extra4);
        v = v1; // v1 is of EnunVariableValue type, so doesn't need casts
        _cvModel.registerCvToVariableMapping(CV, name);

        v1.nItems(count);

        handleSplitEnumValChildren(child, v1);
        v1.lastItem();
        return v;
    }

    /**
     * Recursively walk the child enumChoice elements, working through the
     * enumChoiceGroup elements as needed.
     *
     * @param e   Element that's source of info
     * @param var Variable to load
     */
    protected void handleSplitEnumValChildren(Element e, SplitEnumVariableValue var) {
        List<Element> local = e.getChildren();

        for (Element el : local) {
            log.debug("processing element='{}' name='{}' choice='{}' value='{}'", el.getName(), LocaleSelector.getAttribute(el, "name"), LocaleSelector.getAttribute(el, "choice"), el.getAttribute("value"));
            if (_df != null && !DecoderFile.isIncluded(el, _df.getProductID(), _df.getModel(), _df.getFamily(), "", "")) {
                log.debug("element excluded by productID={} model={} family={}", _df.getProductID(), _df.getModel(), _df.getFamily());
                continue;
            }
            if (el.getName().equals("enumChoice")) {
                Attribute valAttr = el.getAttribute("value");
                if (valAttr == null) {
                    var.addItem(LocaleSelector.getAttribute(el, "choice"));
                } else {
                    var.addItem(LocaleSelector.getAttribute(el, "choice"),
                            Integer.parseInt(valAttr.getValue()));
                }
            } else if (el.getName().equals("enumChoiceGroup")) {
                var.startGroup(LocaleSelector.getAttribute(el, "name"));
                handleSplitEnumValChildren(el, var);
                var.endGroup();
            }
            log.debug("element processed");
        }
    }

    /**
     * Recursively walk the child enumChoice elements, working through the
     * enumChoiceGroup elements as needed.
     *
     * @param e   Element that's source of info
     * @param var Variable to load
     */
    protected void handleEnumValChildren(Element e, EnumVariableValue var) {
        List<Element> local = e.getChildren();
        for (Element el : local) {
            log.debug("processing element='{}' name='{}' choice='{}' value='{}'", el.getName(), LocaleSelector.getAttribute(el, "name"), LocaleSelector.getAttribute(el, "choice"), el.getAttribute("value"));
            if (_df != null && !DecoderFile.isIncluded(el, _df.getProductID(), _df.getModel(), _df.getFamily(), "", "")) {
                log.debug("element excluded by productID={} model={} family={}", _df.getProductID(), _df.getModel(), _df.getFamily());
                continue;
            }
            if (el.getName().equals("enumChoice")) {
                Attribute valAttr = el.getAttribute("value");
                if (valAttr == null) {
                    var.addItem(LocaleSelector.getAttribute(el, "choice"));
                } else {
                    var.addItem(LocaleSelector.getAttribute(el, "choice"),
                            Integer.parseInt(valAttr.getValue()));
                }
            } else if (el.getName().equals("enumChoiceGroup")) {
                var.startGroup(LocaleSelector.getAttribute(el, "name"));
                handleEnumValChildren(el, var);
                var.endGroup();
            }
            log.debug("element processed");
        }
    }

    protected VariableValue processHexVal(Element child, String name, String comment, boolean readOnly, boolean infoOnly, boolean writeOnly, boolean opsOnly, String CV, String mask, String item) throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        if ((a = child.getAttribute("min")) != null) {
            minVal = Integer.valueOf(a.getValue(), 16);
        }
        if ((a = child.getAttribute("max")) != null) {
            maxVal = Integer.valueOf(a.getValue(), 16);
        }
        if (maxVal > 255 && Objects.equals(mask, "VVVVVVVV")) {
            mask = VariableValue.getMaxMask(maxVal); // replaces the default 8 bit mask when no mask is provided in xml
            log.debug("Created mask {} for Hex CV {}", mask, name);
        }
        v = new HexVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item);
        _cvModel.registerCvToVariableMapping(CV, name);
        return v;
    }

    protected VariableValue processLongAddressVal(String CV, boolean readOnly, boolean infoOnly, boolean writeOnly, String name, String comment, boolean opsOnly, String mask, String item) {
        VariableValue v;
        int minVal = 0;
        int maxVal = 255;
        _cvModel.addCV("18", readOnly, infoOnly, writeOnly); // ensure 2nd CV exists
        v = new LongAddrVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, _cvModel.allCvMap().get("18"));
        _cvModel.registerCvToVariableMapping(CV, name);
        _cvModel.registerCvToVariableMapping("18", name); // see fixed value two lines up
        return v;
    }

    protected VariableValue processShortAddressVal(String name, String comment, boolean readOnly, boolean infoOnly, boolean writeOnly, boolean opsOnly, String CV, String mask, String item, Element child) {
        VariableValue v;
        ShortAddrVariableValue v1 = new ShortAddrVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, _cvModel.allCvMap(), _status, item);
        v = v1;
        // get specifics if any
        List<Element> l = child.getChildren("shortAddressChanges");
        for (Element element : l) {
            v1.setModifiedCV(element.getAttribute("cv").getValue());
        }
        _cvModel.registerCvToVariableMapping(CV, name);
        return v;
    }

    protected VariableValue processSpeedTableVal(Element child, String CV, boolean readOnly, boolean infoOnly, boolean writeOnly, String name, String comment, boolean opsOnly, String mask, String item) throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        if ((a = child.getAttribute("min")) != null) {
            minVal = Integer.parseInt(a.getValue());
        }
        if ((a = child.getAttribute("max")) != null) {
            maxVal = Integer.parseInt(a.getValue());
        }
        Attribute entriesAttr = child.getAttribute("entries");
        int entries = 28;
        try {
            if (entriesAttr != null) {
                entries = entriesAttr.getIntValue();
            }
        } catch (org.jdom2.DataConversionException ignored) {
        }
        Attribute ESUAttr = child.getAttribute("mfx");
        boolean mfxFlag = false;
        try {
            if (ESUAttr != null) {
                mfxFlag = ESUAttr.getBooleanValue();
            }
        } catch (org.jdom2.DataConversionException ignored) {
        }
        // ensure all CVs exist
        for (int i = 0; i < entries; i++) {
            _cvModel.addCV(Integer.toString(Integer.parseInt(CV) + i), readOnly, infoOnly, writeOnly);
            _cvModel.registerCvToVariableMapping(Integer.toString(Integer.parseInt(CV) + i), name);

        }
        if (mfxFlag) {
            _cvModel.addCV("2", readOnly, infoOnly, writeOnly);
            _cvModel.registerCvToVariableMapping("2", name);

            _cvModel.addCV("5", readOnly, infoOnly, writeOnly);
            _cvModel.registerCvToVariableMapping("5", name);

        }
        v = new SpeedTableVarValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, entries, mfxFlag);
        return v;
    }

    protected VariableValue processSplitVal(Element child, String CV, boolean readOnly, boolean infoOnly, boolean writeOnly, String name, String comment, boolean opsOnly, String mask, String item) throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        String highCV = null;

        if ((a = child.getAttribute("highCV")) != null) {
            highCV = a.getValue();
            _cvModel.addCV("" + (highCV), readOnly, infoOnly, writeOnly); // ensure 2nd CV exists
            _cvModel.registerCvToVariableMapping("" + (highCV), name);

        }
        int factor = 1;
        if ((a = child.getAttribute("factor")) != null) {
            factor = Integer.parseInt(a.getValue());
        }
        int offset = 0;
        if ((a = child.getAttribute("offset")) != null) {
            offset = Integer.parseInt(a.getValue());
        }
        String uppermask = "VVVVVVVV";
        if ((a = child.getAttribute("upperMask")) != null) {
            uppermask = a.getValue();
        }
        String extra3 = "0";
        if ((a = child.getAttribute("min")) != null) {
            extra3 = a.getValue();
        }
        String extra4 = Long.toUnsignedString(~0);
        if ((a = child.getAttribute("max")) != null) {
            extra4 = a.getValue();
        }
        v = new SplitVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, highCV, factor, offset, uppermask, null, null, extra3, extra4);
        _cvModel.registerCvToVariableMapping(CV, name);
        return v;
    }

    protected VariableValue processSplitHexVal(Element child, String CV, boolean readOnly, boolean infoOnly, boolean writeOnly, String name, String comment, boolean opsOnly, String mask, String item) throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        String highCV = null;

        if ((a = child.getAttribute("highCV")) != null) {
            highCV = a.getValue();
            _cvModel.addCV("" + (highCV), readOnly, infoOnly, writeOnly); // ensure 2nd CV exists
            _cvModel.registerCvToVariableMapping("" + (highCV), name);
        }
        int factor = 1;
        if ((a = child.getAttribute("factor")) != null) {
            factor = Integer.parseInt(a.getValue());
        }
        int offset = 0;
        if ((a = child.getAttribute("offset")) != null) {
            offset = Integer.parseInt(a.getValue());
        }
        String uppermask = "VVVVVVVV";
        if ((a = child.getAttribute("upperMask")) != null) {
            uppermask = a.getValue();
        }
        String extra1 = "default";
        if ((a = child.getAttribute("case")) != null) {
            extra1 = a.getValue();
        }
        String extra3 = "0";
        if ((a = child.getAttribute("min")) != null) {
            extra3 = a.getValue();
        }
        String extra4 = Long.toUnsignedString(~0, 16);
        if ((a = child.getAttribute("max")) != null) {
            extra4 = a.getValue();
        }
        v = new SplitHexVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, highCV, factor, offset, uppermask, extra1, null, extra3, extra4);
        _cvModel.registerCvToVariableMapping(CV, name);
        return v;
    }

    protected VariableValue processSplitHundredsVal(Element child, String CV, boolean readOnly, boolean infoOnly, boolean writeOnly, String name, String comment, boolean opsOnly, String mask, String item) throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        String highCV = null;

        if ((a = child.getAttribute("highCV")) != null) {
            highCV = a.getValue();
            _cvModel.addCV("" + (highCV), readOnly, infoOnly, writeOnly); // ensure 2nd CV exists
            _cvModel.registerCvToVariableMapping("" + (highCV), name);
        }
        int factor = 1;
        if ((a = child.getAttribute("factor")) != null) {
            factor = Integer.parseInt(a.getValue());
        }
        int offset = 0;
        if ((a = child.getAttribute("offset")) != null) {
            offset = Integer.parseInt(a.getValue());
        }
        String uppermask = "VVVVVVVV";
        if ((a = child.getAttribute("upperMask")) != null) {
            uppermask = a.getValue();
        }
        String extra3 = "0";
        if ((a = child.getAttribute("min")) != null) {
            extra3 = a.getValue();
        }
        String extra4 = Long.toUnsignedString(~0);
        if ((a = child.getAttribute("max")) != null) {
            extra4 = a.getValue();
        }
        v = new SplitHundredsVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, highCV, factor, offset, uppermask, null, null, extra3, extra4);
        _cvModel.registerCvToVariableMapping(CV, name);
        return v;
    }

    @edu.umd.cs.findbugs.annotations.SuppressFBWarnings( value="SLF4J_FORMAT_SHOULD_BE_CONST",
        justification="I18N of Error Message")
    protected VariableValue processSplitTextVal(Element child, String CV, boolean readOnly, boolean infoOnly, boolean writeOnly, String name, String comment, boolean opsOnly, String mask, String item) throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        String highCV = null;

        if ((a = child.getAttribute("min")) != null) {
            minVal = Integer.parseInt(a.getValue());
        }
        if ((a = child.getAttribute("max")) != null) {
            maxVal = Integer.parseInt(a.getValue());
        }
        if ((a = child.getAttribute("highCV")) != null) {
            highCV = a.getValue();
            _cvModel.addCV("" + (highCV), readOnly, infoOnly, writeOnly); // ensure 2nd CV exists
            _cvModel.registerCvToVariableMapping("" + (highCV), name);
        }
        int factor = 1;
        if ((a = child.getAttribute("factor")) != null) {
            factor = Integer.parseInt(a.getValue());
        }
        int offset = 0;
        if ((a = child.getAttribute("offset")) != null) {
            offset = Integer.parseInt(a.getValue());
        }
        String uppermask = "VVVVVVVV";
        if ((a = child.getAttribute("upperMask")) != null) {
            uppermask = a.getValue();
        }
        String match = null;
        if ((a = child.getAttribute("match")) != null) {
            match = a.getValue();
        }
        String termByte = "0";
        if ((a = child.getAttribute("termByte")) != null) {
            termByte = a.getValue();
        }
        String padByte = "0";
        if ((a = child.getAttribute("padByte")) != null) {
            padByte = a.getValue();
        }
        String charSet = defaultCharset().name();
        if ((a = child.getAttribute("charSet")) != null) {
            charSet = a.getValue();
        }
        boolean ok;
        try {
            ok = isSupported(charSet);
        } catch (IllegalArgumentException ex) {
            ok = false;
        }
        if (!ok) {
            synchronized (this) {
                JmriJOptionPane.showMessageDialog(new JFrame(), Bundle.getMessage("UnsupportedCharset", charSet, name),
                        Bundle.getMessage("DecoderDefError"), JmriJOptionPane.ERROR_MESSAGE); // NOI18N
            }
            log.error(Bundle.getMessage("UnsupportedCharset", charSet, name));
        }
        v = new SplitTextVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, highCV, factor, offset, uppermask, match, termByte, padByte, charSet);
        _cvModel.registerCvToVariableMapping(CV, name);
        return v;
    }

    protected VariableValue processSplitDateTimeVal(Element child, String CV, boolean readOnly, boolean infoOnly, boolean writeOnly, String name, String comment, boolean opsOnly, String mask, String item) throws NumberFormatException {
        VariableValue v;
        Attribute a;
        int minVal = 0;
        int maxVal = 255;
        boolean varRreadOnly = true; // unable to parse text dates accurately enough so force variable (but not CVs) to be read only
        String highCV = null;

        if ((a = child.getAttribute("min")) != null) {
            minVal = Integer.parseInt(a.getValue());
        }
        if ((a = child.getAttribute("max")) != null) {
            maxVal = Integer.parseInt(a.getValue());
        }
        if ((a = child.getAttribute("highCV")) != null) {
            highCV = a.getValue();
            _cvModel.addCV("" + (highCV), readOnly, infoOnly, writeOnly); // ensure 2nd CV exists
            _cvModel.registerCvToVariableMapping("" + (highCV), name);
        }
        int factor = 1;
        int offset = 0;

        String uppermask = "VVVVVVVV";
        if ((a = child.getAttribute("upperMask")) != null) {
            uppermask = a.getValue();
        }
        String extra1 = "2000-01-01T00:00:00";  // The S9.3.2 RailCom epoch
        // Java epoch is "1970-01-01T00:00:00"
        if ((a = child.getAttribute("base")) != null) {
            extra1 = a.getValue();
        }
        String extra2 = "1";
        if ((a = child.getAttribute("factor")) != null) {
            extra2 = a.getValue();
        }
        String extra3 = "Seconds";
        if ((a = child.getAttribute("unit")) != null) {
            extra3 = a.getValue();
        }
        String extra4 = "default";
        if ((a = child.getAttribute("display")) != null) {
            extra4 = a.getValue();
        }
        v = new SplitDateTimeVariableValue(name, comment, "", varRreadOnly, infoOnly, writeOnly, opsOnly, CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, item, highCV, factor, offset, uppermask, extra1, extra2, extra3, extra4);
        _cvModel.registerCvToVariableMapping(CV, name);
        return v;
    }

    protected void setButtonsReadWrite(boolean readOnly, boolean infoOnly, boolean writeOnly, JButton bw, JButton br, int row) {
        if (readOnly || infoOnly) {
            // readOnly or infoOnly, config write, read buttons
            if (writeOnly) {
                bw.setEnabled(true);
                bw.setActionCommand("W" + row);
                bw.addActionListener(this);
            } else {
                bw.setEnabled(false);
            }
            if (infoOnly) {
                br.setEnabled(false);
            } else {
                br.setActionCommand("R" + row);
                br.addActionListener(this);
            }
        } else {
            // not readOnly or infoOnly, config write, read buttons
            bw.setActionCommand("W" + row);
            bw.addActionListener(this);
            if (writeOnly) {
                br.setEnabled(false);
            } else {
                br.setActionCommand("R" + row);
                br.addActionListener(this);
            }
        }
    }

    public void setButtonModeFromProgrammer() {
        if (_cvModel.getProgrammer() == null || !_cvModel.getProgrammer().getCanRead()) {
            for (JButton b : _readButtons) {
                b.setEnabled(false);
            }
        }
    }

    protected void setToolTip(Element e, VariableValue v) {
        // back to general processing
        // add tooltip text if present
        {
            String t;
            if ((t = LocaleSelector.getAttribute(e, "tooltip")) != null) {
                v.setToolTipText(t);
            }
        }
    }

    void reportBogus(Element elem) {
        log.error("Did not find a valid type in {}", elem.getChildren());
        for (Attribute a : elem.getAttributes()) log.error("   attribute: {}",a);
    }

    /**
     * Configure from a constant. This is like setRow (which processes a
     * variable Element).
     *
     * @param e element to set.
     */
    @SuppressFBWarnings(value = "NP_LOAD_OF_KNOWN_NULL_VALUE",
            justification = "null mask parameter to ConstantValue constructor expected.")
    public void setConstant(Element e) {
        // get the values for the VariableValue ctor
        String stdname = e.getAttribute("item").getValue();
        log.debug("Starting to setConstant \"{}\"", stdname);

        String name = LocaleSelector.getAttribute(e, "label");
        if (name == null || name.equals("")) {
            name = stdname;
        }

        String comment = LocaleSelector.getAttribute(e, "comment");

        String mask = null;

        // intrinsically readOnly, so use just that branch
        JButton bw = new JButton();
        _writeButtons.addElement(bw);

        // config read button as a dummy - there's really nothing to read
        JButton br = new JButton("Read"); // NOI18N
        _readButtons.addElement(br);

        // no CV references are added here
        // have to handle various value types, see "snippet"
        Attribute a;

        // set to default value if specified (CV load will later override this)
        int defaultVal = 0;
        if ((a = e.getAttribute("default")) != null) {
            String val = a.getValue();
            log.debug("Found default value: {} for {}", val, stdname);
            defaultVal = Integer.parseInt(val);
        }

        // create the specific object
        ConstantValue v = new ConstantValue(name, comment, "", true, true, false, false,
                "", mask, defaultVal, defaultVal,
                _cvModel.allCvMap(), _status, stdname);

        // record new variable, update state, hook up listeners
        rowVector.addElement(v);
        v.setState(AbstractValue.ValueState.FROMFILE);
        v.addPropertyChangeListener(this);

        // set to default value if specified (CV load will later override this)
        if ((a = e.getAttribute("default")) != null) {
            String val = a.getValue();
            log.debug("Found default value: {} for {}", val, name);
            v.setIntValue(defaultVal);
        }
    }

    /**
     * Programmatically create a new DecVariableValue from parameters.
     *
     * @param name      variable name.
     * @param CV        CV string.
     * @param comment   variable comment.
     * @param mask      CV mask.
     * @param readOnly  true if read only, else false.
     * @param infoOnly  true if information only, else false.
     * @param writeOnly true if write only, else false.
     * @param opsOnly   true if ops only, else false.
     */
    public void newDecVariableValue(String name, String CV, String comment, String mask,
            boolean readOnly, boolean infoOnly, boolean writeOnly, boolean opsOnly) {
        setFileDirty(true);

        int minVal = 0;
        int maxVal = 255;
        _cvModel.addCV("" + CV, readOnly, infoOnly, writeOnly);

        int row = getRowCount();

        // config write button
        JButton bw = new JButton(Bundle.getMessage("ButtonWrite"));
        bw.setActionCommand("W" + row);
        bw.addActionListener(this);
        _writeButtons.addElement(bw);

        // config read button
        JButton br = new JButton(Bundle.getMessage("ButtonRead"));
        br.setActionCommand("R" + row);
        br.addActionListener(this);
        _readButtons.addElement(br);

        VariableValue v = new DecVariableValue(name, comment, "", readOnly, infoOnly, writeOnly, opsOnly,
                CV, mask, minVal, maxVal, _cvModel.allCvMap(), _status, null);
        rowVector.addElement(v);
        v.addPropertyChangeListener(this);
    }

    @Override
    public void actionPerformed(ActionEvent e) {
        if (log.isDebugEnabled()) {
            log.debug("action performed,  command: {}", e.getActionCommand());
        }
        setFileDirty(true);
        char b = e.getActionCommand().charAt(0);
        int row = Integer.parseInt(e.getActionCommand().substring(1));
        log.debug("event on {} row {}", b, row);
        if (b == 'R') {
            // read command
            read(row);
        } else {
            // write command
            write(row);
        }
    }

    /**
     * Command reading of a particular variable.
     *
     * @param i row number
     */
    public void read(int i) {
        VariableValue v = rowVector.elementAt(i);
        v.readAll();
    }

    /**
     * Command writing of a particular variable.
     *
     * @param i row number
     */
    public void write(int i) {
        VariableValue v = rowVector.elementAt(i);
        v.writeAll();
    }

    @Override
    public void propertyChange(PropertyChangeEvent e) {
        if (log.isDebugEnabled()) {
            log.debug("prop changed {} new value: {}{} Source {}", e.getPropertyName(), e.getNewValue(), e.getPropertyName().equals("State") ? (" (" + ((AbstractValue.ValueState) e.getNewValue()).getName() + ") ") : " ", e.getSource());
        }
        if (e.getNewValue() == null) {
            log.error("new value of {} should not be null!", e.getPropertyName(), new Exception());
        }
        // set dirty only if edited or read
        if (e.getPropertyName().equals("State")
                && ((AbstractValue.ValueState) e.getNewValue()) == AbstractValue.ValueState.READ
                || e.getPropertyName().equals("State")
                && ((AbstractValue.ValueState) e.getNewValue()) == AbstractValue.ValueState.EDITED) {
            setFileDirty(true);

        }
        fireTableDataChanged();
    }

    public void configDone() {
        fireTableDataChanged();
    }

    /**
     * Represents any change to values, etc, hence rewriting the file is
     * desirable.
     *
     * @return true if dirty, else false.
     */
    public boolean fileDirty() {
        return _fileDirty;
    }

    public void setFileDirty(boolean b) {
        _fileDirty = b;
    }
    private boolean _fileDirty;

    /**
     * Check for change to values, etc, hence rewriting the decoder is
     * desirable.
     *
     * @return true if dirty, else false.
     */
    public boolean decoderDirty() {
        int len = rowVector.size();
        for (int i = 0; i < len; i++) {
            if (((rowVector.elementAt(i))).getState() == AbstractValue.ValueState.EDITED) {
                return true;
            }
        }
        return false;
    }

    /**
     * Returns the (first) variable that matches a given name string.
     * <p>
     * Searches first for "item", the true name, but if none found will attempt
     * to find a matching "label". In that case, only the default language is
     * checked.
     *
     * @param name search string.
     * @return first matching variable found.
     */
    public VariableValue findVar(String name) {
        for (int i = 0; i < getRowCount(); i++) {
            if (name.equals(getItem(i))) {
                log.trace("findVar matched '{}' by Item", name);
                return getVariable(i);
            }
        }
        for (int i = 0; i < getRowCount(); i++) {
            if (name.equals(getLabel(i))) {
                log.trace("findVar matched '{}' by Label rather than Item", name);
                return getVariable(i);
            }
        }
        log.debug("findVar did not match {}, returns null", name);
        return null;
    }

    /**
     * Returns the index of the first variable that matches a given name string.
     * <p>
     * Checks the search string against every variable's "item", the true name,
     * then against their "label" (default language only) and finally the
     * CV name before moving on to the next variable if none of those match.
     *
     * @param name search string.
     * @return index of the first matching variable found.
     */
    public int findVarIndex(String name) {
        return findVarIndex(name, false);
    }

    /**
     * Returns the index of a variable that matches a given name string.
     * <p>
     * Checks the search string against every variable's "item", the true name,
     * then against their "label" (default language only) and finally the
     * CV name before moving on to the next variable if none of those match.
     *
     * Depending on the second parameter, it will return the index of the first
     * or last variable in our internal rowVector that matches the given string.
     *
     * @param name search string.
     * @param searchFromEnd If true, will start searching from the end.
     * @return index of the first matching variable found.
     */
    public int findVarIndex(String name, boolean searchFromEnd) {
        if(searchFromEnd) {
            for (int i = getRowCount() - 1; i >= 0; i--) {
                if (name.equals(getItem(i))) {
                    return i;
                }
                if (name.equals(getLabel(i))) {
                    return i;
                }
                if (name.equals("CV" + getCvName(i))) {
                    return i;
                }
            }
        } else {
            for (int i = 0; i < getRowCount(); i++) {
                if (name.equals(getItem(i))) {
                    return i;
                }
                if (name.equals(getLabel(i))) {
                    return i;
                }
                if (name.equals("CV" + getCvName(i))) {
                    return i;
                }
            }
        }
        return -1;
    }

    public void dispose() {
        log.debug("dispose");

        // remove buttons
        for (int i = 0; i < _writeButtons.size(); i++) {
            _writeButtons.elementAt(i).removeActionListener(this);
        }
        for (int i = 0; i < _readButtons.size(); i++) {
            _readButtons.elementAt(i).removeActionListener(this);
        }

        // remove variables listeners
        for (int i = 0; i < rowVector.size(); i++) {
            VariableValue v = rowVector.elementAt(i);
            v.removePropertyChangeListener(this);
            v.dispose();
        }

        headers = null;

        rowVector.removeAllElements();
        rowVector = null;

        _cvModel = null;

        _writeButtons.removeAllElements();
        _writeButtons = null;

        _readButtons.removeAllElements();
        _readButtons = null;

        _status = null;
    }

    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(VariableTableModel.class);

}