/*
    * $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.eventsearch;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import com.mindtree.techworks.insight.Controller;
  import com.mindtree.techworks.insight.InsightConstants;
  import com.mindtree.techworks.insight.gui.EventDetailsPresentation;
  import com.mindtree.techworks.insight.gui.widgets.StatusBar;
  
  
  /**
   * This object holds the results of an event search operation.
   * 
   * @see com.mindtree.techworks.insight.eventsearch.EventSearchProvider EventSearchProvider
   * @author Bindul Bhowmik
   * @version $Revision: 27 $ $Date: 2007-12-16 04:58:03 -0700 (Sun, 16 Dec 2007) $
   */
  public class SearchResults implements Serializable {
  
  	/**
  	 * Used for object serialization
  	 */
  	private static final long serialVersionUID = 2164352117429657476L;
  	
  	//
  	// Member variables
  	//
  
  	/**
  	 * The log event model of which it is a part of
  	 */
  	private Controller controller;
  
  	/**
  	 * The EventDetailsPresentation whose contents will be searched
  	 */
  	private EventDetailsPresentation eventDetailsPresentation;
  
  	/**
  	 * The search criteria which created this search result
  	 */
  	private SearchCriteria searchCriteria;
  
  	/**
  	 * List of matching log events.
  	 */
  	private List matchingLogEvents;
  
  	/**
  	 * Stores the list of matching events in a page.
  	 */
  	private Map pagedMatchingLogEvents;
  
  	/**
  	 * Index of the current accessed matching log event.
  	 */
  	private int currentMatchingLogEventIndex = -1;
  
  	//
  	// Constructors
  	//
  
  	/**
  	 * Public constructor.
  	 * 
  	 * @param controller The controller instance
  	 * @param searchCriteria The search criteria which created this search
  	 *            result
  	 * @param eventDetailsPresentation The event details presentation used for
  	 *            highlighting
  	 */
 	public SearchResults (Controller controller, SearchCriteria searchCriteria,
 			EventDetailsPresentation eventDetailsPresentation) {
 
 		this.controller = controller;
 		this.searchCriteria = searchCriteria;
 		this.eventDetailsPresentation = eventDetailsPresentation;
 		this.matchingLogEvents = new ArrayList();
 		this.pagedMatchingLogEvents = new HashMap();
 	}
 
 	//
 	// Accessors
 	//
 
 	/**
 	 * Get the search criteria which created this search result
 	 * 
 	 * @return <code>SearchCriteria</code> instance for this class.
 	 */
 	public SearchCriteria getSearchCriteria () {
 
 		return this.searchCriteria;
 	}
 
 	/**
 	 * The current matching index displayed
 	 * 
 	 * @return The current matching index displayed
 	 */
 	public int getCurrentMatchingLogEventIndex () {
 
 		return currentMatchingLogEventIndex;
 	}
 
 	/**
 	 * Returns the number of matching log events.
 	 * 
 	 * @return The number of matching log events.
 	 */
 	public int getCountOfMatchingLogEvents () {
 
 		return matchingLogEvents.size();
 	}
 
 	/**
 	 * Add a Matching log event to the collection
 	 * 
 	 * @param matchingLogEvent MatchingLogEvent instance.
 	 */
 	public void addMatcingLogEvent (MatchingLogEvent matchingLogEvent) {
 
 		this.matchingLogEvents.add(matchingLogEvent);
 
 		// Put in the per page cache.
 		Long pageNum = new Long(matchingLogEvent.getPageNumber());
 		List pageList = null;
 		if (this.pagedMatchingLogEvents.containsKey(pageNum)) {
 			pageList = (List) this.pagedMatchingLogEvents.get(pageNum);
 		} else {
 			pageList = new ArrayList();
 			this.pagedMatchingLogEvents.put(pageNum, pageList);
 		}
 		pageList.add(matchingLogEvent);
 	}
 
 	/**
 	 * Retuns the next matching log event
 	 * 
 	 * @return The next matching log event
 	 */
 	public MatchingLogEvent getNextMatchingLogEvent () {
 
 		if ((currentMatchingLogEventIndex + 1) < matchingLogEvents.size()) {
 			return (MatchingLogEvent) matchingLogEvents
 					.get(++currentMatchingLogEventIndex);
 		} else {
 			return null;
 		}
 	}
 
 	/**
 	 * Returns the previous matching log event
 	 * 
 	 * @return The previous matching log event
 	 */
 	public MatchingLogEvent getPrevMatchingLogEvent () {
 
 		if ((currentMatchingLogEventIndex - 1) >= 0) {
 			return (MatchingLogEvent) matchingLogEvents
 					.get(--currentMatchingLogEventIndex);
 		} else {
 			return null;
 		}
 	}
 
 	/**
 	 * Returns a list of all matching events for a page.
 	 * 
 	 * @param pageNumber Page number for which events are required.
 	 * @return a <code>List</code> of all matching events for a page.
 	 */
 	public List getMatchedEventsForPage (int pageNumber) {
 
 		return (List) this.pagedMatchingLogEvents.get(new Long(pageNumber));
 	}
 
 	//
 	// Navigation
 	//
 
 	/**
 	 * Moves the focus to the matching search event
 	 * 
 	 * @param direction The direction to move to.
 	 */
 	public void navigate (String direction) {
 
 		MatchingLogEvent matchingLogEvent = null;
 		if (direction.equals(InsightConstants.getLiteral("FIRST_SEARCH_MATCH"))) {
 			if (matchingLogEvents.size() > 0) {
 				matchingLogEvent = (MatchingLogEvent) matchingLogEvents.get(0);
 				currentMatchingLogEventIndex = 0;
 			}
 		} else if (direction.equals(InsightConstants
 				.getLiteral("PREV_SEARCH_MATCH"))) {
 			matchingLogEvent = getPrevMatchingLogEvent();
 		} else if (direction.equals(InsightConstants
 				.getLiteral("NEXT_SEARCH_MATCH"))) {
 			matchingLogEvent = getNextMatchingLogEvent();
 		}
 
 		if (null != matchingLogEvent) {
 			controller.setSelectedEvent(matchingLogEvent.getPageNumber(),
 					matchingLogEvent.getEventSequenceNumber());
 			this.eventDetailsPresentation.highlightText(this.searchCriteria
 					.getSearchString(), this.searchCriteria.getSearchType());
 		} else {
 			StatusBar.getInstance().setDisplayText(0,
 					InsightConstants.getLiteral("NO_NAVIGATE"), false);
 		}
 	}
 
 }