com.day.cq.wcm.msm.commons

Class ItemFilterUtil

java.lang.Object

com.day.cq.wcm.msm.commons.ItemFilterUtil

public class ItemFilterUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	EMPTY_PROPERTIES
static String[]	EXCLUDED_NODE_TYPES_DEFAULT
static String[]	EXCLUDED_PARAGRAPH_ITEMS_DEFAULT
static String[]	EXCLUDED_PROPERTIES_DEFAULT
static String	PARAMETER_EXCLUDED_NODE_TYPES Excluded node types parameter name to use for your Service Configuration.
static String	PARAMETER_EXCLUDED_PARAGRAPH_ITEMS Excluded paragraph items parameter name to use for your Service Configuration.
static String	PARAMETER_EXCLUDED_PROPERTIES Excluded properties parameter name to use for your Service Configuration.

Constructor Summary

Constructors

Constructor and Description
ItemFilterUtil()

Method Summary

Modifier and Type	Method and Description
static ItemFilterImpl	createComponentFilter(Dictionary properties, RolloutManager rolloutManager) Creates an ItemFilterImpl from the given Properties with the name PARAMETER_EXCLUDED_NODE_TYPES and PARAMETER_EXCLUDED_PARAGRAPH_ITEMS Properties default to empty.
static ItemFilterImpl	createComponentFilter(ValueMap config, RolloutManager rolloutManager) Helper method to create a component filter using a ValueMap
static ItemFilterImpl	createFilter(String[] nodeTypes, String[] nodeNames, String[] propertyNames, RolloutManager rolloutManager) Creates an ItemFilterImpl based on a set of patterns that will be used to match NodeTypes, Node names and Property names.
static ItemFilterImpl	createPageFilter(Dictionary properties, RolloutManager rolloutManager) Creates an ItemFilterImpl from the given Properties with the name PARAMETER_EXCLUDED_NODE_TYPES and PARAMETER_EXCLUDED_PROPERTIES Properties default to empty.
static ItemFilterImpl	createPageFilter(ValueMap config, RolloutManager rolloutManager) Helper method to create a page filter using a ValueMap

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_PROPERTIES

public static final String[] EMPTY_PROPERTIES

PARAMETER_EXCLUDED_PROPERTIES

public static final String PARAMETER_EXCLUDED_PROPERTIES

Excluded properties parameter name to use for your Service Configuration.

See Also:

Constant Field Values

EXCLUDED_PROPERTIES_DEFAULT

public static final String[] EXCLUDED_PROPERTIES_DEFAULT

PARAMETER_EXCLUDED_PARAGRAPH_ITEMS

public static final String PARAMETER_EXCLUDED_PARAGRAPH_ITEMS

Excluded paragraph items parameter name to use for your Service Configuration.

See Also:

Constant Field Values

EXCLUDED_PARAGRAPH_ITEMS_DEFAULT

public static final String[] EXCLUDED_PARAGRAPH_ITEMS_DEFAULT

PARAMETER_EXCLUDED_NODE_TYPES

public static final String PARAMETER_EXCLUDED_NODE_TYPES

Excluded node types parameter name to use for your Service Configuration.

See Also:

Constant Field Values

EXCLUDED_NODE_TYPES_DEFAULT

public static final String[] EXCLUDED_NODE_TYPES_DEFAULT

Constructor Detail

ItemFilterUtil

public ItemFilterUtil()

Method Detail

createPageFilter

public static ItemFilterImpl createPageFilter(Dictionary properties,
                                              RolloutManager rolloutManager)

Creates an ItemFilterImpl from the given Properties with the name PARAMETER_EXCLUDED_NODE_TYPES and PARAMETER_EXCLUDED_PROPERTIES
Properties default to empty.

Parameters:

properties - used for configuration

rolloutManager - to access the roll-out reserved settings.

Returns:

ItemFilterImpl.

createComponentFilter

public static ItemFilterImpl createComponentFilter(Dictionary properties,
                                                   RolloutManager rolloutManager)

Creates an ItemFilterImpl from the given Properties with the name PARAMETER_EXCLUDED_NODE_TYPES and PARAMETER_EXCLUDED_PARAGRAPH_ITEMS
Properties default to empty.

Parameters:

properties - used for configuration

rolloutManager - to access the roll-out reserved settings.

Returns:

ItemFilterImpl.

createPageFilter

public static ItemFilterImpl createPageFilter(ValueMap config,
                                              RolloutManager rolloutManager)

Helper method to create a page filter using a ValueMap

Parameters:

config - ValueMap of configuration

rolloutManager - RolloutManager rolloutManager

Returns:

ItemFilterImpl

See Also:

createPageFilter(java.util.Dictionary, com.day.cq.wcm.msm.api.RolloutManager)

createComponentFilter

public static ItemFilterImpl createComponentFilter(ValueMap config,
                                                   RolloutManager rolloutManager)

Helper method to create a component filter using a ValueMap

Parameters:

config - ValueMap of configuration

rolloutManager - RolloutManager rolloutManager

Returns:

ItemFilterImpl

See Also:

createComponentFilter(java.util.Dictionary, com.day.cq.wcm.msm.api.RolloutManager)

createFilter

public static ItemFilterImpl createFilter(String[] nodeTypes,
                                          String[] nodeNames,
                                          String[] propertyNames,
                                          RolloutManager rolloutManager)

Creates an ItemFilterImpl based on a set of patterns that will be used to match NodeTypes, Node names and Property names.

Parameters:

nodeTypes - RegExp pattern of NodeType names to filter

nodeNames - RegExp pattern of Node names to filter

propertyNames - RegExp pattern of Property Names to filter

rolloutManager - a RolloutManager to serve as the default filter if the above pattern sets are empty

Returns:

an ItemFilterImpl instance