com.googlecode.wicket.kendo.ui.dataviz.chart.series.BarSeries Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 com.googlecode.wicket.kendo.ui.dataviz.chart.series;

/**
 * Provides a {@value #TYPE} series object
 *
 * @author Sebastien Briquet - sebfz1
 *
 */
public class BarSeries extends Series implements IStackable
{
	private static final long serialVersionUID = 1L;
	private static final String TYPE = "bar";

	private final String field;
	private Object stack = null;

	/**
	 * Constructor
	 * 
	 * @param name the series name
	 * @param field the series field, it should correspond to a model object's property
	 */
	public BarSeries(String name, String field)
	{
		super(name, TYPE);

		this.field = field;
	}

	/**
	 * Constructor
	 * 
	 * @param name the series name
	 * @param field the series field, it should correspond to a model object's property
	 * @param axis the axis on which the series should be placed
	 */
	public BarSeries(String name, String field, String axis)
	{
		super(name, TYPE, axis);

		this.field = field;
	}

	/**
	 * Gets the series field
	 * 
	 * @return the series field
	 */
	public String getField()
	{
		return this.field;
	}

	/**
	 * Gets the stack the series belongs to
	 * 
	 * @return the stack
	 */
	@Override
	public Object getStack()
	{
		return this.stack;
	}

	/**
	 * Sets the stack the series belongs to
	 * 
	 * @param stack the stack
	 * @return this, for chaining
	 */
	public BarSeries setStack(Object stack)
	{
		this.stack = stack;

		return this;
	}
}