@Node(jcrType="hippostd:folder") public class HippoFolder extends HippoItem implements HippoFolderBean
HippoItem.ComparatorMap| Modifier and Type | Field and Description |
|---|---|
protected ArrayList<HippoDocumentBean> |
hippoDocuments |
protected ArrayList<HippoFolderBean> |
hippoFolders |
comparePath, detached, localizedName, name, node, objectConverter, path, valueProvider| Constructor and Description |
|---|
HippoFolder() |
| Modifier and Type | Method and Description |
|---|---|
<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 |
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 |
int |
getDocumentSize() |
List<HippoFolderBean> |
getFolders() |
List<HippoFolderBean> |
getFolders(boolean sorted) |
Locale |
getLocale()
Returns the
Locale for content bean. |
String |
getLocaleString()
Return string expression of the locale for content bean.
|
attach, compareTo, detach, equalCompare, equals, getAvailableTranslations, getAvailableTranslationsBean, getBean, getBean, getCanonicalBean, getCanonicalPath, getCanonicalUUID, getChildBeans, getChildBeans, getChildBeansByName, getChildBeansByName, getComparePath, getContextualBean, getContextualParentBean, getEqualComparator, getIdentifier, getLinkedBean, getLinkedBeans, getLocalizedName, getName, getNode, getObjectConverter, getParentBean, getPath, getProperties, getProperty, getProperty, getProperty, getValueProvider, hashCode, isAncestor, isDescendant, isHippoDocumentBean, isHippoFolderBean, isLeaf, isSelf, setComparePath, setIdentifier, setLocalizedName, setName, setNode, setObjectConverter, setPathclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitequalCompare, getAvailableTranslations, getAvailableTranslationsBean, getBean, getBean, getCanonicalBean, 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, isSelfgetIdentifier, setIdentifiergetObjectConverter, setObjectConvertercompareToprotected ArrayList<HippoFolderBean> hippoFolders
protected ArrayList<HippoDocumentBean> hippoDocuments
public String getLocaleString()
HippoTranslatednull is returnedgetLocaleString in interface HippoTranslatednull when missingpublic Locale getLocale()
HippoTranslatedgetLocale in interface HippoTranslatedLocale for content bean and null when missingpublic List<HippoFolderBean> getFolders()
getFolders in interface HippoFolderBeanHippoFolderBean below this HippoFolderBean and an empty list of no folders presentpublic List<HippoFolderBean> getFolders(boolean sorted)
getFolders in interface HippoFolderBeansorted - if true, the list of folder will be returned sorted by their default HippoBean#compareTo(HippoBean)HippoFolderBean below this HippoFolderBean and an empty list if no folders presentpublic int getDocumentSize()
getDocumentSize in interface HippoFolderBeanpublic List<HippoDocumentBean> getDocuments()
HippoFolderBeanList 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 HippoFolderBean.getDocumentIterator(Class) as this is a lazy proxied iteratorgetDocuments in interface HippoFolderBeanHippoDocumentBeans below this HippoFolderBean and an empty list if no documents presentpublic List<HippoDocumentBean> getDocuments(int from, int to)
HippoFolderBeanfrom, 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 HippoFolderBean.getDocumentIterator(Class) as this is a lazy proxied iteratorgetDocuments in interface HippoFolderBeanfrom - (inclusive)to - (exclusive)HippoDocumentBean below this HippoFolderBean and an empty list when original list is empty or invalid rangepublic List<HippoDocumentBean> getDocuments(int from, int to, boolean sorted)
HippoFolderBeanfrom, 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 HippoFolderBean.getDocumentIterator(Class) as this is a lazy proxied iteratorgetDocuments in interface HippoFolderBeanfrom - (inclusive)to - (exclusive)sorted - boolean whether list to get sublist from needs to be sortedHippoDocumentBean below this HippoFolderBean and an empty list when original list is empty or invalid rangepublic <T> List<T> getDocuments(Class<T> beanMappingClass)
HippoFolderBeanHippoFolderBean.getDocumentIterator(Class) as this is a lazy proxied iteratorgetDocuments in interface HippoFolderBeanT - Any Object that implements a HippoDocumentBeanbeanMappingClass - a class implementing HippoDocumentBean. This functions as a filterpublic List<HippoDocumentBean> getDocuments(boolean sorted)
HippoFolderBeanList 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 HippoFolderBean.getDocuments().
note when only a subset of unsorted documents is needed, and the total number is large, better use HippoFolderBean.getDocumentIterator(Class) as this is a lazy proxied iteratorgetDocuments in interface HippoFolderBeansorted - indicates whether the List should be sortedsorted 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 HippoFolderBean.getDocuments() is returned. An empty list is returned if no documents are present.public <T> HippoDocumentIterator<T> getDocumentIterator(Class<T> beanMappingClass)
HippoFolderBeanHippoFolderBean.getDocuments()
methods (also with arguments) as they fetch all HippoDocumentBeans directly.getDocumentIterator in interface HippoFolderBeanT - Any Object that implements a HippoDocumentBeanbeanMappingClass - a class implementing HippoDocumentBean. This functions as a filterCopyright © 2008-2013 Hippo B.V. (http://www.onehippo.com). All Rights Reserved.