com.googlecode.gflot.client.options.PointsSeriesOptions.java Source code

Introduction

Here is the source code for com.googlecode.gflot.client.options.PointsSeriesOptions.java

Source

/*
 * Copyright (c) 2012 Nicolas Morel
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package com.googlecode.gflot.client.options;

import com.google.gwt.core.client.JavaScriptObject;
import com.googlecode.gflot.client.options.errorbars.ErrorBarsOptions;

/**
 * @author AlexanderDeleon
 */
public class PointsSeriesOptions extends AbstractBasicSeriesOptions<PointsSeriesOptions> {
    public enum PointSymbol {
        CIRCLE("circle"), SQUARE("square"), DIAMOND("diamond"), TRIANGLE("triangle"), CROSS("cross");

        static PointSymbol findByFlotValue(String flotValue) {
            if (null != flotValue && !"".equals(flotValue)) {
                for (PointSymbol mode : values()) {
                    if (mode.getFlotValue().equals(flotValue)) {
                        return mode;
                    }
                }
            }
            return null;
        }

        private String flotValue;

        PointSymbol(String flotValue) {
            this.flotValue = flotValue;
        }

        String getFlotValue() {
            return flotValue;
        }
    }

    public enum ErrorBarsMode {
        X("x"), Y("y"), XY("xy");

        static ErrorBarsMode findByFlotValue(String flotValue) {
            if (null != flotValue && !"".equals(flotValue)) {
                for (ErrorBarsMode mode : values()) {
                    if (mode.getFlotValue().equals(flotValue)) {
                        return mode;
                    }
                }
            }
            return null;
        }

        private String flotValue;

        ErrorBarsMode(String flotValue) {
            this.flotValue = flotValue;
        }

        String getFlotValue() {
            return flotValue;
        }
    }

    private static final String RADIUS_KEY = "radius";
    private static final String SYMBOL_KEY = "symbol";
    private static final String ERROR_BARS_KEY = "errorbars";
    private static final String XERR_KEY = "xerr";
    private static final String YERR_KEY = "yerr";

    /**
     * Creates a {@link PointsSeriesOptions}
     */
    public static final PointsSeriesOptions create() {
        return JavaScriptObject.createObject().cast();
    }

    protected PointsSeriesOptions() {
    }

    /**
     * Set the radius of the symbol
     */
    public final PointsSeriesOptions setRadius(double radius) {
        put(RADIUS_KEY, radius);
        return this;
    }

    /**
     * @return the radius of the symbol
     */
    public final Double getRadius() {
        return getDouble(RADIUS_KEY);
    }

    /**
     * Clear the radius of the symbol
     */
    public final PointsSeriesOptions clearRadius() {
        clear(RADIUS_KEY);
        return this;
    }

    /**
     * Set the symbol to represents the points
     */
    public final PointsSeriesOptions setSymbol(PointSymbol symbol) {
        assert null != symbol : "symbol can't be null";

        put(SYMBOL_KEY, symbol.getFlotValue());
        return this;
    }

    /**
     * @return the symbol to represents the points
     */
    public final PointSymbol getSymbol() {
        return PointSymbol.findByFlotValue(getString(SYMBOL_KEY));
    }

    /**
     * Clear the symbol
     */
    public final PointsSeriesOptions clearSymbol() {
        clear(SYMBOL_KEY);
        return this;
    }

    /**
     * Set the error bars mode to use
     */
    public final PointsSeriesOptions setErrorBars(ErrorBarsMode mode) {
        assert null != mode : "mode can't be null";

        put(ERROR_BARS_KEY, mode.getFlotValue());
        return this;
    }

    /**
     * @return the error bars mode
     */
    public final ErrorBarsMode getErrorBars() {
        return ErrorBarsMode.findByFlotValue(getString(ERROR_BARS_KEY));
    }

    /**
     * Clear the error bars mode
     */
    public final PointsSeriesOptions clearErrorBars() {
        clear(ERROR_BARS_KEY);
        return this;
    }

    /**
     * Set the xerr options
     */
    public final PointsSeriesOptions setXErrOptions(ErrorBarsOptions xerr) {
        put(XERR_KEY, xerr);
        return this;
    }

    /**
     * @return the xerr options
     */
    public final ErrorBarsOptions getXErrOptions() {
        return getJsObject(XERR_KEY);
    }

    /**
     * Clear the xerr options
     */
    public final PointsSeriesOptions clearXErrOptions() {
        clear(XERR_KEY);
        return this;
    }

    /**
     * Set the yerr options
     */
    public final PointsSeriesOptions setYErrOptions(ErrorBarsOptions yerr) {
        put(YERR_KEY, yerr);
        return this;
    }

    /**
     * @return the yerr options
     */
    public final ErrorBarsOptions getYErrOptions() {
        return getJsObject(YERR_KEY);
    }

    /**
     * Clear the yerr options
     */
    public final PointsSeriesOptions clearYErrOptions() {
        clear(YERR_KEY);
        return this;
    }

}