com.basistech.rosette.apimodel

Class EntitiesOptions

java.lang.Object

com.basistech.rosette.apimodel.EntitiesOptions

public final class EntitiesOptions
extends Object

Entity extraction options

Field Summary

Fields

Modifier and Type	Field and Description
static EntitiesOptions	DEFAULT_OPTIONS

Constructor Summary

Constructors

Constructor and Description
EntitiesOptions() Create a set of entity extraction options with default values.
EntitiesOptions(Boolean resolveNamedEntities, Integer maxEntityTokens, EnumSet<ExtractionMethod> extractionMethods, Boolean allowPartialGazetteerMatches, Boolean redactorPreferLength) Constructor for EntitiesOptions

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) if the param is a EntitiesOptions, compare contents for equality
Boolean	getAllowPartialGazetteerMatches() get whether to allow partial gazetteer matches
EnumSet<ExtractionMethod>	getExtractionMethods() get the set of active extraction methods
Integer	getMaxEntityTokens() get the max number of tokens allowed in an entity
Boolean	getRedactorPreferLength() get whether to prefer length over weights for redaction
Boolean	getResolveNamedEntities() get the resolve in-document named entities
int	hashCode()
void	setAllowPartialGazetteerMatches(Boolean allowPartialGazetteerMatches) set whether to allow partial gazetteer matches
void	setExtractionMethods(EnumSet<ExtractionMethod> extractionMethods) set the set of active extraction methods
void	setMaxEntityTokens(Integer maxEntityTokens) set the max number of tokens allowed in an entity
void	setRedactorPreferLength(Boolean redactorPreferLength) set whether to prefer length over weights for redaction
void	setResolveNamedEntities(Boolean resolveNamedEntities) set the resolve in-document named entities

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OPTIONS

public static final EntitiesOptions DEFAULT_OPTIONS

Constructor Detail

EntitiesOptions

public EntitiesOptions()

Create a set of entity extraction options with default values. Note that null is used to represent defaults.

EntitiesOptions

public EntitiesOptions(Boolean resolveNamedEntities,
                       Integer maxEntityTokens,
                       EnumSet<ExtractionMethod> extractionMethods,
                       Boolean allowPartialGazetteerMatches,
                       Boolean redactorPreferLength)

Constructor for EntitiesOptions

Parameters:

resolveNamedEntities - resolve in-document named entities

maxEntityTokens - max number of tokens allowed in an entity

extractionMethods - get the set of active extraction methods

allowPartialGazetteerMatches - whether to allow partial gazetteer matches

redactorPreferLength - whether to prefer length over weights for redaction

Method Detail

getResolveNamedEntities

public Boolean getResolveNamedEntities()

get the resolve in-document named entities

Returns:

the resolve in-document named entities

getMaxEntityTokens

public Integer getMaxEntityTokens()

get the max number of tokens allowed in an entity

Returns:

the max number of tokens allowed in an entity

getExtractionMethods

public EnumSet<ExtractionMethod> getExtractionMethods()

get the set of active extraction methods

Returns:

the set of active extraction methods

getAllowPartialGazetteerMatches

public Boolean getAllowPartialGazetteerMatches()

get whether to allow partial gazetteer matches

Returns:

whether to allow partial gazetteer matches

getRedactorPreferLength

public Boolean getRedactorPreferLength()

get whether to prefer length over weights for redaction

Returns:

whether to prefer length over weights for redaction

setResolveNamedEntities

public void setResolveNamedEntities(Boolean resolveNamedEntities)

set the resolve in-document named entities

Parameters:

resolveNamedEntities - the resolve in-document named entities

setMaxEntityTokens

public void setMaxEntityTokens(Integer maxEntityTokens)

set the max number of tokens allowed in an entity

Parameters:

maxEntityTokens - the max number of tokens allowed in an entity

setExtractionMethods

public void setExtractionMethods(EnumSet<ExtractionMethod> extractionMethods)

set the set of active extraction methods

Parameters:

extractionMethods - the set of active extraction methods

setAllowPartialGazetteerMatches

public void setAllowPartialGazetteerMatches(Boolean allowPartialGazetteerMatches)

set whether to allow partial gazetteer matches

Parameters:

allowPartialGazetteerMatches - whether to allow partial gazetteer matches

setRedactorPreferLength

public void setRedactorPreferLength(Boolean redactorPreferLength)

set whether to prefer length over weights for redaction

Parameters:

redactorPreferLength - whether to prefer length over weights for redaction

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

if the param is a EntitiesOptions, compare contents for equality

Overrides:

equals in class Object

Parameters:

o - the object

Returns:

whether or not the param object is equal to this object