Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.filtering.impl.configuration
Class DefaultFilterFactory

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.configuration.FilterFactory
      extended by com.genesyslab.platform.apptemplate.filtering.impl.configuration.DefaultFilterFactory

public class DefaultFilterFactory
extends FilterFactory

Factory for the FilterGroup objects. This is default filter implementation. Accepts filter options in a KeyValueCollection.
Uses predefined FilterConfigurationParser objects to handle each option. The result Filter Group may contain one or several DefaultFilter sub filters.
It is possible to customize factory by registering custom FilterConfigurationParser parser: register


Field Summary
static java.lang.String attribute_key
           
static java.lang.String default_filter
           
static java.lang.String inverse_key
           
static java.lang.String message_name_key
           
static java.lang.String trace_off_key
           
static java.lang.String trace_on_key
           
static java.lang.String trace_timeout
           
 
Fields inherited from class com.genesyslab.platform.apptemplate.filtering.impl.configuration.FilterFactory
filter_key, filter_type
 
Constructor Summary
DefaultFilterFactory()
           
 
Method Summary
 boolean applyKeyValueOption(BaseFilter filter, java.lang.String key, java.lang.String value)
          Creates or modifies filter options.
 boolean applyKeyValueOption(FilterGroup filterGroup, java.lang.String subFilter, java.lang.String key, java.lang.String value)
          Creates or modifies filter options.
 FilterGroup create(java.lang.String filterName, KeyValueCollection options)
          Creates filter and apply filter options.
 boolean removeKeyValueOption(BaseFilter filter, java.lang.String key)
          Removes configuration option from the provided filter.
 boolean removeKeyValueOption(FilterGroup filterGroup, java.lang.String subFilter, java.lang.String key)
          Removes configuration option from the provided filter.
static void setCustomParser(java.lang.String key, FilterConfigurationParser parser)
          Sets parser for the custom option.
 
Methods inherited from class com.genesyslab.platform.apptemplate.filtering.impl.configuration.FilterFactory
parseName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

attribute_key

public static final java.lang.String attribute_key
See Also:
Constant Field Values

message_name_key

public static final java.lang.String message_name_key
See Also:
Constant Field Values

inverse_key

public static final java.lang.String inverse_key
See Also:
Constant Field Values

trace_on_key

public static final java.lang.String trace_on_key
See Also:
Constant Field Values

trace_off_key

public static final java.lang.String trace_off_key
See Also:
Constant Field Values

trace_timeout

public static final java.lang.String trace_timeout
See Also:
Constant Field Values

default_filter

public static final java.lang.String default_filter
See Also:
Constant Field Values
Constructor Detail

DefaultFilterFactory

public DefaultFilterFactory()
Method Detail

setCustomParser

public static void setCustomParser(java.lang.String key,
                                   FilterConfigurationParser parser)
Sets parser for the custom option. Expected the the option string must start with unique key that identifies this option.

Parameters:
key - Option identifier.
parser - Option parser for the provided key.

create

public FilterGroup create(java.lang.String filterName,
                          KeyValueCollection options)
Description copied from class: FilterFactory
Creates filter and apply filter options.

Specified by:
create in class FilterFactory

applyKeyValueOption

public boolean applyKeyValueOption(BaseFilter filter,
                                   java.lang.String key,
                                   java.lang.String value)
Description copied from class: FilterFactory
Creates or modifies filter options.

Specified by:
applyKeyValueOption in class FilterFactory
Parameters:
filter - The filter object to which option should be applied.
key - Option name
value - Option value
Returns:
True if option was successfully parsed and applied to filter.

removeKeyValueOption

public boolean removeKeyValueOption(BaseFilter filter,
                                    java.lang.String key)
Description copied from class: FilterFactory
Removes configuration option from the provided filter.

Specified by:
removeKeyValueOption in class FilterFactory
Parameters:
filter - The filter object from which option should be removed.
key - Option name
Returns:
True if option was successfully removed from filter.

applyKeyValueOption

public boolean applyKeyValueOption(FilterGroup filterGroup,
                                   java.lang.String subFilter,
                                   java.lang.String key,
                                   java.lang.String value)
Creates or modifies filter options.

Parameters:
filterGroup - The filter group with subfilters.
subFilter - Name of subfilter where option should be stored.
key - Option name
value - Option value
Returns:
True if option was successfully parsed and applied to subfilter.

removeKeyValueOption

public boolean removeKeyValueOption(FilterGroup filterGroup,
                                    java.lang.String subFilter,
                                    java.lang.String key)
Removes configuration option from the provided filter.

Parameters:
filterGroup - The filter group with subfilters.
subFilter - Name of subfilter from which option should be stored.
key - Option name
Returns:
True if option was successfully removed from subfilter.

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.