DataStatisticsStore.java

package mil.nga.giat.geowave.core.store.adapter.statistics;

import mil.nga.giat.geowave.core.index.ByteArrayId;
import mil.nga.giat.geowave.core.store.CloseableIterator;

/**
 * This is responsible for persisting data statistics (either in memory or to
 * disk depending on the implementation).
 */
public interface DataStatisticsStore
{
	/**
	 * This will write the statistics to the underlying store. Note that this
	 * will overwrite whatever the current persisted statistics are with the
	 * given statistics ID and data adapter ID. Use incorporateStatistics to
	 * aggregate the statistics with any existing statistics.
	 * 
	 * @param statistics
	 *            The statistics to write
	 * 
	 */
	public void setStatistics(
			DataStatistics<?> statistics );

	/**
	 * Add the statistics to the store, overwriting existing data statistics
	 * with the aggregation of these statistics and the existing statistics
	 * 
	 * @param statistics
	 *            the data statistics
	 */
	public void incorporateStatistics(
			DataStatistics<?> statistics );

	/**
	 * Get all data statistics from the store by a data adapter ID
	 * 
	 * @param adapterId
	 *            the data adapter ID
	 * @return the list of statistics for the given adapter, empty if it doesn't
	 *         exist
	 */
	public CloseableIterator<DataStatistics<?>> getDataStatistics(
			ByteArrayId adapterId,
			String... authorizations );

	/**
	 * Get all data statistics from the store
	 * 
	 * @return the list of all statistics
	 */
	public CloseableIterator<DataStatistics<?>> getAllDataStatistics(
			String... authorizations );

	/**
	 * Get statistics by adapter ID and the statistics ID (which will define a
	 * unique statistic)
	 * 
	 * @param adapterId
	 *            The adapter ID for the requested statistics
	 * @param statisticsId
	 *            the statistics ID for the requested statistics
	 * @return the persisted statistics value
	 */
	public DataStatistics<?> getDataStatistics(
			ByteArrayId adapterId,
			ByteArrayId statisticsId,
			String... authorizations );

	/**
	 * Remove a statistic from the store
	 * 
	 * @param adapterId
	 * @param statisticsId
	 * @return a flag indicating whether a statistic had existed with the given
	 *         IDs and was successfully deleted.
	 */
	public boolean removeStatistics(
			ByteArrayId adapterId,
			ByteArrayId statisticsId,
			String... authorizations );

	/**
	 * Remove all statistics with a given adapter ID from the store
	 * 
	 * @param adapterId
	 */
	public void removeAllStatistics(
			ByteArrayId adapterId,
			String... authorizations );

	/**
	 * Transform visibility for the data statistics - * + *
	 * 
	 * @param adapterId
	 */
	public void transformVisibility(
			final ByteArrayId adapterId,
			final String transformingRegex,
			final String replacement,
			final String... authorizations );

	public void removeAll();
}