BasicResultList (Sesat Kernel 2.19-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

no.sesat.search.result
Class BasicResultList<T extends ResultItem>

java.lang.Object
  no.sesat.search.result.BasicResultItem
      no.sesat.search.result.BasicResultList<T>


Type Parameters:: T - the type of ResultItem the ResultList contains.

All Implemented Interfaces:: Serializable, ResultItem, ResultList<T>

Direct Known Subclasses:: BasicNavigationItem, FacetedSearchResultImpl, OvertureSearchResult, PlatefoodSearchResult

public class BasicResultList<T extends ResultItem>
extends BasicResultItem
implements ResultList<T>
extends BasicResultItem
implements ResultList<T>

A simple implementation of a search result. Is not multi-thread safe. All fields (of all types) handled by superclass BasicSearchResultItem.

Version:: $Id: BasicResultList.java 7225 2009-04-09 00:32:20Z ssmiweve $
See Also:: Serialized Form

Constructor Summary
	`BasicResultList()` Plain constructor.
	`BasicResultList(ResultItem copy)` Copy constructor.
	`BasicResultList(ResultList<ResultItem> copy)` Copy constructor.
`protected`	`BasicResultList(String title, String url, int hitCount)`

Method Summary
`BasicResultList<T>`	`addField(String field, String value)` Adds the field to the returned instance which is otherwise equal to this.
`BasicResultList<T>`	`addObjectField(String field, Serializable value)` Adds the field to the returned instance which is otherwise equal to this.
`void`	`addQuerySuggestion(Suggestion query)`
`void`	`addRelevantQuery(WeightedSuggestion query)`
`void`	`addResult(T item)` Adds the result to the end of the current list of results.
`void`	`addResults(List<? extends T> items)` Appends the results to the end of the current list of results.
`void`	`addSpellingSuggestion(WeightedSuggestion suggestion)`
`BasicResultList<T>`	`addToMultivaluedField(String field, String value)` Adds (to the multivalued) field to the returned instance which is otherwise equal to this.
`int`	`getHitCount()` Get the hitcount.
`Collection<Suggestion>`	`getQuerySuggestions()`
`List<WeightedSuggestion>`	`getRelevantQueries()` Get the relevantQueries.
`List<T>`	`getResults()` Returns a defensive copy of the results.
`int`	`getResultsSize()` JavaBean compatability for JSPs.
`List<WeightedSuggestion>`	`getSpellingSuggestions()`
`Map<String,List<WeightedSuggestion>>`	`getSpellingSuggestionsMap()`
`void`	`removeResult(T item)` Remove the result from the current result list.
`void`	`removeResults()` Remove all results from the current result list.
`void`	`replaceResult(T original, T theNew)` Replace the original with theNew.
`void`	`setHitCount(int docCount)` Set the hitcount.
`void`	`sortResults(Comparator comparator)` Sorts the results according to the order induced by the specified comparator.

Methods inherited from class no.sesat.search.result.BasicResultItem
`equals, getField, getField, getFieldNames, getFields, getInteger, getMultivaluedField, getObjectField, getTitle, getUrl, hashCode, setTitle, setUrl`

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

Methods inherited from interface no.sesat.search.result.ResultItem
`getField, getFieldNames, getMultivaluedField, getObjectField, getTitle, getUrl, setTitle, setUrl`

Constructor Detail

BasicResultList

public BasicResultList()

Plain constructor.

BasicResultList

protected BasicResultList(String title,
                          String url,
                          int hitCount)

BasicResultList

public BasicResultList(ResultItem copy)

Copy constructor. Does not copy results, spellingSuggestions, querySuggestions, or relevantQueries.

Parameters:: copy -

BasicResultList

public BasicResultList(ResultList<ResultItem> copy)

Copy constructor. Does not copy results.

Parameters:: copy -

Method Detail