org.fit.layout.classify.taggers

Class PersonsTagger

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.classify.taggers.BaseTagger

org.fit.layout.classify.taggers.NERTagger

org.fit.layout.classify.taggers.PersonsTagger

All Implemented Interfaces:

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

public class PersonsTagger
extends NERTagger

NER-based personal name area tagger. It tags the areas that contain at least the specified number of personal names.

Author:

burgetr

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	contexpr The expression describing the allowed format of the title continuation
protected Pattern	couldexpr The expression describing the string that _could_ be a name

Constructor Summary

Constructors

Constructor and Description
PersonsTagger()
PersonsTagger(int mincnt) Construct a new tagger.

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.
String	getDescription()
String	getId()
int	getMincnt()
String	getName()
String[]	getParamNames()
org.fit.layout.api.ParametrizedOperation.ValueType[]	getParamTypes()
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.
void	setMincnt(int mincnt)
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.NERTagger

getClassifier

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

couldexpr

protected Pattern couldexpr

The expression describing the string that _could_ be a name

contexpr

protected Pattern contexpr

The expression describing the allowed format of the title continuation

Constructor Detail

PersonsTagger

public PersonsTagger()

PersonsTagger

public PersonsTagger(int mincnt)

Construct a new tagger.

Parameters:

mincnt - the minimal count of the personal names detected in the area necessary for tagging this area.

Method Detail

getId

public String getId()

getName

public String getName()

getDescription

public String getDescription()

getParamNames

public String[] getParamNames()

Specified by:

getParamNames in interface org.fit.layout.api.ParametrizedOperation

Overrides:

getParamNames in class BaseTagger

getParamTypes

public org.fit.layout.api.ParametrizedOperation.ValueType[] getParamTypes()

Specified by:

getParamTypes in interface org.fit.layout.api.ParametrizedOperation

Overrides:

getParamTypes in class BaseTagger

getMincnt

public int getMincnt()

setMincnt

public void setMincnt(int mincnt)

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

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.

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.

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.