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

All Superinterfaces:

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

All Known Subinterfaces:

HippoFacetChildNavigationBean, HippoFacetNavigationBean, HippoResultSetBean

All Known Implementing Classes:

AbstractHippoFacetChildNavigation, HippoDirectory, HippoFacetNavigation, HippoFacetResult, HippoFacetsAvailableNavigation, HippoFacetSearch, HippoFacetSelect, HippoFacetSubNavigation, HippoFixedDirectory, HippoFolder, HippoMirror

public interface HippoFolderBean
extends HippoBean, HippoTranslated

This is a base interface for all beans that represent a folder should implement. When developers implement their own bean which does not extend the standard HippoFolder bean, they should implement this interface.

Method Summary

<T> HippoDocumentIterator<T>	getDocumentIterator(Class<T> beanMappingClass) Lazy loading iterator that fetches Documents only when asked for it.
List<HippoDocumentBean>	getDocuments() This method returns the List of HippoDocumentBeans in the order they are in the repository.
List<HippoDocumentBean>	getDocuments(boolean sorted) This method enables to get the List of HippoDocumentBeans according their HippoBean#compareTo(HippoBean).
<T> List<T>	getDocuments(Class<T> beanMappingClass) Facility method to get all documents directly below this folder that result in a HippoBean of class or subclass clazz.
List<HippoDocumentBean>	getDocuments(int from, int to) Returns a view of the portion of the list of HippoDocumentBean between the specified from, inclusive, and to, exclusive.
List<HippoDocumentBean>	getDocuments(int from, int to, boolean sorted) Returns a view of the portion of the list of HippoDocumentBean between the specified from, inclusive, and to, exclusive.
int	getDocumentSize()
List<HippoFolderBean>	getFolders()
List<HippoFolderBean>	getFolders(boolean sorted)

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

getFolders

List<HippoFolderBean> getFolders()

Returns:

the list of HippoFolderBean below this HippoFolderBean and an empty list of no folders present

getFolders

List<HippoFolderBean> getFolders(boolean sorted)

Parameters:

sorted - if true, the list of folder will be returned sorted by their default HippoBean#compareTo(HippoBean)

Returns:

the sorted list of HippoFolderBean below this HippoFolderBean and an empty list if no folders present

getDocumentSize

int getDocumentSize()

Returns:

the number of documents in this folder

getDocuments

List<HippoDocumentBean> getDocuments()

This method returns the List of HippoDocumentBeans in the order they are in the repository. If you need the List to be sorted according the HippoDocumentBean#compareTo(HippoBean), use #getDocuments(boolean)) with arg true note when only a subset of the documents is needed, and the total number is large, better use getDocumentIterator(Class) as this is a lazy proxied iterator

Returns:

the list of HippoDocumentBeans below this HippoFolderBean and an empty list if no documents present

getDocuments

List<HippoDocumentBean> getDocuments(int from,
                                     int to)

Returns a view of the portion of the list of HippoDocumentBean between the specified from, inclusive, and to, exclusive. (If from and to are equal, the returned list is empty.) note when only a subset of the documents is needed, and the total number is large, better use getDocumentIterator(Class) as this is a lazy proxied iterator

Parameters:

from - (inclusive)

to - (exclusive)

Returns:

the sublist of HippoDocumentBean below this HippoFolderBean and an empty list when original list is empty or invalid range

getDocuments

List<HippoDocumentBean> getDocuments(int from,
                                     int to,
                                     boolean sorted)

Returns a view of the portion of the list of HippoDocumentBean between the specified from, inclusive, and to, exclusive. (If from and to are equal, the returned list is empty.) note when only a subset of unsorted documents is needed, and the total number is large, better use getDocumentIterator(Class) as this is a lazy proxied iterator

Parameters:

from - (inclusive)

to - (exclusive)

sorted - boolean whether list to get sublist from needs to be sorted

Returns:

the sublist of possibly sorted of HippoDocumentBean below this HippoFolderBean and an empty list when original list is empty or invalid range

getDocuments

List<HippoDocumentBean> getDocuments(boolean sorted)

This method enables to get the List of HippoDocumentBeans according their HippoBean#compareTo(HippoBean). If you need the List to be ordered the way the documents are ordered in the repository, use getDocuments(). note when only a subset of unsorted documents is needed, and the total number is large, better use getDocumentIterator(Class) as this is a lazy proxied iterator

Parameters:

sorted - indicates whether the List should be sorted

Returns:

if sorted is true, the sorted list of HippoDocumentBeans below this HippoFolderBean, where the sorting is according HippoBean#compareTo(HippoBean), If sorted is false, the same list as getDocuments() is returned. An empty list is returned if no documents are present.

getDocuments

<T> List<T> getDocuments(Class<T> beanMappingClass)

Facility method to get all documents directly below this folder that result in a HippoBean of class or subclass clazz. note when only a subset of the documents is needed, and the total number is large, better use getDocumentIterator(Class) as this is a lazy proxied iterator

Type Parameters:

T - Any Object that implements a HippoDocumentBean

Parameters:

beanMappingClass - a class implementing HippoDocumentBean. This functions as a filter

Returns:

the list documents in this folder of type

getDocumentIterator

<T> HippoDocumentIterator<T> getDocumentIterator(Class<T> beanMappingClass)

Lazy loading iterator that fetches Documents only when asked for it. This is much more efficient then all thegetDocuments() methods (also with arguments) as they fetch all HippoDocumentBeans directly.

Type Parameters:

T - Any Object that implements a HippoDocumentBean

Parameters:

beanMappingClass - a class implementing HippoDocumentBean. This functions as a filter

Returns:

A lazy loading iterator returning documents in this folder of type