View Javadoc

1   /*
2    * $HeadURL: $
3    * $Date: $
4    * $Revision: $
5    * $Author: $
6    * 
7    * Copyright (c) 2005 MindTree Consulting Ltd. 
8    * 
9    * This file is part of Insight.
10   * 
11   * Insight is free software: you can redistribute it and/or modify it under the 
12   * terms of the GNU General Public License as published by the Free Software 
13   * Foundation, either version 3 of the License, or (at your option) any later 
14   * version.
15   * 
16   * Insight is distributed in the hope that it will be useful, but 
17   * WITHOUT ANY WARRANTY; without even the implied warranty of 
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General 
19   * Public License for more details.
20   * 
21   * You should have received a copy of the GNU General Public License along with 
22   * Insight.  If not, see <http://www.gnu.org/licenses/>.
23   */
24  
25  package com.mindtree.techworks.insight.eventsearch;
26  
27  import java.io.Serializable;
28  
29  
30  /**
31   * Holds information about a single matched event.
32   * 
33   * @see com.mindtree.techworks.insight.eventsearch.SearchResults SearchResults
34   * 
35   * @author Bindul Bhowmik
36   * @version $Revision: 27 $ $Date: 2007-12-16 04:58:03 -0700 (Sun, 16 Dec 2007) $
37   * 
38   */
39  public class MatchingLogEvent implements Serializable {
40  	
41  	/**
42  	 * Used for object serialization
43  	 */
44  	private static final long serialVersionUID = -5828131920882531358L;
45  	
46  	//
47  	// Attributes
48  	//
49  
50  	/**
51  	 * Page number where the current event is located.
52  	 */
53  	private long pageNumber;
54  	
55  	/**
56  	 * The sequence number of the current event.
57  	 */
58  	private long eventSequenceNumber;
59  	
60  	//private int
61  	
62  	//
63  	// Constructor
64  	//
65  	
66  	/**
67  	 * Public constructor
68  	 * @param pageNumber The page where the matching event is located.
69  	 * @param eventSequenceNumber The sequence number of the event.
70  	 */
71  	public MatchingLogEvent(long pageNumber, long eventSequenceNumber) {
72  		this.pageNumber = pageNumber;
73  		this.eventSequenceNumber = eventSequenceNumber;
74  	}
75  	
76  	//
77  	// Accessors
78  	//
79  	
80  	/**
81  	 * @return Returns the pageNumber.
82  	 */
83  	public long getPageNumber () {
84  		return pageNumber;
85  	}
86  
87  	/**
88  	 * @return Event Sequence Number.
89  	 */
90  	public long getEventSequenceNumber() {
91  		return eventSequenceNumber;
92  	}
93  	//
94  	// Overridden methods
95  	//
96  	
97  	/**
98  	 * @see java.lang.Object#equals(java.lang.Object)
99  	 */
100 	public boolean equals (Object obj) {
101 
102 		if (obj instanceof MatchingLogEvent) {
103 			MatchingLogEvent object = (MatchingLogEvent) obj;
104 			if (object.pageNumber == this.pageNumber && object.getEventSequenceNumber() == this.eventSequenceNumber) {
105 				return true;
106 			} else {
107 				return false;
108 			}
109 		} else {
110 			return false;
111 		}
112 	}
113 }