org.hippoecm.hst.content.beans.standard
Interface HippoFacetNavigationBean

All Superinterfaces:

Comparable<HippoBean>, HippoBean, HippoFolderBean, HippoTranslated, NodeAware, ObjectConverterAware

All Known Subinterfaces:

HippoFacetChildNavigationBean

All Known Implementing Classes:

AbstractHippoFacetChildNavigation, HippoFacetNavigation, HippoFacetsAvailableNavigation, HippoFacetSubNavigation

public interface HippoFacetNavigationBean
extends HippoFolderBean

Interface for all nodes of type 'hippo:facetnavigation'

Method Summary

Long	getChildCountsCombined() Return all the hippo:count values of all child HippoFacetNavigationBean combined.
Long	getCount() the value of the 'hippo:count' property
HippoResultSetBean	getResultSet()
HippoFacetNavigationBean	getRootFacetNavigationBean()

Methods inherited from interface org.hippoecm.hst.content.beans.standard.HippoFolderBean

getDocumentIterator, getDocuments, getDocuments, getDocuments, getDocuments, getDocuments, getDocumentSize, getFolders, getFolders

Methods inherited from interface org.hippoecm.hst.content.beans.standard.HippoBean

equalCompare, getAvailableTranslationsBean, getBean, getBean, getCanonicalPath, getCanonicalUUID, getChildBeans, getChildBeans, getChildBeansByName, getChildBeansByName, getContextualBean, getContextualParentBean, getEqualComparator, getLinkedBean, getLinkedBeans, getLocalizedName, getName, getNode, getParentBean, getPath, getProperties, getProperty, getProperty, getProperty, getValueProvider, isAncestor, isDescendant, isHippoDocumentBean, isHippoFolderBean, isLeaf, isSelf

Methods inherited from interface org.hippoecm.hst.content.beans.NodeAware

setNode

Methods inherited from interface org.hippoecm.hst.content.beans.manager.ObjectConverterAware

getObjectConverter, setObjectConverter

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.hippoecm.hst.content.beans.standard.HippoTranslated

getLocale, getLocaleString

Method Detail

getCount

Long getCount()

the value of the 'hippo:count' property

Returns:

Long value for the count

getChildCountsCombined

Long getChildCountsCombined()

Return all the hippo:count values of all child HippoFacetNavigationBean combined. This count can be different from the getCount() of this HippoFacetNavigationBean because of two reasons:

1. A document in the resultset can belong to multiple child HippoFacetNavigationBean's
2. A document in the resultset can belong to zero child HippoFacetNavigationBean's: this happens for example when the document has a property, say 'my:date' , but its date does not belong to any of the ranges that the child HippoFacetNavigationBean represent

Returns:

Return all the hippo:count values of all child HippoFacetNavigationBean combined.

getResultSet

HippoResultSetBean getResultSet()

Returns:

the result set below this faceted navigation item and null is there is no resultset node, for example when the count is 0

getRootFacetNavigationBean

HippoFacetNavigationBean getRootFacetNavigationBean()

Returns:

the root facetNavigationBean of this HippoFacetNavigationBean. If this HippoFacetNavigationBean is a HippoFacetChildNavigationBean it returns the root, otherwise it might return itself.