BaseMatching.MatchingState (Terrier Information Retrieval Platform 5.5 API)

java.lang.Object
- org.terrier.matching.BaseMatching.MatchingState

Enclosing class:: BaseMatching

protected static class BaseMatching.MatchingState
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field	Description
`int`	`numberOfRequestedDocuments`	The number of documents that are requested to be retrieved for this query.
`int`	`numberOfRetrievedDocuments`	The number of actually retrieved documents for this query.
`MatchingQueryTerms`	`queryTerms`	input query to matching
`ResultSet`	`resultSet`	The result set.
`long`	`totalTime`

Constructor Summary

Constructors
Modifier Constructor Description

protected MatchingState()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`long`	`getTotalTime()`	get the total time
`void`	`updateEndTime(long t)`	Update the end time.
`void`	`updateStartTime(long t)`	Update the start time

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - queryTerms
```
public MatchingQueryTerms queryTerms
```
    input query to matching
  - resultSet
```
public ResultSet resultSet
```
    The result set.
  - numberOfRequestedDocuments
```
public int numberOfRequestedDocuments
```
    The number of documents that are requested to be retrieved for this query.
  - numberOfRetrievedDocuments
```
public int numberOfRetrievedDocuments
```
    The number of actually retrieved documents for this query.
  - totalTime
```
public long totalTime
```
- Constructor Detail
  - MatchingState
```
protected MatchingState()
```
- Method Detail
  - updateStartTime
```
public void updateStartTime(long t)
```
    Update the start time
    
    Parameters:
    
    t -
  - updateEndTime
```
public void updateEndTime(long t)
```
    Update the end time.
    
    Parameters:
    
    t -
  - getTotalTime
```
public long getTotalTime()
```
    get the total time
    
    Returns:
    
    long