info.magnolia.jcr.decoration
Interface ContentDecorator

All Known Implementing Classes:
AbstractContentDecorator, ChannelVisibilityContentDecorator, ChildFilteringContentDecorator, DefaultInheritanceContentDecorator, HTMLEscapingContentDecorator, I18nContentDecorator, InheritanceContentDecorator, MgnlAuditLoggingContentDecorator, MgnlVersioningContentDecorator, NodePredicateContentDecorator, PropertyAndChildWrappingContentDecorator, PropertyFilteringContentDecorator, VersionedNodeChildContentDecorator, VersionedNodeContentDecorator

public interface ContentDecorator

Applies custom behavior in a graph of JCR objects by wrapping objects. Allows for expressing the logic in a single place.

Version:
$Id$
See Also:
AbstractContentDecorator

Method Summary
 boolean evaluateNode(javax.jcr.Node node)
          Evaluates if a node should be hidden by wrappers.
 boolean evaluateProperty(javax.jcr.Property property)
          Evaluates if a property should be hidden by wrappers.
 boolean isMultipleWrapEnabled()
          Tells if multiple wrapping with this content decorator is enabled.
 javax.jcr.Node wrapNode(javax.jcr.Node node)
           
 javax.jcr.NodeIterator wrapNodeIterator(javax.jcr.NodeIterator nodeIterator)
           
 javax.jcr.Property wrapProperty(javax.jcr.Property property)
           
 javax.jcr.PropertyIterator wrapPropertyIterator(javax.jcr.PropertyIterator propertyIterator)
           
 javax.jcr.Session wrapSession(javax.jcr.Session session)
           
 javax.jcr.Workspace wrapWorkspace(javax.jcr.Workspace workspace)
           
 

Method Detail

wrapSession

javax.jcr.Session wrapSession(javax.jcr.Session session)

wrapWorkspace

javax.jcr.Workspace wrapWorkspace(javax.jcr.Workspace workspace)

wrapNode

javax.jcr.Node wrapNode(javax.jcr.Node node)

wrapNodeIterator

javax.jcr.NodeIterator wrapNodeIterator(javax.jcr.NodeIterator nodeIterator)

evaluateNode

boolean evaluateNode(javax.jcr.Node node)
Evaluates if a node should be hidden by wrappers.

Parameters:
node - the node to evaluate
Returns:
true if the node should be visible or false to hide it

wrapProperty

javax.jcr.Property wrapProperty(javax.jcr.Property property)

wrapPropertyIterator

javax.jcr.PropertyIterator wrapPropertyIterator(javax.jcr.PropertyIterator propertyIterator)

evaluateProperty

boolean evaluateProperty(javax.jcr.Property property)
Evaluates if a property should be hidden by wrappers.

Parameters:
property - the property to evaluate.
Returns:
true if the property should be visible or false to hide it

isMultipleWrapEnabled

boolean isMultipleWrapEnabled()
Tells if multiple wrapping with this content decorator is enabled.



Copyright © 2003-2013 Magnolia International Ltd.. All Rights Reserved.