net.sf.mmm.util.search.base

Class SearchResultBean<HIT>

java.lang.Object

net.sf.mmm.util.search.base.SearchResultBean<HIT>

Type Parameters:

HIT - is the type of the individual items contained in this result.

All Implemented Interfaces:

Serializable, SearchResult<HIT>

public class SearchResultBean<HIT>
extends Object
implements SearchResult<HIT>

This is the implementation of SearchResult.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	complete
private List<HIT>	hits
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
SearchResultBean() The constructor.
SearchResultBean(List<HIT> hitList, int maximumHitCount) The constructor.

Method Summary

Modifier and Type	Method and Description
List<HIT>	getHits() This method gets the List with all hits returned by this SearchResult.
boolean	isComplete() This method determines if this result holds all hits that matched your SearchCriteria.
void	setComplete(boolean complete)
void	setHits(List<HIT> hits)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

complete

private boolean complete

hits

private List<HIT> hits

Constructor Detail

SearchResultBean

public SearchResultBean()

The constructor.

SearchResultBean

public SearchResultBean(List<HIT> hitList,
                        int maximumHitCount)

The constructor.

Parameters:

hitList - is the hit-list that may return more hits than the given maximumHitCount. In that case the hits will be created as a truncated copy of the given hitList. Otherwise getHits() will return the given hitList.

maximumHitCount - is the maximum hit-count.

Method Detail

isComplete

public boolean isComplete()

Description copied from interface: SearchResult

This method determines if this result holds all hits that matched your SearchCriteria. Otherwise the matches have been truncated and SearchResult.getHits() will return only the amount of hits specified by maximum hit-count of your SearchCriteria even though more hits are available.

Specified by:

isComplete in interface SearchResult<HIT>

Returns:

true if this result is complete, false if there are more matches available than contained in this result.

setComplete

public void setComplete(boolean complete)

Parameters:

complete - is the complete to set

getHits

public List<HIT> getHits()

Description copied from interface: SearchResult

This method gets the List with all hits returned by this SearchResult.
ATTENTION:
The hit-count is limited to the maximum hit-count specified by your SearchCriteria.

Specified by:

getHits in interface SearchResult<HIT>

Returns:

the List with all hits.

See Also:

SearchResult.isComplete()

setHits

public void setHits(List<HIT> hits)

Parameters:

hits - are the hits to set.