Package | Description |
---|---|
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 | |
org.hippoecm.hst.content.service.translation |
The org.hippoecm.hst.content.service.translation package defines the Hippo Translation related services.
|
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
|
Modifier and Type | Method and Description |
---|---|
Class<? extends HippoBean> |
ObjectConverter.getAnnotatedClassFor(String jcrPrimaryNodeType) |
Modifier and Type | Method and Description |
---|---|
String |
ObjectConverter.getPrimaryNodeTypeNameFor(Class<? extends HippoBean> hippoBean) |
Modifier and Type | Method and Description |
---|---|
HstQuery |
HstQueryManager.createQuery(HippoBean scope)
Creates a empty query, with scope
|
HstQuery |
HstQueryManager.createQuery(HippoBean scope,
boolean includeSubTypes,
Class<? extends HippoBean>... filterBean) |
HstQuery |
HstQueryManager.createQuery(HippoBean scope,
boolean includeSubTypes,
String... primaryNodeTypes) |
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 |
HstQueryManager.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.
|
Modifier and Type | Method and Description |
---|---|
void |
HstQuery.addScopes(List<HippoBean> scopes)
add scopes to search in.
|
HstQuery |
HstQueryManager.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.
|
void |
HstQuery.excludeScopes(List<HippoBean> scopes)
add scopes to exclude from search.
|
Modifier and Type | Interface and Description |
---|---|
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 | Method and Description |
---|---|
<T extends HippoBean> |
HippoBean.getAvailableTranslations()
|
<T extends HippoBean> |
HippoDocumentBean.getAvailableTranslations(Class<T> beanMappingClass) |
<T extends HippoBean> |
HippoBean.getBean(String relPath,
Class<T> beanMappingClass)
Only if a bean found of type
beanMappingClass , it is returned, and otherwise null is returned. |
<T extends HippoBean> |
HippoBean.getBeanByUUID(String uuid,
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> |
HippoBean.getChildBeans(Class<T> beanMappingClass)
Returns all the child beans as a
List with elements of type T . |
<T extends HippoBean> |
HippoBean.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. |
<T extends HippoBean> |
HippoBean.getLinkedBeans(String relPath,
Class<T> beanMappingClass)
Same as
getLinkedBean(String, Class) only now all linked beans found at relPath are returned. |
Modifier and Type | Method and Description |
---|---|
HippoBean |
HippoMirrorBean.getDeref()
Deprecated.
since 2.28.00 use
HippoMirrorBean.getReferencedBean() instead |
HippoBean |
HippoRequestBean.getDocument() |
HippoBean |
HippoBean.getParentBean()
Returns the parent bean wrt this bean.
|
HippoBean |
HippoMirrorBean.getReferencedBean()
When you want the HippoBean that this mirror represents, you can use this method.
|
HippoBean |
HippoBeanIterator.nextHippoBean()
Returns the next
HippoBean in the iteration. |
Modifier and Type | Method and Description |
---|---|
boolean |
HippoBean.isAncestor(HippoBean compare)
Returns
true when this HippoBean is an ancestor of the compare HippoBean. |
boolean |
HippoBean.isDescendant(HippoBean compare)
Returns
true when this HippoBean is an descendant of the compare HippoBean. |
boolean |
HippoBean.isSelf(HippoBean compare)
Returns
true when this HippoBean has a underlying jcr node with the same jcr path as the
compare HippoBean. |
Modifier and Type | Method and Description |
---|---|
<T extends HippoBean> |
HippoTranslationBeanService.getTranslationBeans(javax.jcr.Session session,
String translationId,
Class<T> beanMappingClass)
Returns all the Hippo Translation Beans of
translationId . |
Modifier and Type | Method and Description |
---|---|
HstLink |
HstLinkCreator.create(HippoBean bean,
HstRequestContext requestContext) |
Modifier and Type | Method and Description |
---|---|
<T extends HippoBean> |
HstRequestContext.getContentBean(Class<T> beanMappingClass)
Returns same as
HstRequestContext.getContentBean() but if the found HippoBean is not of type
beanMappingClass , then null is returned. |
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. |
Copyright © 2008–2017 Hippo B.V. (http://www.onehippo.com). All rights reserved.