net.sf.layoutParser.to.selector

Class FieldMatcherFilter

java.lang.Object

net.sf.layoutParser.to.selector.FieldMatcherFilter

All Implemented Interfaces:

LayoutFilter

public class FieldMatcherFilter
extends Object
implements LayoutFilter

Filters layouts whose field conform to a given regular expression.

Since:

1.4

Author:

Leonardo Bueno Postacchini

Constructor Summary

Constructors

Constructor and Description
FieldMatcherFilter() Do nothing constructor, pattern and field must be set prior to use.
FieldMatcherFilter(Pattern pattern, String field) Initialises the matcher with all data needed.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<LayoutTO>	filter(Collection<LayoutTO> layouts) Filter a collection of layouts and return a sub-set of layouts.
String	getField() The field of the layout that must match the pattern.
Pattern	getNamespace() The pattern that is being used to filter the name spaces.
void	setField(String field) The field of the layout that must match the pattern.
void	setPattern(Pattern pattern) Set the pattern to be used with the namespace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldMatcherFilter

public FieldMatcherFilter()

Do nothing constructor, pattern and field must be set prior to use.

FieldMatcherFilter

public FieldMatcherFilter(Pattern pattern,
                  String field)

Initialises the matcher with all data needed.

Parameters:

pattern - The pattern to be use against the field.

field - The field being tested.

Method Detail

filter

public Collection<LayoutTO> filter(Collection<LayoutTO> layouts)

Description copied from interface: LayoutFilter

Filter a collection of layouts and return a sub-set of layouts.

Specified by:

filter in interface LayoutFilter

Parameters:

layouts - The layouts to be filtered.

Returns:

The filtered subset.

getNamespace

public Pattern getNamespace()

The pattern that is being used to filter the name spaces.

Returns:

The pattern being used.

setPattern

public void setPattern(Pattern pattern)

Set the pattern to be used with the namespace.

Parameters:

pattern - The pattern to be used.

getField

public String getField()

The field of the layout that must match the pattern.

Returns:

The field of the layout that must match.

setField

public void setField(String field)

The field of the layout that must match the pattern.

Parameters:

field - The field of the layout that must match the pattern.