org.fit.layout.classify.taggers

Class TitleTagger

java.lang.Object

org.fit.layout.classify.taggers.TitleTagger

All Implemented Interfaces:

Tagger

public class TitleTagger
extends java.lang.Object
implements Tagger

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.regex.Pattern	areaexpr The expression the whole area must start with
protected java.util.Vector<java.lang.String>	blacklist Words that are not allowed in the presentation title
protected java.util.regex.Pattern	contexpr The expression describing the allowed format of the title continuation
protected int	MIN_WORDS
protected java.util.regex.Pattern	titleexpr The expression describing the allowed title format

Constructor Summary

Constructors

Constructor and Description
TitleTagger()

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.
protected boolean	containsBlacklistedWord(java.lang.String[] words)
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.
protected java.lang.String	getText(Area node)
boolean	mayCoexistWith(Tag other) Check if the area tagged with this tag may be tagged with another tag.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_WORDS

protected final int MIN_WORDS

See Also:

Constant Field Values

areaexpr

protected java.util.regex.Pattern areaexpr

The expression the whole area must start with

titleexpr

protected java.util.regex.Pattern titleexpr

The expression describing the allowed title format

contexpr

protected java.util.regex.Pattern contexpr

The expression describing the allowed format of the title continuation

blacklist

protected java.util.Vector<java.lang.String> blacklist

Words that are not allowed in the presentation title

Constructor Detail

TitleTagger

public TitleTagger()

Method Detail

getTag

public TextTag getTag()

Description copied from interface: Tagger

Obtains the tag that this tagger assigns to the areas.

Specified by:

getTag in interface Tagger

Returns:

the tag string

getRelevance

public double getRelevance()

Description copied from interface: Tagger

Obtains the relevance of the tagger.

Specified by:

getRelevance in interface Tagger

Returns:

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

belongsTo

public boolean belongsTo(Area node)

Description copied from interface: Tagger

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

Specified by:

belongsTo in interface Tagger

Parameters:

node - The examined area node.

Returns:

true if the area should be tagged with the tag

allowsContinuation

public boolean allowsContinuation(Area node)

Description copied from interface: Tagger

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

Specified by:

allowsContinuation in interface Tagger

Parameters:

node - The examined area node.

Returns:

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

allowsJoining

public boolean allowsJoining()

Description copied from interface: Tagger

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

Specified by:

allowsJoining in interface Tagger

Returns:

true if the tag may be used for joining.

mayCoexistWith

public boolean mayCoexistWith(Tag other)

Description copied from interface: Tagger

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.

Specified by:

mayCoexistWith in interface Tagger

extract

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

Description copied from interface: Tagger

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

Specified by:

extract in interface Tagger

Parameters:

src - The source string.

Returns:

A vector of extracted strings.

getText

protected java.lang.String getText(Area node)

containsBlacklistedWord

protected boolean containsBlacklistedWord(java.lang.String[] words)