senselogic.sitevision.api.node.builder

Interface CompoundAndFilterBuilder

All Superinterfaces:

Builder<Filter<Node>>

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

Builds a compound filter that requires that all added filters matches.

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

• See NodeFilterUtil for an example of how to use a CompoundAndFilterBuilder 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.getCompoundAndFilterBuilder(). 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
CompoundAndFilterBuilder	addFilter(Filter<Node> aFilter) Adds a node filter to this builder.
Filter<Node>	build() Creates a node filter instance that will perform the AND operation for all currently specified filters.
CompoundAndFilterBuilder	clearFilters() Removes all previously added filters.

Method Detail

addFilter

CompoundAndFilterBuilder 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

CompoundAndFilterBuilder clearFilters()

Removes all previously added filters.

Returns:

this builder

build

Filter<Node> build()
            throws IllegalStateException

Creates a node filter instance that will perform the AND 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.