Class OrthographyBuilder

java.lang.Object

ca.phon.extensions.ExtendableObject

ca.phon.orthography.OrthographyBuilder

All Implemented Interfaces:

IExtendable

public final class OrthographyBuilder
extends ExtendableObject

Class for building Orthography from various sources. This class is not thread-safe.

Constructor Summary

Constructors

Constructor	Description
OrthographyBuilder()

Method Summary

Modifier and Type	Method	Description
OrthographyBuilder	annnotateWord(Langs langs, WordPrefix wordPrefix, WordSuffix wordSuffix, UntranscribedType untranscribedType)	Annotate the previously added word with the given prefix, suffix and untranscribedType
OrthographyBuilder	append(Orthography ortho)
OrthographyBuilder	append(OrthographyElement ele)
OrthographyBuilder	append(String txt)
OrthographyBuilder	appendCompoundWord(Word word1, Word word2, CompoundWordMarkerType marker)
OrthographyBuilder	appendTagMarker(TagMarkerType tmType)
OrthographyBuilder	appendWord(WordElement... wordElements)
OrthographyBuilder	appendWord(WordPrefix prefix, WordElement... wordElements)
OrthographyBuilder	appendWord(WordPrefix prefix, WordSuffix suffix, UntranscribedType untranscribedType, WordElement... wordElements)
OrthographyBuilder	appendWord(WordPrefix prefix, WordSuffix suffix, UntranscribedType untranscribedType, List<WordElement> wordElements)
OrthographyBuilder	appendWord(WordPrefix prefix, WordSuffix suffix, WordElement... wordElements)
OrthographyBuilder	appendWord(WordPrefix prefix, WordSuffix suffix, List<WordElement> wordElements)
OrthographyBuilder	appendWord(WordPrefix prefix, List<WordElement> wordElements)
OrthographyBuilder	appendWord(WordSuffix suffix, WordElement... wordElements)
OrthographyBuilder	appendWord(WordSuffix suffix, List<WordElement> wordElements)
OrthographyBuilder	appendWord(String data)
OrthographyBuilder	appendWord(String data, WordFormType suffix)
OrthographyBuilder	appendWord(String data, WordType prefix)
OrthographyBuilder	appendWord(String data, WordType prefix, WordFormType suffix)
OrthographyBuilder	appendWord(String data, WordType prefix, WordFormType suffix, UntranscribedType untranscribed)
OrthographyBuilder	appendWord(List<WordElement> wordElements)
OrthographyBuilder	clear()
OrthographyBuilder	createCompoundWord()	Creates a wordnet using the last two elements.
OrthographyBuilder	createCompoundWord(CompoundWordMarkerType marker)	Creates a wordnet using the last two elements.
OrthographyBuilder	createCompoundWord(Word word2, CompoundWordMarkerType marker)	Creates a wordnet using the previously added word and the given word.
OrthographyElement	elementAt(int idx)
List<OrthographyElement>	getElements()
OrthographyElement	lastElement()
OrthographyElement	replaceLastElement(OrthographyElement ele)
OrthographyBuilder	reverse()
int	size()
Orthography	toOrthography()

Methods inherited from class ca.phon.extensions.ExtendableObject

getExtension, getExtensions, putExtension, removeExtension

Methods inherited from class java.lang.Object

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

Constructor Details

OrthographyBuilder

public OrthographyBuilder()

Method Details

clear

public OrthographyBuilder clear()

append

public OrthographyBuilder append(Orthography ortho)

append

public OrthographyBuilder append(OrthographyElement ele)

append

public OrthographyBuilder append(String txt)

Parameters:

txt -

Returns:

Throws:

IllegalArgumentException - if txt could not be compiled

appendWord

public OrthographyBuilder appendWord(String data,
 WordType prefix,
 WordFormType suffix,
 UntranscribedType untranscribed)

appendWord

public OrthographyBuilder appendWord(String data,
 WordType prefix,
 WordFormType suffix)

appendWord

public OrthographyBuilder appendWord(String data,
 WordType prefix)

appendWord

public OrthographyBuilder appendWord(String data,
 WordFormType suffix)

appendWord

public OrthographyBuilder appendWord(String data)

appendWord

public OrthographyBuilder appendWord(WordElement... wordElements)

appendWord

public OrthographyBuilder appendWord(WordSuffix suffix,
 WordElement... wordElements)

appendWord

public OrthographyBuilder appendWord(WordPrefix prefix,
 WordElement... wordElements)

appendWord

public OrthographyBuilder appendWord(WordPrefix prefix,
 WordSuffix suffix,
 WordElement... wordElements)

appendWord

public OrthographyBuilder appendWord(WordPrefix prefix,
 WordSuffix suffix,
 UntranscribedType untranscribedType,
 WordElement... wordElements)

appendWord

public OrthographyBuilder appendWord(List<WordElement> wordElements)

appendWord

public OrthographyBuilder appendWord(WordSuffix suffix,
 List<WordElement> wordElements)

appendWord

public OrthographyBuilder appendWord(WordPrefix prefix,
 List<WordElement> wordElements)

appendWord

public OrthographyBuilder appendWord(WordPrefix prefix,
 WordSuffix suffix,
 List<WordElement> wordElements)

appendWord

public OrthographyBuilder appendWord(WordPrefix prefix,
 WordSuffix suffix,
 UntranscribedType untranscribedType,
 List<WordElement> wordElements)

appendTagMarker

public OrthographyBuilder appendTagMarker(TagMarkerType tmType)

appendCompoundWord

public OrthographyBuilder appendCompoundWord(Word word1,
 Word word2,
 CompoundWordMarkerType marker)

createCompoundWord

public OrthographyBuilder createCompoundWord(Word word2,
 CompoundWordMarkerType marker)

Creates a wordnet using the previously added word and the given word.

Parameters:

word2 -

marker -

Returns:

Throws:

IllegalStateException - if the previous element is not an Word or the element list is empty

createCompoundWord

public OrthographyBuilder createCompoundWord(CompoundWordMarkerType marker)

Creates a wordnet using the last two elements.

Parameters:

marker -

Returns:

Throws:

IllegalStateException - if the previous two elements are not Words or the element list is empty

createCompoundWord

public OrthographyBuilder createCompoundWord()

Creates a wordnet using the last two elements.

Returns:

Throws:

IllegalStateException - if the previous two elements are not Words or the element list is empty

annnotateWord

public OrthographyBuilder annnotateWord(Langs langs,
 WordPrefix wordPrefix,
 WordSuffix wordSuffix,
 UntranscribedType untranscribedType)

Annotate the previously added word with the given prefix, suffix and untranscribedType

Parameters:

wordPrefix -

wordSuffix -

untranscribedType -

Returns:

size

public int size()

elementAt

public OrthographyElement elementAt(int idx)

lastElement

public OrthographyElement lastElement()

replaceLastElement

public OrthographyElement replaceLastElement(OrthographyElement ele)

reverse

public OrthographyBuilder reverse()

getElements

public List<OrthographyElement> getElements()

toOrthography

public Orthography toOrthography()