com.usefullittlethings.saw.apps.shared
Class AbstractFilterPlugin

java.lang.Object
  |
  +--java.util.Observable
        |
        +--com.usefullittlethings.saw.apps.shared.AbstractPlugin
              |
              +--com.usefullittlethings.saw.apps.shared.AbstractFilterPlugin
All Implemented Interfaces:
FilterPluginIfc, PluginIfc
Direct Known Subclasses:
AbstractFileFilterPlugin

public abstract class AbstractFilterPlugin
extends AbstractPlugin
implements FilterPluginIfc

Abstract implementation of an FilterPluginIfc to include a default configure method, a default toXMLString, and get/setOperation methods.


Field Summary
 
Fields inherited from interface com.usefullittlethings.saw.model.FilterPluginIfc
CLASS_NAME, EXCLUDE, INCLUDE
 
Fields inherited from interface com.usefullittlethings.saw.model.PluginIfc
BLOCK, LINEAR, SINGLE_BLOCK, UNSUPPORTED
 
Constructor Summary
AbstractFilterPlugin()
           
 
Method Summary
 void configure(java.lang.String xml)
          Used by the load process to configure the plug-in's state so that its state may be restored.
 int getOperation()
          Returns the operation type currently assigned to this filter (include/exclude).
 void setOperation(int type)
          Sets the operation type for this filter to INCLUDE or EXCLUDE.
 java.lang.String toXMLString(int indent)
          Renders the state of the plug-in in XML format.
 
Methods inherited from class com.usefullittlethings.saw.apps.shared.AbstractPlugin
clone, decodeXML, decodeXMLBoolean, encodeXML, getAuthor, getEmail, getName, getShortName, getState, getUI, getWebsite, hasUI, isEnabled, reset, setBase, setEnabled, supportCommandLine, supports
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.usefullittlethings.saw.model.FilterPluginIfc
begin, end, exclude, include, setBase
 
Methods inherited from interface com.usefullittlethings.saw.model.PluginIfc
addObserver, clone, configure, deleteObserver, getAuthor, getEmail, getName, getResultClass, getShortName, getState, getUI, getUnixName, getWebsite, hasUI, isEnabled, reset, setEnabled, supportCommandLine, supports
 

Constructor Detail

AbstractFilterPlugin

public AbstractFilterPlugin()
Method Detail

getOperation

public int getOperation()
Returns the operation type currently assigned to this filter (include/exclude).

Specified by:
getOperation in interface FilterPluginIfc
Returns:
INCLUDE/EXCLUDE operation type

setOperation

public void setOperation(int type)
Sets the operation type for this filter to INCLUDE or EXCLUDE.

Specified by:
setOperation in interface FilterPluginIfc
Parameters:
type - The type of operation to perform with this filter (INCLUDE or EXCLUDE)

toXMLString

public java.lang.String toXMLString(int indent)
Description copied from interface: PluginIfc
Renders the state of the plug-in in XML format.

Specified by:
toXMLString in interface PluginIfc
Overrides:
toXMLString in class AbstractPlugin

configure

public void configure(java.lang.String xml)
               throws java.text.ParseException
Description copied from interface: PluginIfc
Used by the load process to configure the plug-in's state so that its state may be restored.

Specified by:
configure in interface PluginIfc
java.text.ParseException