org.fit.layout.classify.taggers

Class TitleTagger

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.classify.taggers.BaseTagger

org.fit.layout.classify.taggers.TitleTagger

All Implemented Interfaces:

org.fit.layout.api.ParametrizedOperation, org.fit.layout.api.Service, Tagger

public class TitleTagger
extends BaseTagger

Nested Class Summary

Nested classes/interfaces inherited from interface org.fit.layout.api.ParametrizedOperation

org.fit.layout.api.ParametrizedOperation.ValueType

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
TitleTagger()

Method Summary

Modifier and Type	Method and Description
boolean	allowsContinuation(org.fit.layout.model.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.
float	belongsTo(org.fit.layout.model.Area node) Checks whether the area may be tagged with the tag.
protected boolean	containsBlacklistedWord(String[] words)
List<String>	extract(String src) Extracts the parts of a source string that correspond to this tag.
String	getDescription()
String	getId()
String	getName()
TextTag	getTag() Obtains the tag that this tagger assigns to the areas.
protected String	getText(org.fit.layout.model.Area node)
boolean	mayCoexistWith(org.fit.layout.model.Tag other) Check if the area tagged with this tag may be tagged with another tag.
List<String>	split(String src) Splits the string to substrings where each substring either corresponds to this tag or it does not correspond.

Methods inherited from class org.fit.layout.classify.taggers.BaseTagger

getParamNames, getParamTypes

Methods inherited from class org.fit.layout.impl.BaseParametrizedOperation

getParam, getParamRange, setParam

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fit.layout.api.ParametrizedOperation

getParam, getParamRange, setParam

Field Detail

MIN_WORDS

protected final int MIN_WORDS

See Also:

Constant Field Values

areaexpr

protected Pattern areaexpr

The expression the whole area must start with

titleexpr

protected Pattern titleexpr

The expression describing the allowed title format

contexpr

protected Pattern contexpr

The expression describing the allowed format of the title continuation

blacklist

protected Vector<String> blacklist

Words that are not allowed in the presentation title

Constructor Detail

TitleTagger

public TitleTagger()

Method Detail

getId

public String getId()

getName

public String getName()

getDescription

public String getDescription()

getTag

public TextTag getTag()

Description copied from interface: Tagger

Obtains the tag that this tagger assigns to the areas.

Returns:

the tag string

belongsTo

public float belongsTo(org.fit.layout.model.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.

Parameters:

node - The examined area node.

Returns:

the relevance of the assignment (0.0 = not assigned, 0.1 = hopefully possible, >0.5 quite possible, 1.0 absolutely sure)

allowsContinuation

public boolean allowsContinuation(org.fit.layout.model.Area node)

Description copied from interface: Tagger

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

public boolean allowsJoining()

Description copied from interface: Tagger

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

public boolean mayCoexistWith(org.fit.layout.model.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.

extract

public List<String> extract(String src)

Description copied from interface: Tagger

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

Parameters:

src - The source string.

Returns:

A list of extracted strings.

split

public List<String> split(String src)

Description copied from interface: Tagger

Splits the string to substrings where each substring either corresponds to this tag or it does not correspond.

Parameters:

src - The source string.

Returns:

A list of strings; the contcatentation of the strings should put src back.

getText

protected String getText(org.fit.layout.model.Area node)

containsBlacklistedWord

protected boolean containsBlacklistedWord(String[] words)