org.fit.layout.classify

Interface Tagger

All Superinterfaces:

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

All Known Implementing Classes:

BaseTagger, DateTagger, LocationsTagger, NERTagger, PersonsTagger, TimeTagger, TitleTagger

public interface Tagger
extends org.fit.layout.api.Service, org.fit.layout.api.ParametrizedOperation

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

Author:

burgetr

Nested Class Summary

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

org.fit.layout.api.ParametrizedOperation.ValueType

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.
List<String>	extract(String src) Extracts the parts of a source string that correspond to this tag.
TextTag	getTag() Obtains the tag that this tagger assigns to the areas.
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 interface org.fit.layout.api.Service

getDescription, getId, getName

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

getParam, getParamNames, getParamRange, getParamTypes, setParam

Method Detail

getTag

TextTag getTag()

Obtains the tag that this tagger assigns to the areas.

Returns:

the tag string

belongsTo

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

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

allowsContinuation

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.

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

List<String> extract(String src)

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

Parameters:

src - The source string.

Returns:

A list of extracted strings.

split

List<String> split(String src)

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.