com.icfolson.aem.library.api.node

Interface ComponentNode

All Superinterfaces:

Accessible, BasicNode, ImageSource, Inheritable, Linkable, Traversable<ComponentNode>

All Known Implementing Classes:

AbstractComponent, DelegateComponentNode

public interface ComponentNode
extends BasicNode, Inheritable, Traversable<ComponentNode>

Represents a "component" node in the JCR, typically an unstructured node in the hierarchy of a CQ page.

Many methods return an Optional type where a null instance would otherwise be returned.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<ComponentNode>	getComponentNode(String relativePath) Get the component node for the resource at the given path relative to the current node.
com.google.common.base.Optional<ComponentNode>	getComponentNodeInherited(String relativePath) Get a child node relative to the current node, inheriting from a parent page if it does not exist.
List<ComponentNode>	getComponentNodes() Get a list of child nodes for the current node.
List<ComponentNode>	getComponentNodes(com.google.common.base.Predicate<ComponentNode> predicate) Get a predicate-filtered list of child nodes for the current node.
List<ComponentNode>	getComponentNodes(String relativePath) Get a list of child nodes for the resource at the given path relative to this node.
List<ComponentNode>	getComponentNodes(String relativePath, com.google.common.base.Predicate<ComponentNode> predicate) Get a list of child nodes for the resource at the given path relative to this node, returning only the nodes that meet the predicate criteria.
List<ComponentNode>	getComponentNodes(String relativePath, String resourceType) Get a list of child nodes for the resource at the given path relative to this node, returning only the nodes that have the specified resource type.
List<ComponentNode>	getComponentNodesInherited(String relativePath) Get the children of a node relative to the current node.
com.google.common.base.Optional<BasicNode>	getDesignNode() Get the design node for the current component.
com.google.common.base.Optional<ComponentNode>	getParent() Get the parent of this node.

Methods inherited from interface com.icfolson.aem.library.api.node.BasicNode

getId, getIndex, getIndex, getNode, getPath, getProperties, getResource

Methods inherited from interface com.icfolson.aem.library.api.Linkable

getHref, getHref, getLink, getLink, getLinkBuilder, getLinkBuilder

Methods inherited from interface com.icfolson.aem.library.api.ImageSource

getImageSource, getImageSource, getImageSource, getImageSource, isHasImage, isHasImage

Methods inherited from interface com.icfolson.aem.library.api.Accessible

asMap, get, get, getAsHref, getAsHref, getAsHref, getAsLink, getAsLink, getAsLink, getAsList, getAsPage, getAsType, getImageReference, getImageReference, getImageReference, getImageRendition, getImageRendition

Methods inherited from interface com.icfolson.aem.library.api.Inheritable

getAsHrefInherited, getAsHrefInherited, getAsHrefInherited, getAsLinkInherited, getAsLinkInherited, getAsLinkInherited, getAsListInherited, getAsPageInherited, getAsTypeInherited, getImageReferenceInherited, getImageReferenceInherited, getImageReferenceInherited, getImageSourceInherited, getImageSourceInherited, getImageSourceInherited, getImageSourceInherited, getInherited, getInherited

Methods inherited from interface com.icfolson.aem.library.api.Traversable

findAncestor, findAncestor, findAncestorWithProperty, findAncestorWithProperty, findAncestorWithPropertyValue, findAncestorWithPropertyValue, findDescendants

Method Detail

getComponentNode

com.google.common.base.Optional<ComponentNode> getComponentNode(String relativePath)

Get the component node for the resource at the given path relative to the current node.

Parameters:

relativePath - relative path to component

Returns:

Optional node for component

getComponentNodes

List<ComponentNode> getComponentNodes()

Get a list of child nodes for the current node.

Returns:

list of component nodes or empty list if none exist

getComponentNodes

List<ComponentNode> getComponentNodes(com.google.common.base.Predicate<ComponentNode> predicate)

Get a predicate-filtered list of child nodes for the current node.

Parameters:

predicate - predicate used to filter nodes

Returns:

list of component nodes that meet the predicate criteria or empty list if none exist

getComponentNodes

List<ComponentNode> getComponentNodes(String relativePath)

Get a list of child nodes for the resource at the given path relative to this node.

Parameters:

relativePath - relative path to parent of desired nodes

Returns:

list of component nodes below the specified relative path or empty list if none exist

getComponentNodes

List<ComponentNode> getComponentNodes(String relativePath,
                                      String resourceType)

Get a list of child nodes for the resource at the given path relative to this node, returning only the nodes that have the specified resource type.

Parameters:

relativePath - relative path to parent of desired nodes

resourceType - sling:resourceType of nodes to get from parent node

Returns:

list of component nodes matching the given resource type below the specified relative path or empty list if none exist

getComponentNodes

List<ComponentNode> getComponentNodes(String relativePath,
                                      com.google.common.base.Predicate<ComponentNode> predicate)

Get a list of child nodes for the resource at the given path relative to this node, returning only the nodes that meet the predicate criteria.

Parameters:

relativePath - relative path to parent of desired nodes

predicate - predicate used to filter nodes

Returns:

list of component nodes that meet the predicate criteria below the specified relative path or empty list if none exist

getDesignNode

com.google.common.base.Optional<BasicNode> getDesignNode()

Get the design node for the current component.

Returns:

Optional design node for the current style

getComponentNodeInherited

com.google.common.base.Optional<ComponentNode> getComponentNodeInherited(String relativePath)

Get a child node relative to the current node, inheriting from a parent page if it does not exist.

Parameters:

relativePath - path relative to current node

Returns:

direct child node if it exists, otherwise the child node at this relative path for an ancestor page

getComponentNodesInherited

List<ComponentNode> getComponentNodesInherited(String relativePath)

Get the children of a node relative to the current node. If node does not exist relative to current page, inherit from a parent page.

Parameters:

relativePath - path relative to current node

Returns:

list of nodes representing children of the addressed node or inherited from a parent page (or empty list if none exist)

getParent

com.google.common.base.Optional<ComponentNode> getParent()

Get the parent of this node.

Returns:

parent component node or absent optional if resource has no parent