|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.apptemplate.filtering.impl.BaseFilter
com.genesyslab.platform.apptemplate.filtering.impl.FilterGroup
public class FilterGroup
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 |
---|
public FilterGroup(java.lang.String key)
Method Detail |
---|
public boolean isMessageAccepted(Message message, FilterContext context)
BaseFilter
isMessageAccepted
in class BaseFilter
message
- The message to evaluatecontext
- Filter context, where data for message evaluation, like filter variables, can be stored.
public java.util.Set<java.lang.String> getFilterKeys()
public BaseFilter getFilter(java.lang.String key) throws java.lang.NullPointerException
key
- of filter to get.
java.lang.NullPointerException
- if key argument is null.public boolean putFilter(java.lang.String key, BaseFilter filter) throws java.lang.NullPointerException
key
- of filter.filter
- which should be added.
java.lang.NullPointerException
- if any argument is null.
java.lang.IllegalStateException
- when filter group already registered (used).public boolean removeFilter(java.lang.String key) throws java.lang.NullPointerException
key
- of filter which must be removed (if exists).
java.lang.IllegalStateException
- when filter group already registered (used).
java.lang.NullPointerException
- when key argument is null.public void removeAllFilters()
java.lang.IllegalStateException
- when filter group already registered (used).protected void doRegister(FilterContext context)
doRegister
in class BaseFilter
context
- filter context.protected void doUnregister(FilterContext context)
doUnregister
in class BaseFilter
context
- filter context.public java.lang.Object clone()
BaseFilter
clone
in class BaseFilter
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |