Package | Description |
---|---|
org.hippoecm.hst.component.support.bean | |
org.hippoecm.hst.content.beans.manager |
The org.hippoecm.hst.content.beans.manager package defines the API for the HST Content Beans Manager
|
org.hippoecm.hst.content.beans.query |
The org.hippoecm.hst.content.beans.query package defines the API for the HST Content Beans Query
|
org.hippoecm.hst.content.beans.standard |
The org.hippoecm.hst.content.beans.standard package defines the API for the HST Content Standard Beans
|
org.hippoecm.hst.content.beans.standard.facetnavigation | |
org.hippoecm.hst.core.linking |
The org.hippoecm.hst.core.linking package defines the API for the HST Core Linking
|
org.hippoecm.hst.core.request |
The org.hippoecm.hst.core.request package defines the API for the HST Core Request
|
org.hippoecm.hst.mock.content.beans.standard | |
org.hippoecm.hst.mock.core.request | |
org.hippoecm.hst.tag | |
org.hippoecm.hst.util |
The org.hippoecm.hst.content.util package defines the API for the HST Util
|
org.hippoecm.hst.utils |
Modifier and Type | Method and Description |
---|---|
<T extends HippoBean> |
BaseHstComponent.getContentBean(HstRequest request,
Class<T> beanMappingClass) |
Modifier and Type | Method and Description |
---|---|
HippoBean |
BaseHstComponent.getBeanForResolvedSiteMapItem(HstRequest request,
ResolvedSiteMapItem resolvedSiteMapItem)
Return a
HippoBean when it can be found for the relativeContentPath for the . |
HippoBean |
BaseHstComponent.getContentBean(HstRequest request)
When the
belonging to the current requestUri has a relativeContentPath that points to an
existing jcr Node, a HippoBean wrapping this node is returned. |
HippoBean |
BaseHstComponent.getSiteContentBaseBean(HstRequest request) |
Modifier and Type | Method and Description |
---|---|
protected List<Class<? extends HippoBean>> |
BaseHstComponent.getLocalAnnotatedClasses()
Deprecated.
since 7.8.3 : There is no replacement. Since automatic beans scanning this method is completely redundant. Make
sure that through the 'hst-beans-annotated-classes' in the web.xml all annotated beans can be found. For example
|
Modifier and Type | Field and Description |
---|---|
protected Map<Class<? extends HippoBean>,String> |
ObjectConverterImpl.jcrBeanPrimaryNodeTypePairs |
protected Map<String,Class<? extends HippoBean>> |
ObjectConverterImpl.jcrPrimaryNodeTypeBeanPairs |
Modifier and Type | Method and Description |
---|---|
Class<? extends HippoBean> |
ObjectConverter.getAnnotatedClassFor(String jcrPrimaryNodeType) |
Class<? extends HippoBean> |
ObjectConverterImpl.getAnnotatedClassFor(String jcrPrimaryNodeType) |
Modifier and Type | Method and Description |
---|---|
String |
ObjectConverter.getPrimaryNodeTypeNameFor(Class<? extends HippoBean> hippoBean) |
String |
ObjectConverterImpl.getPrimaryNodeTypeNameFor(Class<? extends HippoBean> hippoBean) |
Constructor and Description |
---|
ObjectConverterImpl(Map<String,Class<? extends HippoBean>> jcrPrimaryNodeTypeBeanPairs,
String[] fallBackJcrNodeTypes) |
Modifier and Type | Method and Description |
---|---|
HstQuery |
HstQueryManager.createQuery(HippoBean scope)
Creates a empty query, with scope
|
HstQuery |
HstQueryManagerImpl.createQuery(HippoBean scope)
Creates a empty query, with the scope HippoBean
|
HstQuery |
HstQueryManager.createQuery(HippoBean scope,
Class<? extends HippoBean>... filterBean)
Creates a query, with a scope and with a Filter that filters to only return HippoBeans of the types that are
added as variable arguments.
|
HstQuery |
HstQueryManagerImpl.createQuery(HippoBean scope,
Class<? extends HippoBean>... filterBeans) |
HstQuery |
HstQueryManager.createQuery(HippoBean scope,
Class<? extends HippoBean> filterBean,
boolean includeSubTypes)
Creates a query, with scope HippoBean and Filter for types of filterBean.
|
HstQuery |
HstQueryManagerImpl.createQuery(HippoBean scope,
Class<? extends HippoBean> filterBean,
boolean includeSubTypes)
Creates a query, with scope HippoBean and Filter for types of filterBean.
|
HstQuery |
HstQueryManager.createQuery(HippoBean scope,
String... primaryNodeTypes)
Creates a query, with a scope and with a Filter that filters to only return HippoBeans of the types that are
added as variable arguments.
|
HstQuery |
HstQueryManagerImpl.createQuery(HippoBean scope,
String... primaryNodeTypes) |
Modifier and Type | Method and Description |
---|---|
void |
HstQuery.addScopes(List<HippoBean> scopes)
add scopes to search in.
|
void |
HstQueryImpl.addScopes(List<HippoBean> scopes) |
HstQuery |
HstQueryManager.createQuery(HippoBean scope,
Class<? extends HippoBean> filterBean,
boolean includeSubTypes)
Creates a query, with scope HippoBean and Filter for types of filterBean.
|
HstQuery |
HstQueryManagerImpl.createQuery(HippoBean scope,
Class<? extends HippoBean> filterBean,
boolean includeSubTypes)
Creates a query, with scope HippoBean and Filter for types of filterBean.
|
HstQuery |
HstQueryManager.createQuery(javax.jcr.Node scope,
Class<? extends HippoBean> filterBean,
boolean includeSubTypes)
Creates a query, with scope and Filter for types of filterBean.
|
HstQuery |
HstQueryManagerImpl.createQuery(javax.jcr.Node scope,
Class<? extends HippoBean> filterBean,
boolean includeSubTypes)
Creates a query, with scope and Filter for types of filterBean.
|
void |
HstQuery.excludeScopes(List<HippoBean> scopes)
add scopes to exclude from search.
|
void |
HstQueryImpl.excludeScopes(List<HippoBean> scopes) |
Modifier and Type | Class and Description |
---|---|
class |
AvailableTranslations<K extends HippoBean>
|
class |
BeansWrapper<B extends HippoBean> |
class |
BeanWrapper<B extends HippoBean> |
class |
HippoAvailableTranslations<K extends HippoBean>
Deprecated.
since 2.26.01 : Use
AvailableTranslations pojo which is not backed by a jcr node instead and does NOT
extend from HippoItem and does not implement HippoBean at all |
interface |
HippoAvailableTranslationsBean<K extends HippoBean> |
static class |
HippoAvailableTranslationsBean.NoopTranslationsBean<K extends HippoBean>
A No-operation instance of a HippoAvailableTranslationsBean
|
Modifier and Type | Interface and Description |
---|---|
interface |
HippoAssetBean
This is a base interface for possible beans containing an asset.
|
interface |
HippoCompoundBean
A marker interface for all beans that extend from the abstract hippo:compound type
|
interface |
HippoDocumentBean
This is a marker interface for all beans that represent a document.
|
interface |
HippoFacetChildNavigationBean
Interface for all child nodes primarily meant for the virtual structure below 'hippo:facetnavigation'
|
interface |
HippoFacetNavigationBean
Interface for all nodes of type 'hippo:facetnavigation'
|
interface |
HippoFolderBean
This is a base interface for all beans that represent a folder should implement.
|
interface |
HippoGalleryImageBean
The interface which all hippo gallery image implementations should implement
|
interface |
HippoGalleryImageSetBean
The interface the default hippo gallery set impls must implement.
|
interface |
HippoHtmlBean
Implementing classes represent a html node in the ecm repository.
|
interface |
HippoMirrorBean |
interface |
HippoRequestBean
The base interface for all bean implementing a hippo request
|
interface |
HippoResourceBean
This is a base interface for all beans that represent a hippo resource should implement.
|
interface |
HippoResultSetBean |
interface |
HippoVirtualOnlyBean
A marker interface for beans that are a result of a jcr node that is only virtual and has
no physical equivalence: in other words, the canonical node is null
|
Modifier and Type | Class and Description |
---|---|
class |
HippoAsset |
class |
HippoAvailableTranslations<K extends HippoBean>
Deprecated.
since 2.26.01 : Use
AvailableTranslations pojo which is not backed by a jcr node instead and does NOT
extend from HippoItem and does not implement HippoBean at all |
class |
HippoCompound
The abstract base bean that can (not should) be used for all HippoCompound types.
|
class |
HippoDirectory |
class |
HippoDocument |
class |
HippoFacetSelect
hippo:facetselect has the same methods as for hippo:mirror
|
class |
HippoFixedDirectory |
class |
HippoFolder |
class |
HippoGalleryImage
Bean mapping class for the 'hippogallery:image' document type
|
class |
HippoGalleryImageSet
Bean mapping class for the 'hippogallery:imageset' document type
|
class |
HippoHtml |
class |
HippoItem |
class |
HippoMirror |
class |
HippoResource
Bean mapping class for the 'hippo:resource' document type
|
class |
HippoStdPubWfRequest |
class |
HippoTranslation
This bean is only to map a hippo:translation to a bean: Normally, you never use this bean at all, as translations are
available through
HippoNode.getLocalizedName()
Note that this bean is quite different then HippoAvailableTranslations , which can be used to find the 'same' bean in multiple
translations. |
Modifier and Type | Method and Description |
---|---|
<T extends HippoBean> |
HippoBean.getAvailableTranslations()
|
<T extends HippoBean> |
HippoItem.getAvailableTranslations() |
<T extends HippoBean> |
HippoDocumentBean.getAvailableTranslations(Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoDocument.getAvailableTranslations(Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoBean.getAvailableTranslationsBean()
Deprecated.
since 2.26.01 : Use
getAvailableTranslations() instead |
<T extends HippoBean> |
HippoItem.getAvailableTranslationsBean()
Deprecated.
since 2.26.01 : Use
HippoItem.getAvailableTranslations() instead |
<T extends HippoBean> |
HippoDocumentBean.getAvailableTranslationsBean(Class<T> beanMappingClass)
Deprecated.
since 2.26.01 : Use
HippoDocumentBean.getAvailableTranslations(Class) instead |
<T extends HippoBean> |
HippoDocument.getAvailableTranslationsBean(Class<T> beanMappingClass)
Deprecated.
since 2.26.01 : Use
HippoDocument.getAvailableTranslations(Class) instead |
<T extends HippoBean> |
HippoBean.getBean(String relPath,
Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoItem.getBean(String relPath,
Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoBean.getCanonicalBean()
Returns the canonical version of the current
HippoBean or null in case that the backing Node is pure virtual, which
is the case for example for some faceted navigation nodes. |
<T extends HippoBean> |
HippoItem.getCanonicalBean() |
<T extends HippoBean> |
HippoBean.getChildBeans(Class<T> beanMappingClass)
Returns all the child beans as a
List with elements of type T . |
<T extends HippoBean> |
HippoItem.getChildBeans(Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoBean.getChildBeansByName(String childNodeName,
Class<T> beanMappingClass)
|
<T extends HippoBean> |
HippoItem.getChildBeansByName(String childNodeName,
Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoBean.getLinkedBean(String relPath,
Class<T> beanMappingClass)
This method returns the
HippoBean linked by relPath of type beanMappingClass, or null if no bean found or not of (sub)type beanMappingClass. |
<T extends HippoBean> |
HippoItem.getLinkedBean(String relPath,
Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoBean.getLinkedBeans(String relPath,
Class<T> beanMappingClass)
This method returns all the
HippoBean 's linked by relPath of type beanMappingClass as a List, or an Empty list if no bean found or not of (sub)type beanMappingClass. |
<T extends HippoBean> |
HippoItem.getLinkedBeans(String relPath,
Class<T> beanMappingClass) |
Modifier and Type | Method and Description |
---|---|
HippoBean |
HippoBean.getContextualBean()
Deprecated.
since 2.25.02 : use
getCanonicalBean() instead. The only different is, that getContextualBean() returns
the current HippoBean instance when there exists no canonical version of the backing jcr Node, whereas getCanonicalBean() in that
case returns null |
HippoBean |
HippoItem.getContextualBean()
Deprecated.
|
HippoBean |
HippoBean.getContextualParentBean()
Deprecated.
since 2.25.02 : Use #getParentBean instead. Returns the same as #getParentBean
|
HippoBean |
HippoItem.getContextualParentBean()
Deprecated.
|
HippoBean |
HippoMirrorBean.getDeref() |
HippoBean |
HippoMirror.getDeref()
When you want the HippoBean that this mirror is pointing to, you can use this method.
|
HippoBean |
HippoRequestBean.getDocument() |
HippoBean |
HippoStdPubWfRequest.getDocument() |
HippoBean |
HippoBean.getParentBean()
Returns the parent bean wrt this bean.
|
HippoBean |
HippoItem.getParentBean() |
HippoBean |
HippoMirrorBean.getReferencedBean() |
HippoBean |
HippoMirror.getReferencedBean()
When you want the HippoBean that this mirror represents, you can use this method.
|
HippoBean |
HippoBeanIteratorImpl.next() |
HippoBean |
HippoBeanIterator.nextHippoBean()
Returns the next
HippoBean in the iteration. |
HippoBean |
HippoBeanIteratorImpl.nextHippoBean() |
Modifier and Type | Method and Description |
---|---|
int |
HippoItem.compareTo(HippoBean hippoBean)
The standard HippoItem has a natural ordering based on node name.
|
boolean |
HippoBean.isAncestor(HippoBean compare)
Returns
true when this HippoBean is an ancestor of the compare HippoBean. |
boolean |
HippoItem.isAncestor(HippoBean compare) |
boolean |
HippoBean.isDescendant(HippoBean compare)
Returns
true when this HippoBean is an descendant of the compare HippoBean. |
boolean |
HippoItem.isDescendant(HippoBean compare) |
boolean |
HippoBean.isSelf(HippoBean compare)
Returns
true when this HippoBean has a underlying jcr node with the same jcr path as the
compare HippoBean. |
boolean |
HippoItem.isSelf(HippoBean compare) |
Constructor and Description |
---|
BeansWrapper(HippoBean bean) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractHippoFacetChildNavigation
The base class for child item of faceted navigation
|
class |
HippoFacetNavigation |
class |
HippoFacetResult |
class |
HippoFacetsAvailableNavigation |
class |
HippoFacetSearch |
class |
HippoFacetSubNavigation |
Modifier and Type | Method and Description |
---|---|
HstLink |
HstLinkCreator.create(HippoBean bean,
HstRequestContext requestContext) |
Modifier and Type | Method and Description |
---|---|
HippoBean |
HstRequestContext.getContentBean()
Returns the content
HippoBean for this request. |
HippoBean |
HstRequestContext.getSiteContentBaseBean()
Returns the siteContentBaseBean
HippoBean for this request. |
Modifier and Type | Class and Description |
---|---|
class |
MockHippoBean |
class |
MockHippoResourceBean |
Modifier and Type | Method and Description |
---|---|
<T extends HippoBean> |
MockHippoBean.getAvailableTranslations() |
<T extends HippoBean> |
MockHippoBean.getAvailableTranslationsBean() |
<T extends HippoBean> |
MockHippoBean.getBean(String relPath,
Class<T> beanMappingClass) |
<T extends HippoBean> |
MockHippoBean.getCanonicalBean() |
<T extends HippoBean> |
MockHippoBean.getChildBeans(Class<T> beanMappingClass) |
<T extends HippoBean> |
MockHippoBean.getChildBeansByName(String childNodeName,
Class<T> beanMappingClass) |
<T extends HippoBean> |
MockHippoBean.getLinkedBean(String relPath,
Class<T> beanMappingClass) |
<T extends HippoBean> |
MockHippoBean.getLinkedBeans(String relPath,
Class<T> beanMappingClass) |
Modifier and Type | Method and Description |
---|---|
HippoBean |
MockHippoBean.getContextualBean() |
HippoBean |
MockHippoBean.getContextualParentBean() |
HippoBean |
MockHippoBean.getParentBean() |
HippoBean |
MockHippoBeanIterator.next() |
HippoBean |
MockHippoBeanIterator.nextHippoBean() |
Modifier and Type | Method and Description |
---|---|
int |
MockHippoBean.compareTo(HippoBean o) |
boolean |
MockHippoBean.isAncestor(HippoBean compare) |
boolean |
MockHippoBean.isDescendant(HippoBean compare) |
boolean |
MockHippoBean.isSelf(HippoBean compare) |
Constructor and Description |
---|
MockHippoBeanIterator(List<HippoBean> hippoDocuments) |
Modifier and Type | Method and Description |
---|---|
HippoBean |
MockHstRequestContext.getContentBean() |
HippoBean |
MockHstRequestContext.getSiteContentBaseBean() |
Modifier and Type | Method and Description |
---|---|
void |
MockHstRequestContext.setContentBean(HippoBean contentBean) |
void |
MockHstRequestContext.setSiteContentBaseBean(HippoBean siteContentBean) |
Modifier and Type | Field and Description |
---|---|
protected HippoBean |
HstCmsEditLinkTag.hippoBean |
Modifier and Type | Method and Description |
---|---|
HippoBean |
HstCmsEditLinkTag.getHippobean() |
protected HippoBean |
HstTagSupport.getSiteContentBaseBean(HstRequest request)
Get the site content base bean, which is the root document bean whithin
preview or live context.
|
Modifier and Type | Method and Description |
---|---|
void |
HstCmsEditLinkTag.setHippobean(HippoBean hippoBean) |
Modifier and Type | Method and Description |
---|---|
static <T extends HippoBean> |
ContentBeanUtils.getIncomingBeans(HstQuery query,
Class<? extends HippoBean> beanMappingClass)
Returns a list of beans of type T (the same type as
beanMappingClass ) that have a (facet)link to the HippoDocumentBean bean . |
Modifier and Type | Method and Description |
---|---|
static List<Class<? extends HippoBean>> |
ObjectConverterUtils.getAnnotatedClasses(ClasspathResourceScanner resourceScanner,
String... locationPatterns)
Collects bean classes annotated by
Node
from the location specified by locationPattern . |
static List<Class<? extends HippoBean>> |
ObjectConverterUtils.getAnnotatedClasses(URL url)
Collects bean classes annotated by
Node from a XML Resource URL. |
Modifier and Type | Method and Description |
---|---|
static HstQuery |
ContentBeanUtils.createIncomingBeansQuery(HippoDocumentBean bean,
HippoBean scope,
int depth,
ObjectConverter converter,
Class<? extends HippoBean> beanMappingClass,
boolean includeSubTypes)
Returns a HstQuery for incoming beans (incoming beans within scope
scope ). |
static HstQuery |
ContentBeanUtils.createIncomingBeansQuery(HippoDocumentBean bean,
HippoBean scope,
List<String> linkPaths,
ObjectConverter converter,
Class<? extends HippoBean> beanMappingClass,
boolean includeSubTypes)
Returns a HstQuery for incoming beans (incoming beans within scope
scope ). |
static HstQuery |
ContentBeanUtils.createIncomingBeansQuery(HippoDocumentBean bean,
HippoBean scope,
String linkPath,
ObjectConverter converter,
Class<? extends HippoBean> beanMappingClass,
boolean includeSubTypes)
Returns a HstQuery for incoming beans (incoming beans within scope
scope ). |
Modifier and Type | Method and Description |
---|---|
static HstQuery |
ContentBeanUtils.createIncomingBeansQuery(HippoDocumentBean bean,
HippoBean scope,
int depth,
ObjectConverter converter,
Class<? extends HippoBean> beanMappingClass,
boolean includeSubTypes)
Returns a HstQuery for incoming beans (incoming beans within scope
scope ). |
static HstQuery |
ContentBeanUtils.createIncomingBeansQuery(HippoDocumentBean bean,
HippoBean scope,
List<String> linkPaths,
ObjectConverter converter,
Class<? extends HippoBean> beanMappingClass,
boolean includeSubTypes)
Returns a HstQuery for incoming beans (incoming beans within scope
scope ). |
static HstQuery |
ContentBeanUtils.createIncomingBeansQuery(HippoDocumentBean bean,
HippoBean scope,
String linkPath,
ObjectConverter converter,
Class<? extends HippoBean> beanMappingClass,
boolean includeSubTypes)
Returns a HstQuery for incoming beans (incoming beans within scope
scope ). |
static ObjectConverter |
ObjectConverterUtils.createObjectConverter(Collection<Class<? extends HippoBean>> annotatedClasses)
Creates
ObjectConverter , with ignoreDuplicates = false, which means that when there are two annotated beans with the same
value for Node.jcrType() , an IllegalArgumentException is thrown. |
static ObjectConverter |
ObjectConverterUtils.createObjectConverter(Collection<Class<? extends HippoBean>> annotatedClasses,
boolean ignoreDuplicates)
Creates
ObjectConverter . |
static ObjectConverter |
ObjectConverterUtils.createObjectConverter(Collection<Class<? extends HippoBean>> annotatedClasses,
Class<? extends HippoBean>[] builtInMappingClasses,
String[] fallbackNodeTypes,
boolean ignoreDuplicates)
Creates
ObjectConverter . |
static <T extends HippoBean> |
ContentBeanUtils.getIncomingBeans(HstQuery query,
Class<? extends HippoBean> beanMappingClass)
Returns a list of beans of type T (the same type as
beanMappingClass ) that have a (facet)link to the HippoDocumentBean bean . |
Modifier and Type | Method and Description |
---|---|
static <T extends HippoBean> |
BeanUtils.getFacetedNavigationResultDocument(HstRequest hstRequest,
HstQuery query,
ObjectConverter objectConverter,
Class<T> beanMappingClass)
Tries to return a bean that is located in a faceted navigation tree below a result set.
|
static <T extends HippoBean> |
BeanUtils.getFacetedNavigationResultDocument(HstRequest hstRequest,
HstQuery query,
String relPath,
ObjectConverter objectConverter,
Class<T> beanMappingClass)
Tries to return a bean that is located in a faceted navigation tree below a result set.
|
static <T extends HippoBean> |
BeanUtils.getFacetedNavigationResultDocument(HstRequest hstRequest,
String query,
ObjectConverter objectConverter,
Class<T> beanMappingClass)
Tries to return a bean that is located in a faceted navigation tree below a result set.
|
static <T extends HippoBean> |
BeanUtils.getFacetedNavigationResultDocument(HstRequest hstRequest,
String query,
String relPath,
ObjectConverter objectConverter,
Class<T> beanMappingClass)
Tries to return a bean that is located in a faceted navigation tree below a result set.
|
Copyright © 2008-2013 Hippo B.V. (http://www.onehippo.com). All Rights Reserved.