|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResultSet
The interface that defines the functionalities of a result set.
Method Summary | |
---|---|
void |
addMetaItem(java.lang.String name,
int docid,
java.lang.String value)
Adds a metadata value for a given document |
void |
addMetaItems(java.lang.String name,
java.lang.String[] values)
Adds the metadata values for all the documents in the result set. |
int[] |
getDocids()
Returns the documents ids after retrieval |
int |
getExactResultSize()
Returns the exact size of the result set. |
java.util.concurrent.locks.Lock |
getLock()
Returns the lock associated with the result set. |
java.lang.String |
getMetaItem(java.lang.String name,
int docid)
Gets a metadata value for a given document. |
java.lang.String[] |
getMetaItems(java.lang.String name)
Gets the metadata information for all documents. |
java.lang.String[] |
getMetaKeys()
Returns the names of the meta keys which this resultset has |
short[] |
getOccurrences()
Returns the occurrences array. |
ResultSet |
getResultSet(int[] list)
Extracts a subset of the resultset given by the list parameter, which contains a list of positions in the resultset that should be saved. |
ResultSet |
getResultSet(int start,
int length)
Crops the existing result file and extracts a subset from the given starting point, with the given length. |
int |
getResultSize()
Returns the effective size of the result set. |
double[] |
getScores()
Returns the documents scores after retrieval |
int |
getStatusCode()
Returns a status code for the result set |
boolean |
hasMetaItems(java.lang.String name)
Returns true if the resultset already has a set of metaitems with the specified name. |
void |
initialise()
Initialises the arrays prior of retrieval. |
void |
initialise(double[] scs)
Initialises the result set with the given scores. |
void |
setExactResultSize(int newExactResultSize)
Sets the exact size of the result set, that is the number of documents that contain at least one query term. |
void |
setResultSize(int newResultSize)
Sets the effective size of the result set, that is the number of documents to be sorted after retrieval. |
void |
setStatusCode(int _statusCode)
Sets the status code. |
Method Detail |
---|
java.lang.String[] getMetaKeys()
void addMetaItem(java.lang.String name, int docid, java.lang.String value)
name
- the name of the metadata type. For example, it can be url for adding the URLs of documents.docid
- the document identifier of the document.value
- the metadata value.void addMetaItems(java.lang.String name, java.lang.String[] values)
name
- the name of the metadata type. For example, it can be url for adding the URLs of documents.values
- the metadata values.boolean hasMetaItems(java.lang.String name)
name
- of the desired metaitem set
int[] getDocids()
int getExactResultSize()
java.lang.String getMetaItem(java.lang.String name, int docid)
name
- the name of the metadata type.docid
- the document identifier of the document.
java.lang.String[] getMetaItems(java.lang.String name)
name
- the name of the metadata type.
short[] getOccurrences()
int getResultSize()
double[] getScores()
void initialise()
void initialise(double[] scs)
scs
- double[] the scores to initiliase the result set with.void setExactResultSize(int newExactResultSize)
newExactResultSize
- int the effective size of the result set.void setResultSize(int newResultSize)
newResultSize
- int the effective size of the result set.ResultSet getResultSet(int start, int length)
start
- the beginning of the subset.length
- the length of the subset.
ResultSet getResultSet(int[] list)
list
- the list of elements in the current list that should be kept.
java.util.concurrent.locks.Lock getLock()
int getStatusCode()
void setStatusCode(int _statusCode)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |