|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.jetrix.filter.MessageFilter
public abstract class MessageFilter
Abstract class defining a channel filter. A filter transforms a given message into a list of messages. Concrete filters just need to inherit from this class and implement the process() method.
Field Summary | |
---|---|
protected FilterConfig |
config
|
Constructor Summary | |
---|---|
MessageFilter()
|
Method Summary | |
---|---|
void |
destroy()
Called by the channel to indicate to a filter that the filter is being taken out of service. |
String |
getAuthor()
Returns the author of this filter. |
Channel |
getChannel()
Returns the channel this filter applies on. |
FilterConfig |
getConfig()
Return the configuration used to initialize this filter. |
String |
getDescription()
Returns a short description of this filter. |
String |
getName()
Returns the name of this filter. |
String |
getProperty(String key)
Gets the filter property indicated by the specified key. |
String |
getVersion()
Returns the version of this filter |
void |
init()
Called by the channel to indicate to a filter that the filter is being placed into service. |
boolean |
isShared()
Indicates if the filter is shared or not. |
abstract void |
process(Message m,
List<Message> out)
Process a message and outputs messages to the specified List. |
void |
setChannel(Channel channel)
Sets the channel this filter applies on. |
void |
setConfig(FilterConfig config)
Set the configuration used to initialize this filter. |
void |
setProperty(String key,
String value)
Sets the filter property indicated by the specified key. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected FilterConfig config
Constructor Detail |
---|
public MessageFilter()
Method Detail |
---|
public boolean isShared()
public void init()
public void setConfig(FilterConfig config)
public FilterConfig getConfig()
public void destroy()
public abstract void process(Message m, List<Message> out)
public String getName()
public String getDescription()
public String getVersion()
public String getAuthor()
public final String getProperty(String key)
public final void setProperty(String key, String value)
public final Channel getChannel()
public final void setChannel(Channel channel)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |