org.annotation.wordfreak
Interface AnnotationFilter

All Known Implementing Classes:

DefaultAnnotationFilter, MethodAnnotationFilter

public interface AnnotationFilter

Specifies the interface that annotation filters must implement to be applied to annotations by WordFreak.

Field Summary

static java.lang.String	CONFIDENCE Constant indicating that the filter should be applied to an annotation's confidence.
static java.lang.String	EQ Constant indicating that the filter should match is the annotaiton is numerically equal to a specific value.
static java.lang.String	EXACT Constant indicating that the filter should use exact match when determining whether it matches.
static java.lang.String	GT Constant indicating that the filter should match is the annotaiton is numerically greater than a specific value.
static java.lang.String	LT Constant indicating that the filter should match is the annotaiton is numerically less than a specific value.
static java.lang.String	MORPH Constant indicating that the filter should use the morphological root when determining whether it matches.
static java.lang.String	NE Constant indicating that the filter should match is the annotaiton is numerically not equal to a specific value.
static java.lang.String	REGEX Constant indicating that the filter should use a regular expression when determining whether it matches.
static java.lang.String	TEXT Constant indicating that the filter should be applied to an annotation's text.
static java.lang.String	TYPE Constant indicating that the filter should be applied to an annotation's type.

Method Summary

void	addAnnotationFilterListener(AnnotationFilterListener listener) Adds the specified listener to the list of listeners which are notified of changed to this filter.
boolean	match(Annotation a) Return true if the specified annotation matches this filter.
void	removeAnnotationFilterListener(AnnotationFilterListener listener) Removes the specified listener from the list of listeners which are notified of changed to this filter.

Field Detail

CONFIDENCE

public static final java.lang.String CONFIDENCE

Constant indicating that the filter should be applied to an annotation's confidence.

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

Constant indicating that the filter should be applied to an annotation's text.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

Constant indicating that the filter should be applied to an annotation's type.

See Also:

Constant Field Values

EXACT

public static final java.lang.String EXACT

Constant indicating that the filter should use exact match when determining whether it matches.

See Also:

Constant Field Values

REGEX

public static final java.lang.String REGEX

Constant indicating that the filter should use a regular expression when determining whether it matches.

See Also:

Constant Field Values

MORPH

public static final java.lang.String MORPH

Constant indicating that the filter should use the morphological root when determining whether it matches.

See Also:

Constant Field Values

GT

public static final java.lang.String GT

Constant indicating that the filter should match is the annotaiton is numerically greater than a specific value.

See Also:

Constant Field Values

LT

public static final java.lang.String LT

Constant indicating that the filter should match is the annotaiton is numerically less than a specific value.

See Also:

Constant Field Values

EQ

public static final java.lang.String EQ

Constant indicating that the filter should match is the annotaiton is numerically equal to a specific value.

See Also:

Constant Field Values

NE

public static final java.lang.String NE

Constant indicating that the filter should match is the annotaiton is numerically not equal to a specific value.

See Also:

Constant Field Values

Method Detail

addAnnotationFilterListener

public void addAnnotationFilterListener(AnnotationFilterListener listener)

Adds the specified listener to the list of listeners which are notified of changed to this filter.

Parameters:

listener - The object which will be notified.

removeAnnotationFilterListener

public void removeAnnotationFilterListener(AnnotationFilterListener listener)

Removes the specified listener from the list of listeners which are notified of changed to this filter.

Parameters:

listener - The object which will no longer be notified.

match

public boolean match(Annotation a)

Return true if the specified annotation matches this filter.

Parameters:

a - The annotation to apply the filter to.

Returns:

true if the specified annotation matches this filter, false otherwise.