senselogic.sitevision.api.node.builder

Interface CompoundOrFilterBuilder

All Superinterfaces:

Builder<Filter<Node>>

@Requireable(value="CompoundOrFilterBuilder")
public interface CompoundOrFilterBuilder
extends Builder<Filter<Node>>

Builds a compound filter that requires that any of the added filters matches.

How a compound OR filter works: If filter A and filter B is added to this builder, then the accept method of the built filter will return the result of the logical boolean evaluation of: A.accept OR B.accept.

• See NodeFilterUtil for an example of how to use a CompoundOrFilterBuilder in Velocity.
• See Builder for a comprehensive example of how to work with builders.

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

Since:

Sitevision 3.6.2

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
CompoundOrFilterBuilder	addFilter(Filter<Node> aFilter) Adds a node filter to this builder.
Filter<Node>	build() Creates a node filter instance that will perform the OR operation for all currently specified filters.
CompoundOrFilterBuilder	clearFilters() Removes all previously added filters.

Method Detail

addFilter

CompoundOrFilterBuilder addFilter(Filter<Node> aFilter)

Adds a node filter to this builder.

Tip! For best performance, it's likely a good idea to add the "cheapest" filter first!

Parameters:

aFilter - the node filter to add, null will be ignored

Returns:

this builder

clearFilters

CompoundOrFilterBuilder clearFilters()

Removes all previously added filters.

Returns:

this builder

build

Filter<Node> build()
            throws IllegalStateException

Creates a node filter instance that will perform the OR operation for all currently specified filters.

Specified by:

build in interface Builder<Filter<Node>>

Returns:

a node filter

Throws:

IllegalStateException - if this builder contains no filters.