senselogic.sitevision.api.node

Interface NodeFilterUtil

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

Node filter utility interface.

A node filter is used to match a node against one or more criteria as specified by the filter.

• In its simplest form it can replace a null check and an equals check for a certain value of a node (e.g. see getStringPropertyFilter(String, String)).
• In its most complex form it can be a Compound filter that executes multiple checks to deliver the aggregated result of individual filters that are combined together using the logical AND and OR operators in between (e.g. see getCompoundAndFilterBuilder()).

A filter can be used "standalone" to simplify your code, but can also be used in utilities with methods that supports node filters. Examples of such utilities are NodeIteratorUtil and NodeTreeUtil.

A Velocity example

This example uses Velocity to demonstrate how to build a filter that matches image nodes that has a width of at least 700 or a height of at least 500.

    #set ($nodeFilterUtil = $sitevisionUtils.NodeFilterUtil)
    #set ($nodeTypeUtil = $sitevisionUtils.NodeTypeUtil)

    ## Set up individual filters needed
    #set ($imageFilter = $nodeFilterUtil.getPrimaryNodeTypeFilter($nodeTypeUtil.IMAGE_TYPE))
    #set ($minWidthFilter = $nodeFilterUtil.getMinIntPropertyFilter('width', 700))
    #set ($minHeightFilter = $nodeFilterUtil.getMinIntPropertyFilter('height', 500))

    ## The width and the height filters should be logically combined with the OR operator
    #set ($sizeFilterBuilder = $nodeFilterUtil.CompoundOrFilterBuilder)
    #set ($sizeFilter = $sizeFilterBuilder.addFilter($minWidthFilter).addFilter($minHeightFilter).build())

    ## The type and the size filters should be logically combined with the AND operator
    #set ($sizedImageFilterBuilder = $nodeFilterUtil.CompoundAndFilterBuilder)
    #set ($sizedImageFilter = $sizedImageFilterBuilder.addFilter($imageFilter).addFilter($sizeFilter).build())

Now the $sizedImageFilter can be used to match individual nodes, for example:

    #if ($sizedImageFilter.accept($myNode))
       ## Handle matching image
       ...
    #end

The $sizedImageFilter can also be used to match multiple nodes via a filter-supporting utility. NodeIteratorUtil is an example of such utility. It provides support to find the first, all or a given number of matches of the nodes provided by a NodeIterator, for example:

    #set ($nodeIteratorUtil = $sitevisionUtils.NodeIteratorUtil)
    #set ($matches = $nodeIteratorUtil.findNodes($aNodeIterator, $sizedImageFilter, 5)) ## Max 5 matches
    #if (!$matches.isEmpty())
       ## Handle matching images
       ...
    #end

Tip! See Builder for how to work with builders.

Beware of nulls! Invoking the accept method on a node filter with null should always be avoided! Filters returned from this class are forgiving and will typically handle null but the result might be unexpected, depending on what the filter is actually used for. For instance: Invoking a HasPropertyfilter with null will return false (i.e. "null is not accepted"). But consequently will the same filter wrapped in a InvertedFilter return true (i.e. "null is accepted").

Disclaimer! The Property-based filters for the Java native int type (i.e. get*IntPropertyValue) is not guaranteed to always deliver proper result for the native's "edge" values. Such filter invoked with Integer.MIN_VALUE or Integer.MAX_VALUE can under very rare circumstances return false when it actually should have returned true. This is a performance consideration and should under normal circumstances never cause any trouble (the value of a int property for a Node is extremely seldom, if ever, an "edge" value).

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

Since:

Sitevision 3.6.2

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
Filter<Node>	getAfterCalendarPropertyFilter(String aPropertyName, Calendar aAfterThresholdValue) Gets a filter that matches by an after value for a specified Calendar property.
Filter<Node>	getAfterNestedCalendarPropertyFilter(String aNodePropertyName, String aPropertyName, Calendar aAfterThresholdValue) Gets a filter that matches by an after value of a nested node's specified Calendar property.
Filter<Node>	getAlwaysAcceptFilter() Gets a filter that always matches.
Filter<Node>	getAnyOfPrimaryNodeTypesFilter(Collection<String> aPrimaryNodeTypeNames) Gets a filter that matches all nodes that has a primary node type that is present in given collection.
Filter<Node>	getBeforeCalendarPropertyFilter(String aPropertyName, Calendar aBeforeThresholdValue) Gets a filter that matches by a before value for a specified Calendar property.
Filter<Node>	getBeforeNestedCalendarPropertyFilter(String aNodePropertyName, String aPropertyName, Calendar aBeforeThresholdValue) Gets a filter that matches by a before value of a nested node's specified Calendar property.
Filter<Node>	getBooleanPropertyFilter(String aPropertyName, boolean aMatchValue) Gets a filter that matches by a specified boolean property.
Filter<Node>	getCalendarPropertyFilter(String aPropertyName, Calendar aMatchValue) Gets a filter that matches by a specified Calendar property.
CompoundAndFilterBuilder	getCompoundAndFilterBuilder() Gets a builder for creating a compound filter that requires that all of the containing filters matches.
CompoundOrFilterBuilder	getCompoundOrFilterBuilder() Gets a builder for creating a compound filter that requires that any of the containing filters matches.
Filter<Node>	getContainsStringMultiPropertyFilter(String aPropertyName, String aContainsValue) Gets a filter that matches by the value-contains of a specified multi-valued string property.
Filter<Node>	getContainsStringPropertyFilter(String aPropertyName, String aContainsValue) Gets a filter that matches by the value-contains of a specified string property.
Filter<Node>	getDoublePropertyFilter(String aPropertyName, double aMatchValue) Gets a filter that matches by a specified double property.
Filter<Node>	getEndsWithStringPropertyFilter(String aPropertyName, String aEndsWithValue) Gets a filter that matches by the value-ends-with of a specified string property.
Map<Node,?>	getFilteredKeyMap(Map<Node,?> aNodeKeyMap, Filter<Node> aNodeFilter) Applies a node filter to a Map with Node keys and gets the result.
List<Node>	getFilteredList(List<Node> aNodeList, Filter<Node> aNodeFilter) Applies a node filter to a list and gets the result.
Map<?,Node>	getFilteredValueMap(Map<?,Node> aNodeValueMap, Filter<Node> aNodeFilter) Applies a node filter to a Map with Node values and gets the result.
Filter<Node>	getHasPropertyFilter(String aPropertyName) Gets a filter that matches by the existence of a specified property.
Filter<Node>	getIdentifierFilter(String aIdentifier) Gets a filter that matches by a specified node identifier.
Filter<Node>	getIdentifierPrefixFilter(String aIdentifierPrefix) Gets a filter that matches by a specified node identifier prefix.
Filter<Node>	getIdentifierSuffixFilter(String aIdentifierSuffix) Gets a filter that matches by a specified node identifier suffix.
Filter<Node>	getIgnoreCaseStringPropertyFilter(String aPropertyName, String aCaseInsensitiveValue) Gets a filter that matches case-insensitive by a specified string property.
Filter<Node>	getIntPropertyFilter(String aPropertyName, int aMatchValue) Gets a filter that matches by a specified int property.
Filter<Node>	getInvertedFilter(Filter<Node> aFilter) Gets a filter that inverts the result of another filter.
Filter<Node>	getMaxDoublePropertyFilter(String aPropertyName, double aMaxValue) Gets a filter that matches by the max value of a specified double property.
Filter<Node>	getMaxIntPropertyFilter(String aPropertyName, int aMaxValue) Gets a filter that matches by the max value of a specified int property.
Filter<Node>	getMaxNestedIntPropertyFilter(String aNodePropertyName, String aPropertyName, int aMaxValue) Gets a filter that matches by a nested node's max value of a specified int property.
Filter<Node>	getMinDoublePropertyFilter(String aPropertyName, double aMinValue) Gets a filter that matches by the min value of a specified double property.
Filter<Node>	getMinIntPropertyFilter(String aPropertyName, int aMinValue) Gets a filter that matches by the min value of a specified int property.
Filter<Node>	getMinNestedIntPropertyFilter(String aNodePropertyName, String aPropertyName, int aMinValue) Gets a filter that matches by a nested node's min value of a specified int property.
Filter<Node>	getNestedBooleanPropertyFilter(String aNodePropertyName, String aPropertyName, boolean aMatchValue) Gets a filter that matches by a nested node's specified boolean property.
Filter<Node>	getNestedCalendarPropertyFilter(String aNodePropertyName, String aPropertyName, Calendar aMatchValue) Gets a filter that matches by a nested node's specified Calendar property.
Filter<Node>	getNestedDoublePropertyFilter(String aNodePropertyName, String aPropertyName, double aMatchValue) Gets a filter that matches by a nested node's specified double property.
Filter<Node>	getNestedIntPropertyFilter(String aNodePropertyName, String aPropertyName, int aMatchValue) Gets a filter that matches by a nested node's specified int property.
Filter<Node>	getNeverAcceptFilter() Gets a filter that never matches.
Filter<Node>	getNoneOfPrimaryNodeTypesFilter(Collection<String> aExcludedPrimaryNodeTypeNames) Gets a filter that matches all nodes that does not have a primary node type present in given collection.
Filter<Node>	getNonNullFilter() Gets a filter that matches non-null nodes.
Filter<Node>	getNullFilter() Gets a filter that matches null nodes.
Filter<Node>	getPatternStringMultiPropertyFilter(String aPropertyName, String aRegularExpression) Gets a filter that matches by a regular expression of a specified multi-valued string property.
Filter<Node>	getPatternStringPropertyFilter(String aPropertyName, String aRegularExpression) Gets a filter that matches by a regular expression of a specified string property.
Filter<Node>	getPrimaryNodeTypeFilter(String aPrimaryNodeTypeName) Gets a filter that matches by a specified primary node type.
Filter<Node>	getRangeCalendarPropertyFilter(String aPropertyName, Calendar aAfterThresholdValue, Calendar aBeforeThresholdValue) Gets a filter that matches by the between range of a specified Calendar property.
Filter<Node>	getRangeDoublePropertyFilter(String aPropertyName, double aMinValue, double aMaxValue) Gets a filter that matches by the range of a specified double property.
Filter<Node>	getRangeIntPropertyFilter(String aPropertyName, int aMinValue, int aMaxValue) Gets a filter that matches by the range of a specified int property.
Filter<Node>	getRangeNestedCalendarPropertyFilter(String aNodePropertyName, String aPropertyName, Calendar aAfterThresholdValue, Calendar aBeforeThresholdValue) Gets a filter that matches by the between range of a nested node's specified Calendar property.
Filter<Node>	getRangeNestedIntPropertyFilter(String aNodePropertyName, String aPropertyName, int aMinValue, int aMaxValue) Gets a filter that matches by a nested node's range of a specified int property.
Filter<Node>	getSkipFilter(int aSkip) Gets a filter that skips a given number of nodes.
Filter<Node>	getStartsWithStringPropertyFilter(String aPropertyName, String aStartsWithValue) Gets a filter that matches by the value-starts-with of a specified string property.
Filter<Node>	getStringMultiPropertyFilter(String aPropertyName, String aMatchValue) Gets a filter that matches by a specified multi-valued string property.
Filter<Node>	getStringPropertyFilter(String aPropertyName, String aMatchValue) Gets a filter that matches by a specified string property.
FilterSplit<Node>	split(Collection<Node> aNodeCollection, Filter<Node> aNodeFilter) Gets the filtering result of a split operation for a collection of nodes with a node filter as divider.

Method Detail

getFilteredList

List<Node> getFilteredList(List<Node> aNodeList,
                           Filter<Node> aNodeFilter)

Applies a node filter to a list and gets the result.

Parameters:

aNodeList - the list of nodes

aNodeFilter - a node filter

Returns:

a list of all nodes of aNodeList that is accepted by aNodeFilter, never null. aNodeList itself is returned if it's empty or if aNodeFilter is null

getFilteredValueMap

Map<?,Node> getFilteredValueMap(Map<?,Node> aNodeValueMap,
                                Filter<Node> aNodeFilter)

Applies a node filter to a Map with Node values and gets the result.

Parameters:

aNodeValueMap - a map with node values

aNodeFilter - a node filter

Returns:

a Map with all aNodeValueMap entries with a value that is accepted by aNodeFilter, never null. aNodeValueMap itself is returned if it's empty or if aNodeFilter is null

Since:

Sitevision 4.3.1

getFilteredKeyMap

Map<Node,?> getFilteredKeyMap(Map<Node,?> aNodeKeyMap,
                              Filter<Node> aNodeFilter)

Applies a node filter to a Map with Node keys and gets the result.

Parameters:

aNodeKeyMap - a map with node keys

aNodeFilter - a node filter

Returns:

a Map with all aNodeKeyMap entries with a key that is accepted by aNodeFilter, never null. aNodeKeyMap itself is returned if it's empty or if aNodeFilter is null

Since:

Sitevision 4.3.1

split

FilterSplit<Node> split(Collection<Node> aNodeCollection,
                        Filter<Node> aNodeFilter)

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

This method would typically be used instead of getFilteredList(java.util.List, senselogic.sitevision.api.base.Filter) when you are also interested in the nodes that does NOT match the filter.

When nodes are available via a NodeIterator, you would typically use the NodeIteratorUtil.split(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter) instead!

Parameters:

aNodeCollection - a node collection

aNodeFilter - a node filter

Returns:

the result of the filtering operation

Since:

Sitevision 3.6.3

See Also:

NodeIteratorUtil.split(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter)

getCompoundAndFilterBuilder

CompoundAndFilterBuilder getCompoundAndFilterBuilder()

Gets a builder for creating a compound filter that requires that all of the containing filters matches.

The CompoundAndFilterBuilder builds a node filter of multiple filters that are combined using the logical AND operator.

Returns:

a CompoundAndFilterBuilder

getCompoundOrFilterBuilder

CompoundOrFilterBuilder getCompoundOrFilterBuilder()

Gets a builder for creating a compound filter that requires that any of the containing filters matches.

The CompoundOrFilterBuilder builds a node filter of multiple filters that are combined using the logical OR operator.

Returns:

a CompoundOrFilterBuilder

See Also:

getAnyOfPrimaryNodeTypesFilter(Collection)

getAlwaysAcceptFilter

Filter<Node> getAlwaysAcceptFilter()

Gets a filter that always matches.

Returns:

a filter that matches all nodes.

getNeverAcceptFilter

Filter<Node> getNeverAcceptFilter()

Gets a filter that never matches.

Returns:

a filter that never matches any nodes.

getNullFilter

Filter<Node> getNullFilter()

Gets a filter that matches null nodes.

Returns:

a filter that matches null nodes.

Since:

Sitevision 4.3.1

getNonNullFilter

Filter<Node> getNonNullFilter()

Gets a filter that matches non-null nodes.

Returns:

a filter that matches non-null nodes.

Since:

Sitevision 4.3.1

getSkipFilter

Filter<Node> getSkipFilter(int aSkip)
                    throws IllegalArgumentException

Gets a filter that skips a given number of nodes.

Note! The skip filter is typically used in combination with a Compound AND Filter. Example:

• This filter skips 5 nodes, regardless of type:
  

     filter = nodeFilterUtil.getSkipFilter(5);

• This page filter skips 5 nodes (i.e. rejects first 5 sv:page nodes that otherwise would have been accepted):
  

     filter = nodeFilterUtil.getCompoundAndFilterBuilder()
         .addFilter(nodeFilterUtil.getPrimaryNodeTypeFilter("sv:page"))
         .addFilter(nodeFilterUtil.getSkipFilter(5))
         .build();

Also note that this filter is stateful, i.e. a created filter instance can't be used more than one time.

Parameters:

aSkip - the number of nodes to skip

Returns:

a filter that rejects aSkip number of nodes

Throws:

IllegalArgumentException - if aSkip is less than zero

Since:

Sitevision 2025.01.1

getInvertedFilter

Filter<Node> getInvertedFilter(Filter<Node> aFilter)
                        throws IllegalArgumentException

Gets a filter that inverts the result of another filter.

Parameters:

aFilter - the filter to invert

Returns:

a filter that inverts the result

Throws:

IllegalArgumentException - if aFilter is null

getIdentifierFilter

Filter<Node> getIdentifierFilter(String aIdentifier)
                          throws IllegalArgumentException

Gets a filter that matches by a specified node identifier.

Parameters:

aIdentifier - the node identifier

Returns:

a filter that matches all nodes (typically just one) with node identifier aIdentifier

Throws:

IllegalArgumentException - if aIdentifier is null or whitespace only

Since:

Sitevision 4.1

getIdentifierPrefixFilter

Filter<Node> getIdentifierPrefixFilter(String aIdentifierPrefix)
                                throws IllegalArgumentException

Gets a filter that matches by a specified node identifier prefix.

Parameters:

aIdentifierPrefix - the node identifier prefix

Returns:

a filter that matches all nodes with an identifier that starts with aIdentifierPrefix

Throws:

IllegalArgumentException - if aIdentifierPrefix is null or whitespace only

Since:

Sitevision 4.1

getIdentifierSuffixFilter

Filter<Node> getIdentifierSuffixFilter(String aIdentifierSuffix)
                                throws IllegalArgumentException

Gets a filter that matches by a specified node identifier suffix.

Parameters:

aIdentifierSuffix - the node identifier suffix

Returns:

a filter that matches all nodes with an identifier that ends with aIdentifierSuffix

Throws:

IllegalArgumentException - if aIdentifierSuffix is null or whitespace only

Since:

Sitevision 4.1

getPrimaryNodeTypeFilter

Filter<Node> getPrimaryNodeTypeFilter(String aPrimaryNodeTypeName)
                               throws IllegalArgumentException

Gets a filter that matches by a specified primary node type.

Parameters:

aPrimaryNodeTypeName - the primary node type name

Returns:

a filter that matches all nodes that has primary node type aPrimaryNodeTypeName

Throws:

IllegalArgumentException - if aPrimaryNodeTypeName is null or whitespace only

See Also:

getAnyOfPrimaryNodeTypesFilter(Collection), getNoneOfPrimaryNodeTypesFilter(Collection), NodeTypeUtil

getAnyOfPrimaryNodeTypesFilter

Filter<Node> getAnyOfPrimaryNodeTypesFilter(Collection<String> aPrimaryNodeTypeNames)

Gets a filter that matches all nodes that has a primary node type that is present in given collection.

This convenience method is conceptually equivalent - but also more efficient - than building a "match any of" filter via CompoundOrFilter with a number of PrimaryNodeTypeFilters.

Parameters:

aPrimaryNodeTypeNames - a collection of primary node type names, must not be null. Null and blank collection items will be silently ignored (such value are not a valid node type name)

Returns:

a filter that matches all Nodes that has a primary node type that is present in aPrimaryNodeTypeNames.

Throws:

NullPointerException - if aPrimaryNodeTypeNames is null

Since:

Sitevision 8.1

See Also:

getNoneOfPrimaryNodeTypesFilter(Collection), NodeTypeUtil

getNoneOfPrimaryNodeTypesFilter

Filter<Node> getNoneOfPrimaryNodeTypesFilter(Collection<String> aExcludedPrimaryNodeTypeNames)

Gets a filter that matches all nodes that does not have a primary node type present in given collection.

This convenience method is conceptually equivalent - but also more efficient - than building a "match none of" filter via CompoundOrFilter with a number of PrimaryNodeTypeFilters and a InvertedFilter

Parameters:

aExcludedPrimaryNodeTypeNames - a collection of primary node type names, must not be null. Null and blank collection items will be silently ignored (such value are not a valid node type name)

Returns:

a filter that matches all Nodes that does not have a primary node type present in aExcludedPrimaryNodeTypeNames.

Throws:

NullPointerException - if aExcludedPrimaryNodeTypeNames is null

Since:

Sitevision 8.1

See Also:

getAnyOfPrimaryNodeTypesFilter(Collection), NodeTypeUtil

getHasPropertyFilter

Filter<Node> getHasPropertyFilter(String aPropertyName)
                           throws IllegalArgumentException

Gets a filter that matches by the existence of a specified property.

Parameters:

aPropertyName - the name of the property

Returns:

a filter that matches all nodes that has a property named aPropertyName

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only

See Also:

Node.hasProperty(String)

getStringPropertyFilter

Filter<Node> getStringPropertyFilter(String aPropertyName,
                                     String aMatchValue)
                              throws IllegalArgumentException

Gets a filter that matches by a specified string property.

Parameters:

aPropertyName - the name of the property

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a string property named aPropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aPropertyName or aMatchValue is null

See Also:

PropertyUtil.getString(javax.jcr.Node, String)

getStringMultiPropertyFilter

Filter<Node> getStringMultiPropertyFilter(String aPropertyName,
                                          String aMatchValue)
                                   throws IllegalArgumentException

Gets a filter that matches by a specified multi-valued string property.

Parameters:

aPropertyName - the name of the property

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a string property named aPropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aPropertyName or aMatchValue is null

See Also:

PropertyUtil.getStrings(javax.jcr.Node, String)

getIgnoreCaseStringPropertyFilter

Filter<Node> getIgnoreCaseStringPropertyFilter(String aPropertyName,
                                               String aCaseInsensitiveValue)
                                        throws IllegalArgumentException

Gets a filter that matches case-insensitive by a specified string property.

Parameters:

aPropertyName - the name of the property

aCaseInsensitiveValue - the case-insensitive value of the property

Returns:

a filter that matches all nodes that has a string property named aPropertyName with value aCaseInsensitiveValue

Throws:

IllegalArgumentException - if aPropertyName or aCaseInsensitiveValue is null

getStartsWithStringPropertyFilter

Filter<Node> getStartsWithStringPropertyFilter(String aPropertyName,
                                               String aStartsWithValue)
                                        throws IllegalArgumentException

Gets a filter that matches by the value-starts-with of a specified string property.

The starts-with check is performed using the String.startsWith(String) method.

Parameters:

aPropertyName - the name of the property

aStartsWithValue - the value the property should start with

Returns:

a filter that matches all nodes that has a string property named aPropertyName that starts with value aStartsWithValue

Throws:

IllegalArgumentException - if aPropertyName or aStartsWithValue is null

getEndsWithStringPropertyFilter

Filter<Node> getEndsWithStringPropertyFilter(String aPropertyName,
                                             String aEndsWithValue)
                                      throws IllegalArgumentException

Gets a filter that matches by the value-ends-with of a specified string property.

The ends-with check is performed using the String.endsWith(String) method.

Parameters:

aPropertyName - the name of the property

aEndsWithValue - the value the property should end with

Returns:

a filter that matches all nodes that has a string property named aPropertyName that ends with value aEndsWithValue

Throws:

IllegalArgumentException - if aPropertyName or aEndsWithValue is null

getContainsStringPropertyFilter

Filter<Node> getContainsStringPropertyFilter(String aPropertyName,
                                             String aContainsValue)
                                      throws IllegalArgumentException

Gets a filter that matches by the value-contains of a specified string property.

The contains check is performed using the String.contains(String) method.

Parameters:

aPropertyName - the name of the property

aContainsValue - the value the property should contain

Returns:

a filter that matches all nodes that has a string property named aPropertyName that contains value aContainsValue

Throws:

IllegalArgumentException - if aPropertyName or aContainsValue is null

getContainsStringMultiPropertyFilter

Filter<Node> getContainsStringMultiPropertyFilter(String aPropertyName,
                                                  String aContainsValue)
                                           throws IllegalArgumentException

Gets a filter that matches by the value-contains of a specified multi-valued string property.

The contains check is performed using the String.contains(String) method for each extracted property value.

Parameters:

aPropertyName - the name of the property

aContainsValue - the value the property should contain

Returns:

a filter that matches all nodes that has a string property named aPropertyName that contains value aContainsValue

Throws:

IllegalArgumentException - if aPropertyName or aContainsValue is null

getPatternStringPropertyFilter

Filter<Node> getPatternStringPropertyFilter(String aPropertyName,
                                            String aRegularExpression)
                                     throws IllegalArgumentException,
                                            PatternSyntaxException

Gets a filter that matches by a regular expression of a specified string property.

The regular expression is compiled to a Pattern and the check is performed using the matches() method of the Matcher extracted from the compiled pattern via Pattern.matcher(String).

Parameters:

aPropertyName - the name of the property

aRegularExpression - the regular expression

Returns:

a filter that matches all nodes that has a string property named aPropertyName that matches aRegularExpression

Throws:

IllegalArgumentException - if aPropertyName or aRegularExpression is null

PatternSyntaxException - if the compilation of aRegularExpression fails

getPatternStringMultiPropertyFilter

Filter<Node> getPatternStringMultiPropertyFilter(String aPropertyName,
                                                 String aRegularExpression)
                                          throws IllegalArgumentException,
                                                 PatternSyntaxException

Gets a filter that matches by a regular expression of a specified multi-valued string property.

The regular expression is compiled to a Pattern and the check for each extracted property value is performed using the matches() method of the Matcher extracted from the compiled pattern via Pattern.matcher(String).

Parameters:

aPropertyName - the name of the property

aRegularExpression - the regular expression

Returns:

a filter that matches all nodes that has a string property named aPropertyName that matches aRegularExpression

Throws:

IllegalArgumentException - if aPropertyName or aRegularExpression is null

PatternSyntaxException - if the compilation of aRegularExpression fails

getBooleanPropertyFilter

Filter<Node> getBooleanPropertyFilter(String aPropertyName,
                                      boolean aMatchValue)
                               throws IllegalArgumentException

Gets a filter that matches by a specified boolean property.

Parameters:

aPropertyName - the name of the property

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a boolean property named aPropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only

See Also:

PropertyUtil.getBoolean(javax.jcr.Node, String)

getNestedBooleanPropertyFilter

Filter<Node> getNestedBooleanPropertyFilter(String aNodePropertyName,
                                            String aPropertyName,
                                            boolean aMatchValue)
                                     throws IllegalArgumentException

Gets a filter that matches by a nested node's specified boolean property.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only

See Also:

PropertyUtil.getNestedBoolean(javax.jcr.Node, String, String)

getIntPropertyFilter

Filter<Node> getIntPropertyFilter(String aPropertyName,
                                  int aMatchValue)
                           throws IllegalArgumentException

Gets a filter that matches by a specified int property.

Parameters:

aPropertyName - the name of the property

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a int property named aPropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only

See Also:

PropertyUtil.getInt(javax.jcr.Node, String)

getMinIntPropertyFilter

Filter<Node> getMinIntPropertyFilter(String aPropertyName,
                                     int aMinValue)
                              throws IllegalArgumentException

Gets a filter that matches by the min value of a specified int property.

Parameters:

aPropertyName - the name of the property

aMinValue - the min value of the property

Returns:

a filter that matches all nodes that has a int property named aPropertyName with value aMinValue or higher

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only

getMaxIntPropertyFilter

Filter<Node> getMaxIntPropertyFilter(String aPropertyName,
                                     int aMaxValue)
                              throws IllegalArgumentException

Gets a filter that matches by the max value of a specified int property.

Parameters:

aPropertyName - the name of the property

aMaxValue - the max value of the property

Returns:

a filter that matches all nodes that has a int property named aPropertyName with value aMaxValue or lower

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only

getRangeIntPropertyFilter

Filter<Node> getRangeIntPropertyFilter(String aPropertyName,
                                       int aMinValue,
                                       int aMaxValue)
                                throws IllegalArgumentException

Gets a filter that matches by the range of a specified int property.

This is a convenience method that combines the min int filter (getMinIntPropertyFilter(String, int)) and the max int filter (getMinIntPropertyFilter(String, int)) to check a range for an integer.

Parameters:

aPropertyName - the name of the property

aMinValue - the min value of the property

aMaxValue - the max value of the property

Returns:

a filter that matches all nodes that has a int property named aPropertyName with value within inclusive range [aMinValue..aMaxValue]

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only, or if aMinValue is greater than aMaxValue

getNestedIntPropertyFilter

Filter<Node> getNestedIntPropertyFilter(String aNodePropertyName,
                                        String aPropertyName,
                                        int aMatchValue)
                                 throws IllegalArgumentException

Gets a filter that matches by a nested node's specified int property.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only

See Also:

PropertyUtil.getNestedInt(javax.jcr.Node, String, String)

getMinNestedIntPropertyFilter

Filter<Node> getMinNestedIntPropertyFilter(String aNodePropertyName,
                                           String aPropertyName,
                                           int aMinValue)
                                    throws IllegalArgumentException

Gets a filter that matches by a nested node's min value of a specified int property.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aMinValue - the min value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value aMatchValue or higher

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only

See Also:

PropertyUtil.getNestedInt(javax.jcr.Node, String, String)

getMaxNestedIntPropertyFilter

Filter<Node> getMaxNestedIntPropertyFilter(String aNodePropertyName,
                                           String aPropertyName,
                                           int aMaxValue)
                                    throws IllegalArgumentException

Gets a filter that matches by a nested node's max value of a specified int property.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aMaxValue - the max value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value aMatchValue or lower

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only

See Also:

PropertyUtil.getNestedInt(javax.jcr.Node, String, String)

getRangeNestedIntPropertyFilter

Filter<Node> getRangeNestedIntPropertyFilter(String aNodePropertyName,
                                             String aPropertyName,
                                             int aMinValue,
                                             int aMaxValue)
                                      throws IllegalArgumentException

Gets a filter that matches by a nested node's range of a specified int property.

This is a convenience method that combines the nested min int filter (getMinNestedIntPropertyFilter(String, String, int)) and the nested max int filter (getMaxNestedIntPropertyFilter(String, String, int)) to check a range for an integer.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aMinValue - the min value of the property

aMaxValue - the max value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value within inclusive range [aMinValue..aMaxValue]

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only, or if aMinValue is greater than aMaxValue

getDoublePropertyFilter

Filter<Node> getDoublePropertyFilter(String aPropertyName,
                                     double aMatchValue)
                              throws IllegalArgumentException

Gets a filter that matches by a specified double property.

Parameters:

aPropertyName - the name of the property

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a double property named aPropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only

See Also:

PropertyUtil.getDouble(javax.jcr.Node, String)

getNestedDoublePropertyFilter

Filter<Node> getNestedDoublePropertyFilter(String aNodePropertyName,
                                           String aPropertyName,
                                           double aMatchValue)
                                    throws IllegalArgumentException

Gets a filter that matches by a nested node's specified double property.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only

See Also:

PropertyUtil.getNestedDouble(javax.jcr.Node, String, String)

getMinDoublePropertyFilter

Filter<Node> getMinDoublePropertyFilter(String aPropertyName,
                                        double aMinValue)
                                 throws IllegalArgumentException

Gets a filter that matches by the min value of a specified double property.

Parameters:

aPropertyName - the name of the property

aMinValue - the min value of the property

Returns:

a filter that matches all nodes that has a double property named aPropertyName with value aMinValue or higher

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only

getMaxDoublePropertyFilter

Filter<Node> getMaxDoublePropertyFilter(String aPropertyName,
                                        double aMaxValue)
                                 throws IllegalArgumentException

Gets a filter that matches by the max value of a specified double property.

Parameters:

aPropertyName - the name of the property

aMaxValue - the max value of the property

Returns:

a filter that matches all nodes that has a double property named aPropertyName with value aMaxValue or lower

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only

getRangeDoublePropertyFilter

Filter<Node> getRangeDoublePropertyFilter(String aPropertyName,
                                          double aMinValue,
                                          double aMaxValue)
                                   throws IllegalArgumentException

Gets a filter that matches by the range of a specified double property.

This is a convenience method that combines the min double filter (getMinDoublePropertyFilter(String, double)) and the max double filter (getMaxDoublePropertyFilter(String, double)) to check a range for a double.

Parameters:

aPropertyName - the name of the property

aMinValue - the min value of the property

aMaxValue - the max value of the property

Returns:

a filter that matches all nodes that has a double property named aPropertyName with value within inclusive range [aMinValue..aMaxValue]

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only, or if aMinValue is greater than aMaxValue

getCalendarPropertyFilter

Filter<Node> getCalendarPropertyFilter(String aPropertyName,
                                       Calendar aMatchValue)

Gets a filter that matches by a specified Calendar property.

Parameters:

aPropertyName - the name of the property

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a Calendar property named aPropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only, or aMatchValue is null

See Also:

PropertyUtil.getCalendar(javax.jcr.Node, String)

getNestedCalendarPropertyFilter

Filter<Node> getNestedCalendarPropertyFilter(String aNodePropertyName,
                                             String aPropertyName,
                                             Calendar aMatchValue)

Gets a filter that matches by a nested node's specified Calendar property.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aMatchValue - the value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value aMatchValue

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only, or if aMatchValue is null

See Also:

PropertyUtil.getNestedCalendar(javax.jcr.Node, String, String)

getBeforeCalendarPropertyFilter

Filter<Node> getBeforeCalendarPropertyFilter(String aPropertyName,
                                             Calendar aBeforeThresholdValue)

Gets a filter that matches by a before value for a specified Calendar property.

Parameters:

aPropertyName - the name of the property

aBeforeThresholdValue - the before threshold value of the property

Returns:

a filter that matches all nodes that has a Calendar property named aPropertyName with value before aBeforeThresholdValue

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only, or aBeforeThresholdValue is null

getBeforeNestedCalendarPropertyFilter

Filter<Node> getBeforeNestedCalendarPropertyFilter(String aNodePropertyName,
                                                   String aPropertyName,
                                                   Calendar aBeforeThresholdValue)

Gets a filter that matches by a before value of a nested node's specified Calendar property.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aBeforeThresholdValue - the before threshold value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value before aBeforeThresholdValue

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only, or if aBeforeThresholdValue is null

getAfterCalendarPropertyFilter

Filter<Node> getAfterCalendarPropertyFilter(String aPropertyName,
                                            Calendar aAfterThresholdValue)

Gets a filter that matches by an after value for a specified Calendar property.

Parameters:

aPropertyName - the name of the property

aAfterThresholdValue - the after threshold value of the property

Returns:

a filter that matches all nodes that has a Calendar property named aPropertyName with value after aAfterThresholdValue

Throws:

IllegalArgumentException - if aPropertyName is null or whitespace only, or aAfterThresholdValue is null

getAfterNestedCalendarPropertyFilter

Filter<Node> getAfterNestedCalendarPropertyFilter(String aNodePropertyName,
                                                  String aPropertyName,
                                                  Calendar aAfterThresholdValue)

Gets a filter that matches by an after value of a nested node's specified Calendar property.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property for the "inner/nested" Node specified by aNodePropertyName

aAfterThresholdValue - the after threshold value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value after aAfterThresholdValue

Throws:

IllegalArgumentException - if aNodePropertyName or aPropertyName is null or whitespace only, or if aAfterThresholdValue is null

getRangeCalendarPropertyFilter

Filter<Node> getRangeCalendarPropertyFilter(String aPropertyName,
                                            Calendar aAfterThresholdValue,
                                            Calendar aBeforeThresholdValue)

Gets a filter that matches by the between range of a specified Calendar property.

This is a convenience method that combines the after calendar filter (getAfterCalendarPropertyFilter(String, java.util.Calendar)) and the before calendar filter (getBeforeCalendarPropertyFilter(String, java.util.Calendar)) to check a range for a Calendar.

Parameters:

aPropertyName - the name of the property

aAfterThresholdValue - the after threshold value of the property

aBeforeThresholdValue - the before threshold value of the property

Returns:

a filter that matches all nodes that has a Calendar property named aPropertyName with value between exclusive range [aAfterThresholdValue..aBeforeThresholdValue]

Throws:

IllegalArgumentException - IllegalArgumentException if aPropertyName is null or whitespace only, or if aAfterThresholdValue or aBeforeThresholdValue is null, or if aAfterThresholdValue is after aBeforeThresholdValue

getRangeNestedCalendarPropertyFilter

Filter<Node> getRangeNestedCalendarPropertyFilter(String aNodePropertyName,
                                                  String aPropertyName,
                                                  Calendar aAfterThresholdValue,
                                                  Calendar aBeforeThresholdValue)

Gets a filter that matches by the between range of a nested node's specified Calendar property.

This is a convenience method that combines the nested after calendar filter (getAfterNestedCalendarPropertyFilter(String, String, java.util.Calendar)) and the nested before calendar filter (getBeforeNestedCalendarPropertyFilter(String, String, java.util.Calendar)) to check a range for a Calendar.

Parameters:

aNodePropertyName - the name of the property for the Node

aPropertyName - the name of the property

aAfterThresholdValue - the after threshold value of the property

aBeforeThresholdValue - the before threshold value of the property

Returns:

a filter that matches all nodes that has a property named aNodePropertyName that can be resolved as a node, which in turn has a property named aNodePropertyName with value between exclusive range [aAfterThresholdValue..aBeforeThresholdValue]

Throws:

IllegalArgumentException - IllegalArgumentException if aNodePropertyName or aPropertyName is null or whitespace only, or if aAfterThresholdValue or aBeforeThresholdValue is null, or if aAfterThresholdValue is after aBeforeThresholdValue