org.fit.layout.classify

Interface Tagger

All Known Implementing Classes:

DateTagger, LocationsTagger, PagesTagger, PersonsTagger, SessionTagger, TimeTagger, TitleTagger

public interface Tagger

A generic tagger that is able to assign tags to areas.

Author:

burgetr

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsContinuation(Area node) Checks whether the area may be a continuation of a previously started area tagged with this tag.
boolean	allowsJoining() Checks whether the tag may be used for joining the areas in the visual area tree.
boolean	belongsTo(Area node) Checks whether the area may be tagged with the tag.
java.util.Vector<java.lang.String>	extract(java.lang.String src) Extracts the parts of a source string that correspond to this tag.
double	getRelevance() Obtains the relevance of the tagger.
TextTag	getTag() Obtains the tag that this tagger assigns to the areas.
boolean	mayCoexistWith(Tag other) Check if the area tagged with this tag may be tagged with another tag.

Method Detail

getTag

TextTag getTag()

Obtains the tag that this tagger assigns to the areas.

Returns:

the tag string

getRelevance

double getRelevance()

Obtains the relevance of the tagger.

Returns:

the relevance (0.0 no relevance, 1.0 means absolutely sure)

belongsTo

boolean belongsTo(Area node)

Checks whether the area may be tagged with the tag. This method does not actually assign the tag to the area.

Parameters:

node - The examined area node.

Returns:

true if the area should be tagged with the tag

allowsContinuation

boolean allowsContinuation(Area node)

Checks whether the area may be a continuation of a previously started area tagged with this tag.

Parameters:

node - The examined area node.

Returns:

true if the area may be a continuation of a tagged area

allowsJoining

boolean allowsJoining()

Checks whether the tag may be used for joining the areas in the visual area tree.

Returns:

true if the tag may be used for joining.

mayCoexistWith

boolean mayCoexistWith(Tag other)

Check if the area tagged with this tag may be tagged with another tag. If not, this tag won't be used for the areas already tagged with another tag.

extract

java.util.Vector<java.lang.String> extract(java.lang.String src)

Extracts the parts of a source string that correspond to this tag.

Parameters:

src - The source string.

Returns:

A vector of extracted strings.