/*
    * $HeadURL: $
    * $Date: $
    * $Revision: $
    * $Author: $
    * 
    * Copyright (c) 2005 MindTree Consulting Ltd. 
    * 
    * This file is part of Insight.
   * 
   * Insight is free software: you can redistribute it and/or modify it under the 
   * terms of the GNU General Public License as published by the Free Software 
   * Foundation, either version 3 of the License, or (at your option) any later 
   * version.
   * 
   * Insight 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 General 
   * Public License for more details.
   * 
   * You should have received a copy of the GNU General Public License along with 
   * Insight.  If not, see <http://www.gnu.org/licenses/>.
   */
  
  package com.mindtree.techworks.insight.model;
  
  import java.io.Serializable;
  
  import com.mindtree.techworks.insight.Controller;
  import com.mindtree.techworks.insight.InsightConstants;
  import com.mindtree.techworks.insight.eventsearch.SearchResults;
  import com.mindtree.techworks.insight.filter.UniqueLogCriteria;
  import com.mindtree.techworks.insight.gui.widgets.StatusBar;
  import com.mindtree.techworks.insight.pagination.PageSet;
  import com.mindtree.techworks.insight.spi.LogEvent;
  
  /**
   * This is the model class for Insight that represents one Page
   * 
   * @author antonypulicken
   * @version $Revision: 27 $ $Date: 2007-12-16 04:58:03 -0700 (Sun, 16 Dec 2007) $
   * @see com.mindtree.techworks.insight.model.ILogEventModel ILogEventModel
   * @see com.mindtree.techworks.insight.spi.LogEvent LogEvent
   */
  public class LogEventModel implements ILogEventModel, Serializable {
  
  	/**
  	 * Used for object serialization
  	 */
  	private static final long serialVersionUID = -1474266642451017271L;
  
  	/**
  	 * PageSet instance
  	 */
  	protected PageSet pageSet;
  
  	/**
  	 * Controller instance
  	 */
  	protected Controller controller;
  
  	/**
  	 * Previous LogEventModel
  	 */
  	private LogEventModel previousLogEventModel;
  
  	/**
  	 * Unique criteria
  	 */
  	private UniqueLogCriteria uniqueLogCriteria;
  	
  	/**
  	 * Search Results if any are performed on this model.
  	 */
  	private SearchResults searchResults;
  
  	/**
  	 * log event index
  	 */
  	private long logEventIndex = -1;
  
  	/**
  	 * Count of events processed by this LogEventModel
  	 */
  	private long processedEventCount;
  
  	/**
  	 * Name of the LogEventModel
  	 */
  	private String logEventModelName;
  
  	/**
  	 * Constructor that initializes this LogEventModel
  	 * 
  	 * @param controller the Controller instance for this class
  	 */
  	public LogEventModel (Controller controller) {
  		this.controller = controller;
  		this.pageSet = new PageSet();
 		this.uniqueLogCriteria = new UniqueLogCriteria();
 	}
 
 	/**
 	 * Returns the PageSet instance
 	 * 
 	 * @return pageSet The PageSet instance
 	 */
 	public PageSet getPageSet () {
 		return this.pageSet;
 	}
 
 	/**
 	 * Clears the contents of this LogEventModel
 	 */
 	public void clear () {
 		this.pageSet.clear();
 		this.pageSet = null;
 		this.logEventIndex = -1;
 		this.processedEventCount = 0;
 		clearSearchResults();
 		this.uniqueLogCriteria.initialize();
 		StatusBar.getInstance().clearStatisticsDisplayText();
 	}
 
 
 	/**
 	 * This method is called when a new event is added to the model.
 	 * 
 	 * @param logEvent LogEvent log event.
 	 */
 	public void fireLogEventAdded (LogEvent logEvent) {
 		uniqueLogCriteria.add(logEvent);
 		this.processedEventCount += 1;
 		// inform the controller of events being added only if this model
 		// is the current one
 		if (this.controller.getCurrentLogEventModel() == this){
 			this.controller.notifyLogEventOccurred(logEvent);
 		} else {
 			// inform the Controller to simply update the status
 			this.controller.setStatus();
 		}
 	}
 
 	/**
 	 * Returns unique logged values for the supported filter criteria.
 	 * 
 	 * @return uniqueLogCriteria UniqueLogCriteria an object containing set of
 	 *         unique values for the supported filter criteria
 	 */
 	public UniqueLogCriteria getUniqueCriteria () {
 		return uniqueLogCriteria;
 	}
 
 	/**
 	 * Sets the previous LogEventModel
 	 * 
 	 * @param logEventModel The current LogEventModel
 	 */
 	public void setPreviousLogEventModel (LogEventModel logEventModel) {
 		this.previousLogEventModel = logEventModel;
 	}
 
 	/**
 	 * Returns the previous LogEventModel
 	 * 
 	 * @return previousLogEventModel
 	 */
 	public LogEventModel getPreviousLogEventModel () {
 		return this.previousLogEventModel;
 	}
 
 	/**
 	 * @param pageSet The pageSet to set.
 	 */
 	public void setPageSet (PageSet pageSet) {
 		this.pageSet = pageSet;
 	}
 
 	/**
 	 * @return Returns the logEventIndex.
 	 */
 	public long getLogEventIndex () {
 		return logEventIndex;
 	}
 
 	/**
 	 * @param logEventIndex The logEventIndex to set.
 	 */
 	public void setLogEventIndex (long logEventIndex) {
 		this.logEventIndex = logEventIndex;
 	}
 	
 	/**
 	 * @return Returns the logEventModelName.
 	 */
 	public String getLogEventModelName () {
 		return logEventModelName;
 	}
 
 	/**
 	 * @param logEventModelName The logEventModelName to set.
 	 */
 	public void setLogEventModelName (String logEventModelName) {
 		this.logEventModelName = logEventModelName;
 	}
 	
 	/**
 	 * Gets the status display text for this LogEventModel
 	 * @return the status display text
 	 */
 	public String getStatus() {
 		StringBuffer textToDisplay = new StringBuffer();
   	    String currPageCnt = String.valueOf(getPageSet().getCurrentPageCnt());
   	    String totPageCnt = String.valueOf(getPageSet().getTotalPageCnt());
   	    textToDisplay.append(getContext());
   	    textToDisplay.append(currPageCnt);
   	    textToDisplay.append(InsightConstants.PAGE_STATUS_SEPARATOR);
   	    textToDisplay.append(totPageCnt);
   	    if (getSearchResults() != null) {
   	    	SearchResults searchResults = getSearchResults();
   	    	textToDisplay.append(InsightConstants.SEARCH_RESULT_DISP_STATUS_START);
   	    	textToDisplay.append(InsightConstants.SEARCH_RESULT_DISP_STATUS);
   	    	textToDisplay.append(String.valueOf(searchResults.getCurrentMatchingLogEventIndex() + 1));
   	    	textToDisplay.append(InsightConstants.PAGE_STATUS_SEPARATOR);
   	    	textToDisplay.append(String.valueOf(searchResults.getCountOfMatchingLogEvents()));
   	    	textToDisplay.append(InsightConstants.SEARCH_RESULT_DISP_STATUS_END);
   	    }
   	    return textToDisplay.toString();
 	}
 
 	/**
 	 * @return Returns the processedEventCount.
 	 */
 	public long getProcessedEventCount () {
 		return processedEventCount;
 	}
 
 	/**
 	 * @param processedEventCount The processedEventCount to set.
 	 */
 	public void setProcessedEventCount (long processedEventCount) {
 		this.processedEventCount = processedEventCount;
 	}
 	
 	/**
 	 * @return Returns the searchResults.
 	 */
 	public SearchResults getSearchResults () {
 		return searchResults;
 	}
 	
 	/**
 	 * @param searchResults The searchResults to set.
 	 */
 	public void setSearchResults (SearchResults searchResults) {
 		this.searchResults = searchResults;
 	}
 
 	/**
 	 * Clears the search results associated with this log event model
 	 */
 	public void clearSearchResults () {
 		this.searchResults = null;		
 	}
 	
 	/**
 	 * Method for constructing the context text while displaying the status
 	 * @return context 
 	 */
 	private String getContext() {
 		LogEventModel logEventModel = this; 
 		String context = logEventModel.getLogEventModelName();		
 		while(true){		
 			if(logEventModel.getPreviousLogEventModel()!= null){
 				logEventModel = logEventModel.getPreviousLogEventModel();
 				context = logEventModel.getLogEventModelName() + InsightConstants.TEXT_SEPARATOR + context;
 			}else{
 				break;
 			}
 		}
 		return context + InsightConstants.TEXT_INDENT;
 	}
 	
 }