/**
 * Helios, OpenSource Monitoring
 * Brought to you by the Helios Development Group
 *
 * Copyright 2007, Helios Development Group and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This 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 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org. 
 *
 */
package org.helios.apmrouter.destination.chronicletimeseries;

import java.util.Date;

/**
 * <p>Title: ChronicleTierMXBean</p>
 * <p>Description: MXBean interface for ChronicleTier JMX management interface.</p> 
 * <p>Company: Helios Development Group LLC</p>
 * @author Whitehead (nwhitehead AT heliosdev DOT org)
 * <p><code>org.helios.apmrouter.destination.chronicletimeseries.ChronicleTierMXBean</code></p>
 */

public interface ChronicleTierMXBean {
	/**
	 * Returns the name of this chronicle tier
	 * @return the name of this chronicle tier
	 */
	public String getName();
	
	/**
	 * Returns the size of this chronicle tier
	 * @return the size of this chronicle tier
	 */
	public long getSize();
	
	/**
	 * Clears the chronicle
	 */
	public void clear();

	/**
	 * Closes the chronicle
	 */
	public void close();
	
	/**
	 * Returns the chronicle path 
	 * @return the chroniclePath
	 */
	public String getChroniclePath();	
	
	/**
	 * Returns the earliest period end timestamp in this tier
	 * @return the earliest period end timestamp in this tier
	 */
	public Date getStartPeriod();

	/**
	 * Returns the latest period end timestamp in this tier
	 * @return the latest period end timestamp in this tier
	 */
	public Date getEndPeriod();
	
	/**
	 * Returns the size of the index data file
	 * @return the size of the index data file
	 */
	public long getIndexSize();
	
	/**
	 * Returns the size of the data file
	 * @return the size of the data file
	 */
	public long getDataSize();
	
	/**
	 * Dumps a formatted output of the excerpt at the passed index
	 * @param index The index to dump
	 * @param includePeriods Defines if the dump should include period data
	 * @return A formatted string
	 */
	public String dump(long index, boolean includePeriods);
	
	/**
	 * Returns the tier definition pattern
	 * @return the tier definition pattern
	 */
	public String getPattern();
	
	/**
	 * Returns the number of periods in this tier
	 * @return the number of periods in this tier
	 */	
	public int getPeriodCount();
	
	/**
	 * Returns the period duration in seconds for this tier
	 * @return the period duration in seconds for this tier
	 */
	public long getPeriodDuration();	
	
	/**
	 * Returns the period duration in ms for this tier
	 * @return the period duration in ms for this tier
	 */
	public long getPeriodDurationMs();	
	
	/**
	 * Returns the series for the passed metric ID
	 * @param metricId The metric ID to get the series for
	 * @return the series pojo
	 */
	public SeriesEntryMBean getSeries(long metricId);
	
	/**
	 * Returns the storage byte size of the data segment for one metric
	 * @return the storage byte size of the data segment for one metric
	 */
	public long getPerMetricDataSize();

	/**
	 * Returns the storage byte size of the full segment for one metric
	 * @return the storage byte size of the full segment for one metric
	 */
	public long getPerMetricSize();
	
	/**
	 * Returns the entry status name for the passed metric Id
	 * @param metricId The metric Id to get the status for
	 * @return the entry status name
	 */
	public String getEntryStatusName(long metricId);
	
	/**
	 * Returns the total number of metric offline notifications received.
	 * @return the total number of metric offline notifications received.
	 */
	public long getOffLineNotificationCount();	
	
	
}