com.attivio.sdk.search

Class SearchDocumentList

java.lang.Object

com.attivio.sdk.search.SearchDocumentList

All Implemented Interfaces:

Externalizable, Serializable, Iterable<SearchDocument>

public class SearchDocumentList
extends Object
implements Iterable<SearchDocument>, Externalizable

A list of SearchDocuments returned for a query.

The size of the list will be less than or equal to the number of rows requested via QueryRequest.setRows(long).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchDocumentList() The default constructor
SearchDocumentList(int initialSize) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(SearchDocument value)
void	clear()
boolean	containsDocument(String docID) Tells whether this document list contains a given document based on document ID.
boolean	equals(Object other)
SearchDocument	get(int index)
SearchDocument	getDocument(String id) Gets a document from this list by ID.
float	getMaxScore() Get the maximum score across all matching documents.
long	getNumberFound()
long	getOffset() Get the offset that into the overall result set for the first document in this SearchDocumentList.
int	hashCode()
Iterator<SearchDocument>	iterator()
void	readExternal(ObjectInput in)
void	setMaxScore(float value)
void	setNumberFound(long nf)
void	setOffset(long value) Set the offset that into the overall result set for the first document in this SearchDocumentList.
int	size()
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SearchDocumentList

public SearchDocumentList()

The default constructor

SearchDocumentList

public SearchDocumentList(int initialSize)

Constructor

Parameters:

initialSize - the initial size

Method Detail

getOffset

public long getOffset()

Get the offset that into the overall result set for the first document in this SearchDocumentList.

setOffset

public void setOffset(long value)

Set the offset that into the overall result set for the first document in this SearchDocumentList.

getNumberFound

public long getNumberFound()

setNumberFound

public void setNumberFound(long nf)

setMaxScore

public void setMaxScore(float value)

size

public int size()

get

public SearchDocument get(int index)

iterator

public Iterator<SearchDocument> iterator()

Specified by:

iterator in interface Iterable<SearchDocument>

add

public void add(SearchDocument value)

clear

public void clear()

getMaxScore

public float getMaxScore()

Get the maximum score across all matching documents.

NOTE: this will be 0.0 if the result is not orderd by score and document scores are not requested. Adding FieldNames.SCORE field to QueryRequest will force computation of max score.

containsDocument

public boolean containsDocument(String docID)

Tells whether this document list contains a given document based on document ID.

Parameters:

docID - the document ID

Returns:

true if the list contains a document with the specified ID

getDocument

public SearchDocument getDocument(String id)

Gets a document from this list by ID.

Parameters:

id - the ID to look for

Returns:

the document or null if not in this list

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException