org.kairosdb.client.builder.Aggregator Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 Proofpoint Inc.
 *
 *    Licensed 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 org.kairosdb.client.builder;

import static org.kairosdb.client.util.Preconditions.checkNotNullOrEmpty;

/**
 * An aggregator manipulates data points. For example, a sum aggregator would add data points together.
 */
public abstract class Aggregator
{
	private String name;

	protected Aggregator(String name)
	{
		this.name = checkNotNullOrEmpty(name);
	}

	/**
	 * Returns the aggregator's name.
	 * @return aggregator name
	 */
	public String getName()
	{
		return name;
	}

	// todo add align_sampling - aligns to the next biggest unit base on the unit
}