com.mindtree.techworks.insight.eventsearch
Class SearchResults

java.lang.Object
  extended by com.mindtree.techworks.insight.eventsearch.SearchResults
All Implemented Interfaces:
java.io.Serializable

public class SearchResults
extends java.lang.Object
implements java.io.Serializable

This object holds the results of an event search operation.

Version:
$Revision: 27 $ $Date: 2007-12-16 04:58:03 -0700 (Sun, 16 Dec 2007) $
Author:
Bindul Bhowmik
See Also:
EventSearchProvider, Serialized Form

Constructor Summary
SearchResults(Controller controller, SearchCriteria searchCriteria, EventDetailsPresentation eventDetailsPresentation)
          Public constructor.
 
Method Summary
 void addMatcingLogEvent(MatchingLogEvent matchingLogEvent)
          Add a Matching log event to the collection
 int getCountOfMatchingLogEvents()
          Returns the number of matching log events.
 int getCurrentMatchingLogEventIndex()
          The current matching index displayed
 java.util.List getMatchedEventsForPage(int pageNumber)
          Returns a list of all matching events for a page.
 MatchingLogEvent getNextMatchingLogEvent()
          Retuns the next matching log event
 MatchingLogEvent getPrevMatchingLogEvent()
          Returns the previous matching log event
 SearchCriteria getSearchCriteria()
          Get the search criteria which created this search result
 void navigate(java.lang.String direction)
          Moves the focus to the matching search event
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchResults

public SearchResults(Controller controller,
                     SearchCriteria searchCriteria,
                     EventDetailsPresentation eventDetailsPresentation)
Public constructor.

Parameters:
controller - The controller instance
searchCriteria - The search criteria which created this search result
eventDetailsPresentation - The event details presentation used for highlighting
Method Detail

getSearchCriteria

public SearchCriteria getSearchCriteria()
Get the search criteria which created this search result

Returns:
SearchCriteria instance for this class.

getCurrentMatchingLogEventIndex

public int getCurrentMatchingLogEventIndex()
The current matching index displayed

Returns:
The current matching index displayed

getCountOfMatchingLogEvents

public int getCountOfMatchingLogEvents()
Returns the number of matching log events.

Returns:
The number of matching log events.

addMatcingLogEvent

public void addMatcingLogEvent(MatchingLogEvent matchingLogEvent)
Add a Matching log event to the collection

Parameters:
matchingLogEvent - MatchingLogEvent instance.

getNextMatchingLogEvent

public MatchingLogEvent getNextMatchingLogEvent()
Retuns the next matching log event

Returns:
The next matching log event

getPrevMatchingLogEvent

public MatchingLogEvent getPrevMatchingLogEvent()
Returns the previous matching log event

Returns:
The previous matching log event

getMatchedEventsForPage

public java.util.List getMatchedEventsForPage(int pageNumber)
Returns a list of all matching events for a page.

Parameters:
pageNumber - Page number for which events are required.
Returns:
a List of all matching events for a page.

navigate

public void navigate(java.lang.String direction)
Moves the focus to the matching search event

Parameters:
direction - The direction to move to.


Copyright © 2003-2008 MindTree Consulting Ltd.. All Rights Reserved.