/* 
 * This code is part of Project Waterloo from King's College London
 * 
 *
 * Copyright King's College London  2011-
 * 
 * @author Malcolm Lidierth, King's College London  [Contact]
 * 
 * Project Waterloo is free software:  you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Project Waterloo is distributed in the hope that it will  be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 */
package kcl.waterloo.graphics.plots2D;

import java.util.ArrayList;
import java.util.Arrays;

/**
 * Object to support bar charts. For implementation details of how individual
 * fields will be interpreted, see the help for the implementing chart class.
 *
 * @author ML
 */
public class BarExtra extends FontSupport {

    /**
     * Orientation for the boxes.
     */
    public enum ORIENTATION {

        HORIZONTAL, VERTICAL
    }

    /**
     * For bar plots, indicates the display mode for multiplexed data.
     */
    public enum MODE {

        GROUPED, STACKED, HIST, HISTC
    }

    /**
     * Orientation for this instance. Default is BarExtra.ORIENTATION.VERTICAL.
     */
    private BarExtra.ORIENTATION orientation = BarExtra.ORIENTATION.VERTICAL;
    /**
     * Mode for this instance. Default is BarExtra.MODE.GROUPED.
     */
    private BarExtra.MODE mode = BarExtra.MODE.GROUPED;
    /**
     * Position of the baseline for bar plots in axes units.
     */
    private double baseValue = 0d;
    /**
     * Width of the bars in axes units. This value may be ignored when MODE is
     * HIST or HISTC.
     */
    private double barWidth = 1d;
    private ArrayList labels = new ArrayList();
    private ORIENTATION labelOrientation = ORIENTATION.HORIZONTAL;

    /**
     * Get the bar width in axes units.
     *
     * @return the barWidth
     */
    public double getBarWidth() {
        return barWidth;
    }

    /**
     * Set the bar width in axes units.
     *
     * @param barWidth the barWidth to set
     */
    public void setBarWidth(double barWidth) {
        this.barWidth = barWidth;
    }

    /**
     * @return the mode
     */
    public BarExtra.MODE getMode() {
        return mode;
    }

    /**
     * @param mode the mode to set
     */
    public void setMode(BarExtra.MODE mode) {
        this.mode = mode;
    }

    /**
     * Returns the orientation: BarExtra.ORIENTATION.HORIZONTAL or VERTICAL.
     *
     * @return the orientation
     */
    public BarExtra.ORIENTATION getOrientation() {
        return orientation;
    }

    /**
     * Sets the orientation: BarExtra.ORIENTATION.HORIZONTAL or VERTICAL.
     *
     * @param orientation the orientation to set
     */
    public void setOrientation(BarExtra.ORIENTATION orientation) {
        this.orientation = orientation;
    }

    /**
     * @return the baseValue
     */
    public double getBaseValue() {
        return baseValue;
    }

    /**
     * @param baseValue the baseValue to set
     */
    public void setBaseValue(double baseValue) {
        this.baseValue = baseValue;
    }

    /**
     * @return the labels
     */
    public ArrayList getLabels() {
        return labels;
    }

    /**
     * @param labels the labels to set
     */
    public void setLabels(ArrayList labels) {
        this.labels = labels;
    }

    public void setLabels(String[] labels) {
        ArrayList copy = new ArrayList();
        copy.addAll(Arrays.asList(labels));
        this.labels = copy;
    }

    /**
     * @return the labelOrientation
     */
    public ORIENTATION getLabelOrientation() {
        return labelOrientation;
    }

    /**
     * @param labelOrientation the labelOrientation to set
     */
    public void setLabelOrientation(ORIENTATION labelOrientation) {
        this.labelOrientation = labelOrientation;
    }

    public void setLabelOrientation(String s) {
        if (s.contains("VERT")) {
            labelOrientation = ORIENTATION.VERTICAL;
        } else {
            labelOrientation = ORIENTATION.HORIZONTAL;
        }
    }

}