package com.google.code.joto.eventrecorder;

import java.io.Serializable;
import java.util.List;

import com.google.code.joto.eventrecorder.writer.RecordEventWriter;

/**
 *
 */
public interface RecordEventStore {

	/** Factory pattern for RecordEventStore */
	public static interface RecordEventStoreFactory extends Serializable {
		public RecordEventStore create();
	}
	
	/**
	 * @param mode one of "ra" (default = read+append), 
	 *  "rw" (read+append after initial clear file),
	 *  "r"  (readonly) 
	 */
	public void open(String mode);
	public void close();
	public void flush();

	public int getEventsCount();
	public int getFirstEventId();
	public int getLastEventId();
	
	public int getFirstEventIdWithMaxCount(int maxCount);
	
	/**
	 * get the event with summary "light" info ... no data is returned here!
	 * @param fromEventId
	 * @param toEventId (exclusive), can use -1 for last event  
	 * @return
	 */
	public List<RecordEventSummary> getEvents(int fromEventId, int toEventId);
	
	/**
	 * get the "heavy" info for a light event
	 * ... the real serializable data is returned here!
	 * @param event
	 * @return
	 */
	public RecordEventData getEventData(RecordEventSummary event);

	
	/**
	 * purge events history from beginning to <code>toEventId</code>
	 * @param toEventId, can use -1 for purge until last event
	 */
	public void purgeEvents(int toEventId);

	/**
	 * @return RecordEventWriter interface adapter for this eventStore object 
	 */
	public RecordEventWriter getEventWriter();
	
	/**
	 * @return Asynchronous RecordEventWriter interface adapter for this eventStore object
	 */
	public RecordEventWriter getAsyncEventWriter();
	
	/**
	 * SPI to add a new stored event
	 * You should typically call this only from helper class RecordEventWriter,
	 * which can offer simpler api methods, and can be chained with filtering and async support classes. 
	 */
	public RecordEventData addEvent(RecordEventSummary eventInfo, Serializable objData);

	/**
	 * synchronized method to call <code>addRecordEventListener(listener) + getEvents(fromEventId, -1)</code> 
	 * This is usefull to retrieve events from past, and synchronize with present 
	 * ... without having to removed duplicates
	 * @param fromEventId
	 * @param listener 
	 */
	public void getEventsAndAddEventListener(int fromEventId, RecordEventListener listener);

	public void addRecordEventListener(RecordEventListener listener);
	public void removeRecordEventListener(RecordEventListener listener);
	
}