org.htmlparser.filters

Class HasChildFilter

Implemented Interfaces:
Cloneable, NodeFilter, Serializable

public class HasChildFilter
extends Object
implements NodeFilter

This class accepts all tags that have a child acceptable to the filter. It can be set to operate recursively, that is perform a scan down through the node heirarchy in a breadth first traversal looking for any descendant that matches the predicate filter (which stops the search).

Field Summary

protected NodeFilter
mChildFilter
The filter to apply to children.
protected boolean
mRecursive
Performs a recursive search down the node heirarchy if true.

Constructor Summary

HasChildFilter()
Creates a new instance of a HasChildFilter.
HasChildFilter(NodeFilter filter)
Creates a new instance of HasChildFilter that accepts nodes with a direct child acceptable to the filter.
HasChildFilter(NodeFilter filter, boolean recursive)
Creates a new instance of HasChildFilter that accepts nodes with a child acceptable to the filter.

Method Summary

boolean
accept(Node node)
Accept tags with children acceptable to the filter.
NodeFilter
getChildFilter()
Get the filter used by this HasParentFilter.
boolean
getRecursive()
Get the recusion setting for the filter.
void
setChildFilter(NodeFilter filter)
Set the filter for this HasParentFilter.
void
setRecursive(boolean recursive)
Sets whether the filter is recursive or not.

Field Details

mChildFilter

protected NodeFilter mChildFilter
The filter to apply to children.

mRecursive

protected boolean mRecursive
Performs a recursive search down the node heirarchy if true.

Constructor Details

HasChildFilter

public HasChildFilter()

HasChildFilter

public HasChildFilter(NodeFilter filter)
Creates a new instance of HasChildFilter that accepts nodes with a direct child acceptable to the filter.
Parameters:
filter - The filter to apply to the children.

HasChildFilter

public HasChildFilter(NodeFilter filter,
                      boolean recursive)
Creates a new instance of HasChildFilter that accepts nodes with a child acceptable to the filter. Of necessity, this applies only to composite tags, i.e. those that can contain other nodes, for example <HTML></HTML>.
Parameters:
filter - The filter to apply to children.
recursive - If true, any enclosed node acceptable to the given filter causes the node being tested to be accepted (i.e. a recursive scan through the child nodes down the node heirarchy is performed).

Method Details

accept

public boolean accept(Node node)
Accept tags with children acceptable to the filter.
Specified by:
accept in interface NodeFilter
Parameters:
node - The node to check.
Returns:
true if the node has an acceptable child, false otherwise.

getChildFilter

public NodeFilter getChildFilter()
Get the filter used by this HasParentFilter.
Returns:
The filter to apply to parents.

getRecursive

public boolean getRecursive()
Get the recusion setting for the filter.
Returns:
Returns true if the filter is recursive up the node heirarchy.

setChildFilter

public void setChildFilter(NodeFilter filter)
Set the filter for this HasParentFilter.
Parameters:
filter - The filter to apply to parents in accept(Node).

setRecursive

public void setRecursive(boolean recursive)
Sets whether the filter is recursive or not.
Parameters:
recursive - The recursion setting for the filter.

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