com.browseengine.bobo.api
Class FacetSpec

java.lang.Object
  com.browseengine.bobo.api.FacetSpec

All Implemented Interfaces:

Serializable

public class FacetSpec
extends Object
implements Serializable

specifies how facets are to be returned for a browse

See Also:

Serialized Form

Nested Class Summary

static class

FacetSpec.FacetSortSpec Sort options for facets

Constructor Summary

FacetSpec()
Constructor.

Method Summary

FacetSpec	clone()
ComparatorFactory	getCustomComparatorFactory()
int	getMaxCount() Gets the maximum number of choices to return
int	getMinHitCount() Gets the minimum number of hits a choice would need to have to be returned.
FacetSpec.FacetSortSpec	getOrderBy() Get the current choice sort order
Map<String,String>	getProperties() Gets custom properties for the facet search.
boolean	isExpandSelection() Gets whether we are expanding sibling choices
FacetSpec	setCustomComparatorFactory(ComparatorFactory comparatorFactory)
FacetSpec	setExpandSelection(boolean expandSelection) Sets whether we are expanding sibling choices
FacetSpec	setMaxCount(int maxCount) Sets the maximum number of choices to return.
FacetSpec	setMinHitCount(int minCount) Sets the minimum number of hits a choice would need to have to be returned.
FacetSpec	setOrderBy(FacetSpec.FacetSortSpec order) Sets the choice sort order
FacetSpec	setProperties(Map<String,String> properties) Sets custom properties for the facet search.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetSpec

public FacetSpec()

Constructor.

Method Detail

setCustomComparatorFactory

public FacetSpec setCustomComparatorFactory(ComparatorFactory comparatorFactory)

getCustomComparatorFactory

public ComparatorFactory getCustomComparatorFactory()

setMinHitCount

public FacetSpec setMinHitCount(int minCount)

Sets the minimum number of hits a choice would need to have to be returned.

Parameters:

minCount - minimum count

See Also:

getMinHitCount()

getMinHitCount

public int getMinHitCount()

Gets the minimum number of hits a choice would need to have to be returned.

Returns:

minimum count

See Also:

setMinHitCount(int)

getOrderBy

public FacetSpec.FacetSortSpec getOrderBy()

Get the current choice sort order

Returns:

choice sort order

See Also:

setOrderBy(FacetSortSpec)

setOrderBy

public FacetSpec setOrderBy(FacetSpec.FacetSortSpec order)

Sets the choice sort order

Parameters:

order - sort order

See Also:

getOrderBy()

getMaxCount

public int getMaxCount()

Gets the maximum number of choices to return

Returns:

max number of choices to return

See Also:

setMaxCount(int)

setMaxCount

public FacetSpec setMaxCount(int maxCount)

Sets the maximum number of choices to return.

Parameters:

maxCount - max number of choices to return, default = 0 which means all

See Also:

getMaxCount()

toString

public String toString()

Overrides:

toString in class Object

isExpandSelection

public boolean isExpandSelection()

Gets whether we are expanding sibling choices

Returns:

A boolean indicating whether to expand sibling choices.

See Also:

setExpandSelection(boolean)

setExpandSelection

public FacetSpec setExpandSelection(boolean expandSelection)

Sets whether we are expanding sibling choices

Parameters:

expandSelection - indicating whether to expand sibling choices.

See Also:

isExpandSelection()

getProperties

public Map<String,String> getProperties()

Gets custom properties for the facet search. For example AttributeFacetHandler uses this to perform custom facet filtering

setProperties

public FacetSpec setProperties(Map<String,String> properties)

Sets custom properties for the facet search. For example AttributeFacetHandler uses this to perform custom facet filtering

Parameters:

properties -

clone

public FacetSpec clone()

Overrides:

clone in class Object