Module io.annot8.components.geo

Package io.annot8.components.geo.processors

Class CountryGazetteer.Settings

java.lang.Object

io.annot8.components.geo.processors.CountryGazetteer.Settings

All Implemented Interfaces:

io.annot8.api.settings.Settings

Enclosing class:

CountryGazetteer

public static class CountryGazetteer.Settings
extends Object
implements io.annot8.api.settings.Settings

Constructor Summary

Constructors

Constructor	Description
Settings()
Settings(boolean geoJson, boolean metadata)
Settings(boolean geoJson, boolean metadata, boolean caseSensitive, String subType, boolean includeCountryCodes)

Method Summary

Modifier and Type	Method	Description
String	getSubType()
boolean	isCaseSensitive()
boolean	isGeoJson()
boolean	isIncludeCountryCodes()
boolean	isMetadata()
void	setCaseSensitive(boolean caseSensitive)
void	setGeoJson(boolean geoJson)
void	setIncludeCountryCodes(boolean includeCountryCodes)
void	setMetadata(boolean metadata)
void	setSubType(String subType)
boolean	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

public Settings()

Settings

public Settings(boolean geoJson,
                boolean metadata)

Settings

public Settings(boolean geoJson,
                boolean metadata,
                boolean caseSensitive,
                String subType,
                boolean includeCountryCodes)

Method Detail

isCaseSensitive

@Description(value="Only annotate matches with the same case as the data file",
             defaultValue="true")
public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

isGeoJson

@Description(value="Add GeoJSON information to annotations",
             defaultValue="true")
public boolean isGeoJson()

setGeoJson

public void setGeoJson(boolean geoJson)

isMetadata

@Description(value="Add country metadata to annotations",
             defaultValue="false")
public boolean isMetadata()

setMetadata

public void setMetadata(boolean metadata)

getSubType

@Description("Sub-type to assign to annotations, or null")
public String getSubType()

setSubType

public void setSubType(String subType)

isIncludeCountryCodes

@Description(value="Include two letter country codes in list of country names",
             defaultValue="false")
public boolean isIncludeCountryCodes()

setIncludeCountryCodes

public void setIncludeCountryCodes(boolean includeCountryCodes)

validate

public boolean validate()

Specified by:

validate in interface io.annot8.api.settings.Settings