org.htmlparser.parserapplications.filterbuilder.wrappers

Class StringFilterWrapper

public class StringFilterWrapper extends Filter implements ActionListener, DocumentListener, Runnable

Wrapper for StringFilters.
Field Summary
protected JCheckBoxmCaseSensitivity
The check box for case sensitivity.
protected StringFiltermFilter
The underlying filter.
protected JComboBoxmLocale
Combo box for locale.
protected static Locale[]mLocales
Cached locales.
protected JTextAreamPattern
Text to check for.
Constructor Summary
StringFilterWrapper()
Create a wrapper over a new StringFilter.
Method Summary
booleanaccept(Node node)
Predicate to determine whether or not to keep the given node.
voidactionPerformed(ActionEvent event)
Invoked when an action occurs on the combo box.
voidchangedUpdate(DocumentEvent e)
Handle a change update event.
StringgetDescription()
Get the name of the filter.
StringgetIconSpec()
Get the resource name for the icon.
NodeFiltergetNodeFilter()
Get the underlying node filter object.
NodeFilter[]getSubNodeFilters()
Get the underlying node filter's subordinate filters.
voidinsertUpdate(DocumentEvent e)
Handle an insert update event.
voidremoveUpdate(DocumentEvent e)
Handle a remove update event.
voidrun()
Background thread task to get the available locales.
voidsetNodeFilter(NodeFilter filter, Parser context)
Assign the underlying node filter for this wrapper.
voidsetSubNodeFilters(NodeFilter[] filters)
Assign the underlying node filter's subordinate filters.
StringtoJavaCode(StringBuffer out, int[] context)
Convert this filter into Java code.

Field Detail

mCaseSensitivity

protected JCheckBox mCaseSensitivity
The check box for case sensitivity.

mFilter

protected StringFilter mFilter
The underlying filter.

mLocale

protected JComboBox mLocale
Combo box for locale.

mLocales

protected static Locale[] mLocales
Cached locales.

mPattern

protected JTextArea mPattern
Text to check for.

Constructor Detail

StringFilterWrapper

public StringFilterWrapper()
Create a wrapper over a new StringFilter.

Method Detail

accept

public boolean accept(Node node)
Predicate to determine whether or not to keep the given node. The behaviour based on this outcome is determined by the context in which it is called. It may lead to the node being added to a list or printed out. See the calling routine for details.

Parameters: node The node to test.

Returns: true if the node is to be kept, false if it is to be discarded.

actionPerformed

public void actionPerformed(ActionEvent event)
Invoked when an action occurs on the combo box.

Parameters: event Details about the action event.

changedUpdate

public void changedUpdate(DocumentEvent e)
Handle a change update event.

Parameters: e Details about the change event.

getDescription

public String getDescription()
Get the name of the filter.

Returns: A descriptive name for the filter.

getIconSpec

public String getIconSpec()
Get the resource name for the icon.

Returns: The icon resource specification.

getNodeFilter

public NodeFilter getNodeFilter()
Get the underlying node filter object.

Returns: The node filter object suitable for serialization.

getSubNodeFilters

public NodeFilter[] getSubNodeFilters()
Get the underlying node filter's subordinate filters.

Returns: The node filter object's contained filters.

insertUpdate

public void insertUpdate(DocumentEvent e)
Handle an insert update event.

Parameters: e Details about the insert event.

removeUpdate

public void removeUpdate(DocumentEvent e)
Handle a remove update event.

Parameters: e Details about the remove event.

run

public void run()
Background thread task to get the available locales.

setNodeFilter

public void setNodeFilter(NodeFilter filter, Parser context)
Assign the underlying node filter for this wrapper.

Parameters: filter The filter to wrap. context The parser to use for conditioning this filter. Some filters need contextual information to provide to the user, i.e. for tag names or attribute names or values, so the Parser context is provided.

setSubNodeFilters

public void setSubNodeFilters(NodeFilter[] filters)
Assign the underlying node filter's subordinate filters.

Parameters: filters The filters to insert into the underlying node filter.

toJavaCode

public String toJavaCode(StringBuffer out, int[] context)
Convert this filter into Java code. Output whatever text necessary and return the variable name.

Parameters: out The output buffer. context Three integers as follows:

  • indent level - the number of spaces to insert at the beginning of each line
  • filter number - the next available filter number
  • filter array number - the next available array of filters number
  • Returns: The variable name to use when referencing this filter (usually "filter" + context[1]++)

    HTML Parser is an open source library released under LGPL. SourceForge.net