org.hippoecm.hst.content.beans.standard

Class HippoMirror

java.lang.Object

org.hippoecm.hst.content.beans.standard.HippoItem

org.hippoecm.hst.content.beans.standard.HippoFolder

org.hippoecm.hst.content.beans.standard.HippoMirror

All Implemented Interfaces:

Comparable<HippoBean>, ObjectConverterAware, NodeAware, ContentBean, HippoBean, HippoFolderBean, HippoMirrorBean, HippoTranslated, IdentifiableContentBean

Direct Known Subclasses:

HippoFacetSelect

@Indexable(ignore=true)
@Node(jcrType="hippo:mirror")
public class HippoMirror
extends HippoFolder
implements HippoMirrorBean

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.HippoFolder

hippoDocuments, hippoFolders

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

comparePath, detached, localizedName, name, node, objectConverter, path, valueProvider

Constructor Summary

Constructors

Constructor and Description
HippoMirror()

Method Summary

Methods

Modifier and Type	Method and Description
HippoBean	getDeref() When you want the HippoBean that this mirror is pointing to, you can use this method.
HippoBean	getReferencedBean() When you want the HippoBean that this mirror represents, you can use this method.

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

getDocumentIterator, getDocuments, getDocuments, getDocuments, getDocuments, getDocuments, getDocumentSize, getFolders, getFolders, getLocale, getLocaleString

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

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, setPath

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, 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, isSelf

Methods inherited from interface org.hippoecm.hst.content.beans.standard.IdentifiableContentBean

getIdentifier, setIdentifier

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

HippoMirror

public HippoMirror()

Method Detail

getReferencedBean

public HippoBean getReferencedBean()

When you want the HippoBean that this mirror represents, you can use this method.

• If the mirror is pointing to a hippo:handle, then only a bean is returned if and only if the current node has a childnode with the same name as the hippo:handle. This is to ensure live/preview correctness.
• If the mirror is not pointing to a hippo:handle, just this HippoMirror is returned. This HippoMirror then namely represents its referencedBean already as it is a mirror, possibly with the context aware filter (livr/preview)

Specified by:

getReferencedBean in interface HippoMirrorBean

Returns:

the referenced HippoBean by this mirror or null when the linked bean cannot be created (for example, there is no published and the current context is live)

getDeref

public HippoBean getDeref()

When you want the HippoBean that this mirror is pointing to, you can use this method. WARNING: A deref breaks out of the virtual context, and might return you a node structure, where you find published and unpublished nodes. Recommended to use is getReferencedBean(). Note that this might return you a handle containing both live and preview documents. You should not use this method to get a linked item. Use getReferencedBean().

Specified by:

getDeref in interface HippoMirrorBean

Returns:

the deferenced HippoBean or null when the bean cannot be dereferenced