org.htmlparser.parserapplications.filterbuilder.wrappers

Class OrFilterWrapper

public class OrFilterWrapper extends Filter

Wrapper for OrFilters.
Field Summary
protected SubFilterListmContainer
The drop target container.
protected OrFiltermFilter
The underlying filter.
Constructor Summary
OrFilterWrapper()
Create a wrapper over a new OrFilter.
Method Summary
booleanaccept(Node node)
Predicate to determine whether or not to keep the given node.
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.
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

mContainer

protected SubFilterList mContainer
The drop target container.

mFilter

protected OrFilter mFilter
The underlying filter.

Constructor Detail

OrFilterWrapper

public OrFilterWrapper()
Create a wrapper over a new OrFilter.

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.

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.

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