com.primus.searchstudio
Class CategoryResultObjects

java.lang.Object
  com.primus.searchstudio.CategoryResultObjects

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Field Summary

protected java.util.ArrayList

categoryDocuments

Constructor Summary

CategoryResultObjects()

Method Summary

void	addCategoryDocument(CategoryDocument categoryDocument) Add a single result.
java.util.HashMap	getAnswerSourceCountMap()
CategoryDocument[]	getCategoryDocuments() Return an array of results.
CategoryDocument	getCategoryDocuments(int index) Get a single result.
java.lang.String	getDebugString()
java.util.HashMap	getDocFormatCountMap()
java.util.HashMap	getDocSetCountMap()
java.util.HashMap	getDocTitleCountMap()
int	getElapsedTime() Elapsed time for query to complete
CategoryDocument	getResultById(int id)
int	getSize() Return the number of results
int	hashCode() Standard hash code method.
void	setDebugString(java.lang.String ds)
void	setElapsedTime(int elapsedTime)
void	setGroupByCountMap(java.lang.String currentValue, java.util.HashMap currentGroupMap) Set the count for each group in a HashMap
void	setMaxResponseChars(int maxResponseChars) Loop through all Result objects and set the maxResponseChars for each
void	sortByDocScore()
void	sortByTimestamp()
java.lang.String	toString() Standard toString method.
java.lang.String	toSummaryString() Standard toString method, but returns summary of Result objects.

Methods inherited from class java.lang.Object

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

Field Detail

categoryDocuments

protected java.util.ArrayList categoryDocuments

Constructor Detail

CategoryResultObjects

public CategoryResultObjects()

Method Detail

getSize

public int getSize()

Return the number of results

Returns:

number of individual categoryDocuments available

getCategoryDocuments

public CategoryDocument[] getCategoryDocuments()

Return an array of results.

Returns:

an array of categoryDocuments

getCategoryDocuments

public CategoryDocument getCategoryDocuments(int index)
                                      throws java.lang.IndexOutOfBoundsException

Get a single result.

Parameters:

index - which result

Returns:

CategoryDocument object

Throws:

java.lang.IndexOutOfBoundsException

addCategoryDocument

public void addCategoryDocument(CategoryDocument categoryDocument)

Add a single result.

Parameters:

categoryDocument - single result to add

setMaxResponseChars

public void setMaxResponseChars(int maxResponseChars)

Loop through all Result objects and set the maxResponseChars for each

Parameters:

maxResponseChars -

toString

public java.lang.String toString()

Standard toString method.

Overrides:

toString in class java.lang.Object

Returns:

string representation of categoryDocuments

toSummaryString

public java.lang.String toSummaryString()

Standard toString method, but returns summary of Result objects. This makes for a more compact representation.

Returns:

string summary representation of categoryDocuments

hashCode

public int hashCode()

Standard hash code method.

Overrides:

hashCode in class java.lang.Object

setGroupByCountMap

public void setGroupByCountMap(java.lang.String currentValue,
                               java.util.HashMap currentGroupMap)

Set the count for each group in a HashMap

getResultById

public CategoryDocument getResultById(int id)

getDocFormatCountMap

public java.util.HashMap getDocFormatCountMap()

getDocSetCountMap

public java.util.HashMap getDocSetCountMap()

getDocTitleCountMap

public java.util.HashMap getDocTitleCountMap()

getAnswerSourceCountMap

public java.util.HashMap getAnswerSourceCountMap()

getDebugString

public java.lang.String getDebugString()

setDebugString

public void setDebugString(java.lang.String ds)

sortByDocScore

public void sortByDocScore()

sortByTimestamp

public void sortByTimestamp()

getElapsedTime

public int getElapsedTime()

Elapsed time for query to complete

Returns:

setElapsedTime

public void setElapsedTime(int elapsedTime)