org.hippoecm.hst.content.beans.standard
Class HippoDocument

java.lang.Object
  org.hippoecm.hst.content.beans.standard.HippoItem
      org.hippoecm.hst.content.beans.standard.HippoDocument

All Implemented Interfaces:

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

Direct Known Subclasses:

HippoAsset, HippoGalleryImageSet

@Node(jcrType="hippo:document")
public class HippoDocument
extends HippoItem
implements HippoDocumentBean

Nested Class Summary

Nested classes/interfaces inherited from class org.hippoecm.hst.content.beans.standard.HippoItem

HippoItem.ComparatorMap

Field Summary

Fields inherited from class org.hippoecm.hst.content.beans.standard.HippoItem

comparePath, detached, node, objectConverter, valueProvider

Constructor Summary

HippoDocument()

Method Summary

void	attach(javax.jcr.Session session) Try to attach the jcr Node again with this session.
void	detach() Detach the jcr Node.
<T extends HippoBean> HippoAvailableTranslationsBean<T>	getAvailableTranslationsBean(Class<T> beanMappingClass) In case that there is no translation bean, a HippoAvailableTranslationsBean.NoopTranslationsBean is returned, to make sure you do not need null checks
String	getCanonicalHandlePath() Returns the jcr path of the backing canonical handle jcr node or null when
String	getCanonicalHandleUUID() Returns the jcr uuid of the backing canonical handle jcr node or null when
<T extends HippoCompoundBean> T	getHippoCompound(String relPath, Class<T> beanMappingClass)
HippoHtml	getHippoHtml(String relPath)
Locale	getLocale() Returns the Locale for content bean.
String	getLocaleString() Return string expression of the locale for content bean.

Methods inherited from class org.hippoecm.hst.content.beans.standard.HippoItem

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

HippoDocument

public HippoDocument()

Method Detail

getHippoHtml

public HippoHtml getHippoHtml(String relPath)

Parameters:

relPath -

Returns:

HippoHtml or null if no node exists as relPath or no node of type "hippostd:html"

getHippoCompound

public <T extends HippoCompoundBean> T getHippoCompound(String relPath,
                                                        Class<T> beanMappingClass)

Type Parameters:

T -

Parameters:

relPath -

beanMappingClass -

Returns:

the HippoCompoundBean at relPath if there is a compound of type beanMappingClass and null otherwise

getCanonicalHandleUUID

public String getCanonicalHandleUUID()

Description copied from interface: HippoDocumentBean

Returns the jcr uuid of the backing canonical handle jcr node or null when

• there is no canonical node
• the jcr node is detached
• a repository exception happened

Specified by:

getCanonicalHandleUUID in interface HippoDocumentBean

Returns:

the uuid of the canonical handle or null

See Also:

HippoBean.getCanonicalUUID()

getCanonicalHandlePath

public String getCanonicalHandlePath()

Description copied from interface: HippoDocumentBean

Returns the jcr path of the backing canonical handle jcr node or null when

• there is no canonical node
• the jcr node is detached
• a repository exception happened

Specified by:

getCanonicalHandlePath in interface HippoDocumentBean

Returns:

the jcr path of the canonical handle or null

See Also:

HippoBean.getCanonicalPath()

getLocaleString

public String getLocaleString()

Description copied from interface: HippoTranslated

Return string expression of the locale for content bean. If there is no locale found, null is returned

Specified by:

getLocaleString in interface HippoTranslated

Returns:

the string expression of the locale for content bean and null when missing

getLocale

public Locale getLocale()

Description copied from interface: HippoTranslated

Returns the Locale for content bean. If there is no Locale found, null is returned

Specified by:

getLocale in interface HippoTranslated

Returns:

the Locale for content bean and null when missing

getAvailableTranslationsBean

public <T extends HippoBean> HippoAvailableTranslationsBean<T> getAvailableTranslationsBean(Class<T> beanMappingClass)

Description copied from interface: HippoDocumentBean

In case that there is no translation bean, a HippoAvailableTranslationsBean.NoopTranslationsBean is returned, to make sure you do not need null checks

Specified by:

getAvailableTranslationsBean in interface HippoDocumentBean

Returns:

a HippoAvailableTranslationsBean where the translations must be of type beanMappingClass. This method never returns null

detach

public void detach()

Description copied from class: HippoItem

Detach the jcr Node. Already loaded properties and variables are still available.

Overrides:

detach in class HippoItem

attach

public void attach(javax.jcr.Session session)

Description copied from class: HippoItem

Try to attach the jcr Node again with this session.

Overrides:

attach in class HippoItem