edu.northwestern.at.morphadorner.corpuslinguistics.spellingmapper

Class AbstractSpellingMapper

java.lang.Object

edu.northwestern.at.utils.IsCloseableObject

edu.northwestern.at.morphadorner.corpuslinguistics.spellingmapper.AbstractSpellingMapper

All Implemented Interfaces:

SpellingMapper, UsesLogger

public abstract class AbstractSpellingMapper
extends IsCloseableObject
implements SpellingMapper, UsesLogger

Abstract Spelling Mapper.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.String>	alternateSpellingsWordClasses Word classes of alternate spellings.
protected Logger	logger Logger used for output.
protected TaggedStrings	mappedSpellings The map with alternate spellings as keys and standard spellings as values.
protected Map2D<java.lang.String,java.lang.String,java.lang.String>	spellingsByWordClass Irregular forms.
protected static java.lang.String	spellingsByWordClassFileName Path to list of irregular word forms.
protected java.util.Set<java.lang.String>	standardSpellingSet The set of standard spellings.

Constructor Summary

Constructors

Constructor and Description
AbstractSpellingMapper() Create abstract spelling mapper.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCachedSpelling(java.lang.String alternateSpelling, java.lang.String standardSpelling) Cached a generated mapped spelling.
void	addMappedSpelling(java.lang.String alternateSpelling, java.lang.String standardSpelling) Add a mapped spelling.
void	addStandardSpelling(java.lang.String standardSpelling) Add a standard spelling.
void	addStandardSpellings(java.util.Collection<java.lang.String> standardSpellings) Add standard spellings from a collection.
java.lang.String	fixCapitalization(java.lang.String spelling, java.lang.String standardSpelling) Fix capitalization of standardized spelling.
Logger	getLogger() Get the logger.
TaggedStrings	getMappedSpellings() Return the mapped spellings.
int	getNumberOfAlternateSpellings() Returns number of alternate spellings.
int	getNumberOfStandardSpellings() Returns number of standard spellings.
java.util.Set<java.lang.String>	getStandardSpellings() Return the standard spellings.
void	loadAlternativeSpellings(java.io.Reader reader, java.lang.String delimChars) Loads alternative spellings from a reader.
void	loadAlternativeSpellings(java.net.URL url, java.lang.String encoding, java.lang.String delimChars) Loads alternate spellings from a URL.
protected void	loadSpellingsByWordClass() Load alternate to standard spellings by word class.
void	loadStandardSpellings(java.io.Reader reader) Loads standard spellings from a reader.
void	loadStandardSpellings(java.net.URL url, java.lang.String encoding) Loads standard spellings from a URL.
java.lang.String	preprocessSpelling(java.lang.String spelling) Preprocess spelling.
void	setLogger(Logger logger) Set the logger.
void	setMappedSpellings(TaggedStrings mappedSpellings) Sets map which maps alternate spellings to standard spellings.
void	setStandardSpellings(java.util.Set<java.lang.String> standardSpellings) Sets standard spellings.
java.lang.String[]	standardizeSpelling(java.lang.String spelling) Returns standard spellings given a spelling.
java.lang.String	standardizeSpelling(java.lang.String spelling, java.lang.String wordClass) Returns a standard spelling given a standard or alternate spelling.

Methods inherited from class edu.northwestern.at.utils.IsCloseableObject

close

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.northwestern.at.morphadorner.corpuslinguistics.spellingmapper.SpellingMapper

mapSpelling

Field Detail

mappedSpellings

protected TaggedStrings mappedSpellings

The map with alternate spellings as keys and standard spellings as values.

standardSpellingSet

protected java.util.Set<java.lang.String> standardSpellingSet

The set of standard spellings.

spellingsByWordClass

protected Map2D<java.lang.String,java.lang.String,java.lang.String> spellingsByWordClass

Irregular forms.

Spellings disambiguated by word class are stored in a HashMap2D. The compound key consists of the word class and alternate spelling, and the value is the standardized spelling.

alternateSpellingsWordClasses

protected java.util.Set<java.lang.String> alternateSpellingsWordClasses

Word classes of alternate spellings.

spellingsByWordClassFileName

protected static java.lang.String spellingsByWordClassFileName

Path to list of irregular word forms.

logger

protected Logger logger

Logger used for output.

Constructor Detail

AbstractSpellingMapper

public AbstractSpellingMapper()

Create abstract spelling mapper.

Method Detail

loadSpellingsByWordClass

protected void loadSpellingsByWordClass()
                                 throws java.io.IOException

Load alternate to standard spellings by word class.

Throws:

java.io.IOException

loadAlternativeSpellings

public void loadAlternativeSpellings(java.net.URL url,
                            java.lang.String encoding,
                            java.lang.String delimChars)
                              throws java.io.IOException

Loads alternate spellings from a URL.

Parameters:

url - URL containing alternate spellings to standard spellings mappings.

encoding - Text encoding (utf-8, 8859_1, etc.).

delimChars - Delimiter characters separating spelling pairs.

Throws:

java.io.IOException

loadAlternativeSpellings

public void loadAlternativeSpellings(java.io.Reader reader,
                            java.lang.String delimChars)
                              throws java.io.IOException

Loads alternative spellings from a reader.

Parameters:

reader - The reader.

delimChars - Delimiter characters separating spelling pairs.

Throws:

java.io.IOException

loadStandardSpellings

public void loadStandardSpellings(java.net.URL url,
                         java.lang.String encoding)
                           throws java.io.IOException

Loads standard spellings from a URL.

Parameters:

url - URL containing standard spellings

encoding - Character set encoding for spellings

Throws:

java.io.IOException

loadStandardSpellings

public void loadStandardSpellings(java.io.Reader reader)
                           throws java.io.IOException

Loads standard spellings from a reader.

Parameters:

reader - The reader.

Throws:

java.io.IOException

addMappedSpelling

public void addMappedSpelling(java.lang.String alternateSpelling,
                     java.lang.String standardSpelling)

Add a mapped spelling.

Parameters:

alternateSpelling - The alternate spelling.

standardSpelling - The corresponding standard spelling.

addStandardSpelling

public void addStandardSpelling(java.lang.String standardSpelling)

Add a standard spelling.

Parameters:

standardSpelling - A standard spelling.

addStandardSpellings

public void addStandardSpellings(java.util.Collection<java.lang.String> standardSpellings)

Add standard spellings from a collection.

Parameters:

standardSpellings - A collection of standard spellings.

addCachedSpelling

public void addCachedSpelling(java.lang.String alternateSpelling,
                     java.lang.String standardSpelling)

Cached a generated mapped spelling.

Parameters:

alternateSpelling - The alternate spelling.

standardSpelling - The corresponding standard spelling.

setMappedSpellings

public void setMappedSpellings(TaggedStrings mappedSpellings)

Sets map which maps alternate spellings to standard spellings.

Parameters:

mappedSpellings - Map with alternate spellings as keys and standard spellings as values.

setStandardSpellings

public void setStandardSpellings(java.util.Set<java.lang.String> standardSpellings)

Sets standard spellings.

Parameters:

standardSpellings - Set of standard spellings.

standardizeSpelling

public java.lang.String[] standardizeSpelling(java.lang.String spelling)

Returns standard spellings given a spelling.

Parameters:

spelling - The spelling.

Returns:

The standard spellings as an array of String.

If not spelling map is defined, the spelling is returned unchanged.

standardizeSpelling

public java.lang.String standardizeSpelling(java.lang.String spelling,
                                   java.lang.String wordClass)

Returns a standard spelling given a standard or alternate spelling.

Parameters:

spelling - The spelling.

wordClass - The major word class.

Returns:

The standard spelling.

getNumberOfAlternateSpellings

public int getNumberOfAlternateSpellings()

Returns number of alternate spellings.

Returns:

The number of alternate spellings.

getNumberOfStandardSpellings

public int getNumberOfStandardSpellings()

Returns number of standard spellings.

Returns:

The number of standard spellings.

getMappedSpellings

public TaggedStrings getMappedSpellings()

Return the mapped spellings.

Returns:

The spelling tagged strings with (alternate spelling, standard spelling) pairs. May be null if this mapper does not use such a map.

getStandardSpellings

public java.util.Set<java.lang.String> getStandardSpellings()

Return the standard spellings.

Returns:

The standard spellings as a Set. May be null.

preprocessSpelling

public java.lang.String preprocessSpelling(java.lang.String spelling)

Preprocess spelling.

Parameters:

spelling - Spelling to preprocess.

Returns:

Preprocessed spelling.

By default, no preprocessing is applied; the original spelling is returned unchanged.

fixCapitalization

public java.lang.String fixCapitalization(java.lang.String spelling,
                                 java.lang.String standardSpelling)

Fix capitalization of standardized spelling.

Parameters:

spelling - The original spelling.

standardSpelling - The candidate standard spelling.

Returns:

Standard spelling with initial capitalization matching original spelling.

getLogger

public Logger getLogger()

Get the logger.

Specified by:

getLogger in interface UsesLogger

Returns:

The logger.

setLogger

public void setLogger(Logger logger)

Set the logger.

Specified by:

setLogger in interface UsesLogger

Parameters:

logger - The logger.