senselogic.sitevision.api.node

Interface NodeIteratorUtil

@Requireable(value="NodeIteratorUtil")
public interface NodeIteratorUtil

Node iterator utility interface.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getNodeIteratorUtil(). See Utils for how to obtain an instance of the Utils interface.

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
List<Node>	findAll(NodeIterator aNodeIterator, Filter<Node> aFilter) Gets a list of all nodes from a node iterator that matches a specified filter.
Node	findFirst(NodeIterator aNodeIterator, Filter<Node> aFilter) Gets the first node from a node iterator that matches a specified filter.
List<Node>	findMoreNodes(NodeIterator aNodeIterator, Filter<Node> aFilter, int aSkip, int aLimit) Gets a max-sized node list from a node iterator that matches a specified filter, skipping a specified number of matching nodes.
List<Node>	findNodes(NodeIterator aNodeIterator, Filter<Node> aFilter, int aLimit) Gets a max-sized node list from a node iterator that matches a specified filter.
NodeIterator	getFilteredNodeIterator(NodeIterator aNodeIterator, Filter<Node> aFilter) Gets a filtered NodeIterator.
NodeIterator	getMenuItems(Node aParent) Gets an iterator for default menu items (i.e. non-hidden pages, link pages etc. where current user has read permission)
NodeIterator	getMenuItemsByIdentifier(String aIdentifier) Gets an iterator for default menu items via a node identifier.
NodeIterator	getMenuItemsIncludingFolders(Node aParent) Gets an iterator for default menu items (i.e. getMenuItems(Node)), including folders
NodeIterator	getMenuItemsIncludingFoldersByIdentifier(String aIdentifier) Gets an iterator for default menu items (including folders) via a node identifier.
NodeIterator	getNodeIteratorByIdentifier(String aIdentifier) Gets a node iterator via a node identifier.
FilterSplit<Node>	split(NodeIterator aNodeIterator, Filter<Node> aFilter) Gets the filtering result of a split operation for a node iterator with a node filter as divider.
List<Node>	toList(NodeIterator aNodeIterator) Gets a list of all nodes of a node iterator.

Method Detail

getFilteredNodeIterator

NodeIterator getFilteredNodeIterator(NodeIterator aNodeIterator,
                                     Filter<Node> aFilter)

Gets a filtered NodeIterator.

This NodeIterator decorates a NodeIterator with a Filter, i.e. it will only return nodes that matches given filter.

This server-side Javascript example demonstrates how to create a node iterator that is very similar to the MenuItems iterator but this node iterator is not respecting the "visibleInMenus" property.

    const nodeFilterUtil = require('NodeFilterUtil');
    const nodeIteratorUtil = require('NodeIteratorUtil');
    const startNode = ...

    const filter = nodeFilterUtil.getAnyOfPrimaryNodeTypesFilter([
       'sv:page', 'sv:structurePage', 'sv:article', 'sv:link', 'sv:structureLink', 'sv:collaborationGroupPage'
    ]);
    const nodes = nodeIteratorUtil.getFilteredNodeIterator(startNode.getNodes(), filter);

    while (nodes.hasNext()) {
       let node = nodes.nextNode();
       ...
    }

Parameters:

aNodeIterator - a NodeIterator, must not be null

aFilter - a Node Filter, must not be null

Returns:

a filtered NodeIterator

Throws:

NullPointerException - if aNodeIterator or aFilter is null

Since:

Sitevision 8.1

See Also:

NodeFilterUtil

getNodeIteratorByIdentifier

NodeIterator getNodeIteratorByIdentifier(String aIdentifier)

Gets a node iterator via a node identifier.

The purpose of this method is twofold:

• Convenience. This method combines ResourceLocatorUtil.getNodeByIdentifier(String) and Node.getNodes(), i.e. a shortcut to get an iterator without having to actually lookup/resolve the parent node.
• Permission workaround. This method does not do any permission checks on the resolved parent Node, i.e. a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.

Parameters:

aIdentifier - a node identifier

Returns:

a NodeIterator for the sub nodes of the Node resolved via aIdentifier, or null if indeterminable

Since:

Sitevision 4.0.2

getMenuItems

NodeIterator getMenuItems(Node aParent)

Gets an iterator for default menu items (i.e. non-hidden pages, link pages etc. where current user has read permission)

Parameters:

aParent - the base node for the iterator

Returns:

a NodeIterator for the sub nodes of aParent, or null if indeterminable (i.e. aParent is not a Node in the page tree)

getMenuItemsByIdentifier

NodeIterator getMenuItemsByIdentifier(String aIdentifier)

Gets an iterator for default menu items via a node identifier.

The purpose of this method is twofold:

• Convenience. This method combines ResourceLocatorUtil.getNodeByIdentifier(String) and getMenuItems(Node), i.e. a shortcut to get a menu iterator without having to actually lookup/resolve the parent node.
• Permission workaround. This method does not do any permission checks on the resolved parent Node, i.e. a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.

Parameters:

aIdentifier - a node identifier

Returns:

a NodeIterator for the sub nodes of the Node resolved via aIdentifier, or null if indeterminable

Since:

Sitevision 4.0.2

See Also:

getMenuItems(Node)

getMenuItemsIncludingFolders

NodeIterator getMenuItemsIncludingFolders(Node aParent)

Gets an iterator for default menu items (i.e. getMenuItems(Node)), including folders

Parameters:

aParent - the base node for the iterator

Returns:

a NodeIterator for the sub nodes of aParent, or null if indeterminable (i.e. aParent is not a Node in the page tree)

See Also:

getMenuItems(Node)

getMenuItemsIncludingFoldersByIdentifier

NodeIterator getMenuItemsIncludingFoldersByIdentifier(String aIdentifier)

Gets an iterator for default menu items (including folders) via a node identifier.

The purpose of this method is twofold:

• Convenience. This method combines ResourceLocatorUtil.getNodeByIdentifier(String) and getMenuItemsIncludingFolders(Node), i.e. a shortcut to get a menu iterator without having to actually lookup/resolve the parent node.
• Permission workaround. This method does not do any permission checks on the resolved parent Node, i.e. a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.

Parameters:

aIdentifier - a node identifier

Returns:

a NodeIterator for the sub nodes of the Node resolved via aIdentifier, or null if indeterminable

Since:

Sitevision 4.0.2

See Also:

getMenuItemsIncludingFolders(Node)

findFirst

Node findFirst(NodeIterator aNodeIterator,
               Filter<Node> aFilter)

Gets the first node from a node iterator that matches a specified filter.

Tip! Use NodeFilterUtil to get an appropriate node filter.

Parameters:

aNodeIterator - a node iterator

aFilter - a node filter

Returns:

first node that matches aFilter, or null. If aFilter is null, the filter will be ignored (all nodes will be accepted). If aNodeIterator is null, null will be returned.

Since:

Sitevision 3.6.2

findNodes

List<Node> findNodes(NodeIterator aNodeIterator,
                     Filter<Node> aFilter,
                     int aLimit)

Gets a max-sized node list from a node iterator that matches a specified filter.

Tip! Use NodeFilterUtil to get an appropriate node filter. If the list of nodes should be sorted by a specific property value, you would typically use NodeComparatorUtil to get an appropriate Comparator.

Parameters:

aNodeIterator - a node iterator

aFilter - a node filter

aLimit - max number of nodes to include in the result

Returns:

a list of nodes that matches aFilter, never null. The list will contain at most aLimit nodes. If aNodeIterator is null, an empty list will be returned. If aFilter is null, the filter will be ignored (all nodes will be accepted). If aLimit is negative or zero, an empty list will be returned.

Since:

Sitevision 3.6.2

findMoreNodes

List<Node> findMoreNodes(NodeIterator aNodeIterator,
                         Filter<Node> aFilter,
                         int aSkip,
                         int aLimit)

Gets a max-sized node list from a node iterator that matches a specified filter, skipping a specified number of matching nodes.

Executing findMoreNodes(nodeIterator, filter, 0, 10) is conceptually equivalent to executing findNodes(nodeIterator, filter, 10).

Tip! Use NodeFilterUtil to get an appropriate node filter.

Parameters:

aNodeIterator - a node iterator

aFilter - a node filter

aSkip - number of matching nodes to skip

aLimit - max number of nodes to include in the result

Returns:

a list of nodes that matches aFilter, never null. The list will contain at most aLimit number of nodes and aSkip number of nodes will be ignored. If aNodeIterator is null, an empty list will be returned. If aFilter is null, the filter will be ignored (all nodes will be accepted). If aSkip is negative or zero, no nodes will be skipped. If aLimit is negative or zero, an empty list will be returned.

Since:

Sitevision 2025.01.1

findAll

List<Node> findAll(NodeIterator aNodeIterator,
                   Filter<Node> aFilter)

Gets a list of all nodes from a node iterator that matches a specified filter.

Executing findAll(nodeIterator, null) is conceptually equivalent to executing toList(nodeIterator).

Tip! Use NodeFilterUtil to get an appropriate node filter. If the list of nodes should be sorted by a specific property value, you would typically use NodeComparatorUtil to get an appropriate Comparator.

Parameters:

aNodeIterator - a node iterator

aFilter - a node filter

Returns:

a list of nodes that matches aFilter, never null. If aFilter is null, the filter will be ignored (all nodes will be accepted). If aNodeIterator is null, an empty list will be returned.

Since:

Sitevision 3.6.2

toList

List<Node> toList(NodeIterator aNodeIterator)

Gets a list of all nodes of a node iterator.

Note! This is a convenience method to use only when you must get nodes as a list! The only apparent reason is when you need need to sort the nodes! If you don't, you should use the NodeIterator instead and do your processing for each node.

Sorting tip! When the list of nodes should be sorted by a specific property value, you would typically use NodeComparatorUtilto get an appropriate Comparator. The list can then be sorted by Collections.sort(List, Comparator). When using Velocity, you must use the non-static class CollectionsInstance.

Parameters:

aNodeIterator - a node iterator

Returns:

a list of all nodes provided by aNodeIterator, never null.

Since:

Sitevision 3.6.2

split

FilterSplit<Node> split(NodeIterator aNodeIterator,
                        Filter<Node> aFilter)

Gets the filtering result of a split operation for a node iterator with a node filter as divider.

This method would typically be used instead of findAll(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter) when you are also interested in the nodes that does NOT match the filter.

Note! If aFilter is null, no nodes will match (all nodes gathered via aNodeIterator will be rejected in the resulting filter split).

Parameters:

aNodeIterator - a node iterator

aFilter - a node filter

Returns:

the filtering result

Since:

Sitevision 3.6.3

See Also:

NodeFilterUtil.split(java.util.Collection, senselogic.sitevision.api.base.Filter)