com.endeca.infront.cartridge
Class DimensionSearchResults

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<String,Object>
          com.endeca.infront.assembler.BasicContentItem
              com.endeca.infront.cartridge.DimensionSearchResults

All Implemented Interfaces:

ContentItem, Serializable, Cloneable, Map<String,Object>

public class DimensionSearchResults
extends BasicContentItem

DimensionSearchResultsHandler output model.

Cartridge output model class for a dimension search cartridge.

DimensionSearchResults contains a list of matched dimension values grouped by the dimension root.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

DimensionSearchResults(DimensionSearchResultsConfig pConfig)
Creates the DimensionSearchResults output model, using the type and data present in the input DimensionSearchResultsConfig.

Method Summary

List<DimensionSearchGroup>	getDimensionSearchGroups() Returns a List of dimension search groups.
Integer	getTotalNumResults() The number of DimensionSearchValues in this result.
void	setDimensionSearchGroups(List<DimensionSearchGroup> dimensionSearchGroups) Sets the List of dimension search groups.
void	setTotalNumResults(Integer totalNumResults) Sets the number of DimensionSearchValues in this result.

Methods inherited from class com.endeca.infront.assembler.BasicContentItem

getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

DimensionSearchResults

public DimensionSearchResults(DimensionSearchResultsConfig pConfig)

Creates the DimensionSearchResults output model, using the type and data present in the input DimensionSearchResultsConfig.

Method Detail

getDimensionSearchGroups

public List<DimensionSearchGroup> getDimensionSearchGroups()

Returns a List of dimension search groups. Returns null by default.

setDimensionSearchGroups

public void setDimensionSearchGroups(List<DimensionSearchGroup> dimensionSearchGroups)

Sets the List of dimension search groups.

getTotalNumResults

public Integer getTotalNumResults()

The number of DimensionSearchValues in this result.

Returns:

the number of DimensionSearchValue in this result across DimensionSearchGroups.

setTotalNumResults

public void setTotalNumResults(Integer totalNumResults)

Sets the number of DimensionSearchValues in this result.