Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.filtering.impl
Class FilterGroup

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.BaseFilter
      extended by com.genesyslab.platform.apptemplate.filtering.impl.FilterGroup
All Implemented Interfaces:
java.lang.Cloneable

public class FilterGroup
extends BaseFilter
implements java.lang.Cloneable

Groups elementary filter objects to perform complex message filtering operations, for example to trace messages by stored variable value from another message.


Constructor Summary
FilterGroup(java.lang.String key)
           
 
Method Summary
 java.lang.Object clone()
          Clones this message filter.
protected  void doRegister(FilterContext context)
          Registers filter variables and so on.
protected  void doUnregister(FilterContext context)
          Unregisters filter variables and so on.
 BaseFilter getFilter(java.lang.String key)
          Gets filter by key.
 java.util.Set<java.lang.String> getFilterKeys()
          Gets filter keys.
 boolean isMessageAccepted(Message message, FilterContext context)
          Evaluates whether message is accepted by filter.
 boolean putFilter(java.lang.String key, BaseFilter filter)
          Adds/Replaces filter by key.
 void removeAllFilters()
          Removes all filters.
 boolean removeFilter(java.lang.String key)
          Removes filter by key.
 
Methods inherited from class com.genesyslab.platform.apptemplate.filtering.impl.BaseFilter
getKey, isRegistered
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterGroup

public FilterGroup(java.lang.String key)
Method Detail

isMessageAccepted

public boolean isMessageAccepted(Message message,
                                 FilterContext context)
Description copied from class: BaseFilter
Evaluates whether message is accepted by filter.

Specified by:
isMessageAccepted in class BaseFilter
Parameters:
message - The message to evaluate
context - Filter context, where data for message evaluation, like filter variables, can be stored.
Returns:
true if message should be accepted else - false.

getFilterKeys

public java.util.Set<java.lang.String> getFilterKeys()
Gets filter keys.

Returns:
Set of filter keys.

getFilter

public BaseFilter getFilter(java.lang.String key)
                     throws java.lang.NullPointerException
Gets filter by key.

Parameters:
key - of filter to get.
Returns:
filter.
Throws:
java.lang.NullPointerException - if key argument is null.

putFilter

public boolean putFilter(java.lang.String key,
                         BaseFilter filter)
                  throws java.lang.NullPointerException
Adds/Replaces filter by key.

Parameters:
key - of filter.
filter - which should be added.
Returns:
true if filter was added or false if it replaced other filter.
Throws:
java.lang.NullPointerException - if any argument is null.
java.lang.IllegalStateException - when filter group already registered (used).

removeFilter

public boolean removeFilter(java.lang.String key)
                     throws java.lang.NullPointerException
Removes filter by key.

Parameters:
key - of filter which must be removed (if exists).
Returns:
true if removed else false.
Throws:
java.lang.IllegalStateException - when filter group already registered (used).
java.lang.NullPointerException - when key argument is null.

removeAllFilters

public void removeAllFilters()
Removes all filters.

Throws:
java.lang.IllegalStateException - when filter group already registered (used).

doRegister

protected void doRegister(FilterContext context)
Registers filter variables and so on.

Overrides:
doRegister in class BaseFilter
Parameters:
context - filter context.

doUnregister

protected void doUnregister(FilterContext context)
Unregisters filter variables and so on.

Overrides:
doUnregister in class BaseFilter
Parameters:
context - filter context.

clone

public java.lang.Object clone()
Description copied from class: BaseFilter
Clones this message filter.

Overrides:
clone in class BaseFilter
Returns:
clone of this message filter.

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.