Class IPATranscriptBuilder

java.lang.Object

ca.phon.ipa.IPATranscriptBuilder

public class IPATranscriptBuilder
extends Object

Class for building IPATranscripts.

Constructor Summary

Constructors

Constructor	Description
IPATranscriptBuilder()

Method Summary

Modifier and Type	Method	Description
IPATranscriptBuilder	append(IPAElement ipaElement)	Append the given IPAElement
IPATranscriptBuilder	append(IPATranscript ipa)	Append the given transcript
IPATranscriptBuilder	append(String ipa)	Append the given string to the transcript.
IPATranscriptBuilder	append(String ipa, boolean retainSyllabification)	Append the given string to the transcript, attempting to retain syllabification.
IPATranscriptBuilder	append(Collection<? extends IPAElement> eleList)	Append all elements
IPATranscriptBuilder	appendCompoundWordMarker()	Append a compound word marker (e.g, '+')
IPATranscriptBuilder	appendContraction()	Append contraction
IPATranscriptBuilder	appendLinker()	Append a linker (including liason)
IPATranscriptBuilder	appendMajorIntonationGroup()	Append major intonation group
IPATranscriptBuilder	appendMinorIntonationGroup()	Append minor intonation group
IPATranscriptBuilder	appendPause(float secs)
IPATranscriptBuilder	appendPause(PauseLength len)
IPATranscriptBuilder	appendPg(PhoneticGroupMarkerType type)
IPATranscriptBuilder	appendPgEnd()	Append phonetic group marker end
IPATranscriptBuilder	appendPgStart()	Append phonetic group marker start
IPATranscriptBuilder	appendPhone(Diacritic[] prefixDiacritics, Character basePhone, Diacritic[] combiningDiacritics, Diacritic[] suffixDiacritics)	Append a phone
IPATranscriptBuilder	appendPhone(Diacritic[] prefixDiacritics, Character basePhone, Diacritic[] combiningDiacritics, Diacritic[] suffixDiacritics, FeatureSet overrideFeatureSet, SyllableInfo syllableInfo)	Append a phone
IPATranscriptBuilder	appendStress(StressType type)	Append stress
IPATranscriptBuilder	appendSyllableBoundary()	Append a syllable boundary (e.g., '.')
IPATranscriptBuilder	appendWordBoundary()	Append a word boundary.
UnvalidatedValue	getUnvalidatedValue()
IPAElement	last()	Return the last element in the buffer or null if buffer is empty.
IPATranscriptBuilder	makeCompoundPhone(IPAElement phone, Character lig)	Make the last added element plus this phone a new compound phone.
IPATranscriptBuilder	makeCompoundPhone(Character lig)
IPATranscriptBuilder	makeCompoundPhone(Character lig, FeatureSet overrideFeatureSet, SyllableInfo syllableInfo)
IPAElement	removeLast()
IPATranscriptBuilder	reverse()	Reverse elements in this builder.
int	size()	Return the length of the current IPATranscript in the buffer.
IPATranscript	toIPATranscript()	Return the IPATranscript object
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

IPATranscriptBuilder

public IPATranscriptBuilder()

Method Details

getUnvalidatedValue

public UnvalidatedValue getUnvalidatedValue()

append

public IPATranscriptBuilder append(IPAElement ipaElement)

Append the given IPAElement

Parameters:

ipaElement -

Returns:

builder

makeCompoundPhone

public IPATranscriptBuilder makeCompoundPhone(IPAElement phone,
 Character lig)

Make the last added element plus this phone a new compound phone. This will replace the last phone added.

Parameters:

phone -

lig -

Returns:

Throws:

IllegalStateException - if previous phone is not present or is not an instance of Phone

makeCompoundPhone

public IPATranscriptBuilder makeCompoundPhone(Character lig)

makeCompoundPhone

public IPATranscriptBuilder makeCompoundPhone(Character lig,
 FeatureSet overrideFeatureSet,
 SyllableInfo syllableInfo)

append

public IPATranscriptBuilder append(Collection<? extends IPAElement> eleList)

Append all elements

Parameters:

eleList -

Returns:

builder

append

public IPATranscriptBuilder append(String ipa,
 boolean retainSyllabification)

Append the given string to the transcript, attempting to retain syllabification. This utilizes the IPATranscript.parseIPATranscript(String) method. The given ipa should be parse-able on it's own.

Parameters:

ipa -

retainSyllabification -

Returns:

builder

append

public IPATranscriptBuilder append(String ipa)

Append the given string to the transcript. This utilizes the IPATranscript.parseIPATranscript(String) method.

Parameters:

ipa -

Returns:

builder

append

public IPATranscriptBuilder append(IPATranscript ipa)

Append the given transcript

Parameters:

ipa -

Returns:

builder

appendPhone

public IPATranscriptBuilder appendPhone(Diacritic[] prefixDiacritics,
 Character basePhone,
 Diacritic[] combiningDiacritics,
 Diacritic[] suffixDiacritics)

Append a phone

Parameters:

prefixDiacritics -

basePhone -

combiningDiacritics -

suffixDiacritics -

appendPhone

public IPATranscriptBuilder appendPhone(Diacritic[] prefixDiacritics,
 Character basePhone,
 Diacritic[] combiningDiacritics,
 Diacritic[] suffixDiacritics,
 FeatureSet overrideFeatureSet,
 SyllableInfo syllableInfo)

Append a phone

Parameters:

prefixDiacritics -

basePhone -

combiningDiacritics -

suffixDiacritics -

appendPause

public IPATranscriptBuilder appendPause(PauseLength len)

appendPause

public IPATranscriptBuilder appendPause(float secs)

appendWordBoundary

public IPATranscriptBuilder appendWordBoundary()

Append a word boundary.

Returns:

builder

appendSyllableBoundary

public IPATranscriptBuilder appendSyllableBoundary()

Append a syllable boundary (e.g., '.')

Returns:

builder

appendCompoundWordMarker

public IPATranscriptBuilder appendCompoundWordMarker()

Append a compound word marker (e.g, '+')

Returns:

builder

appendLinker

public IPATranscriptBuilder appendLinker()

Append a linker (including liason)

Returns:

builder

appendContraction

public IPATranscriptBuilder appendContraction()

Append contraction

Returns:

builder

appendMinorIntonationGroup

public IPATranscriptBuilder appendMinorIntonationGroup()

Append minor intonation group

Returns:

builder

appendMajorIntonationGroup

public IPATranscriptBuilder appendMajorIntonationGroup()

Append major intonation group

Returns:

builder

appendStress

public IPATranscriptBuilder appendStress(StressType type)

Append stress

Parameters:

type -

appendPgStart

public IPATranscriptBuilder appendPgStart()

Append phonetic group marker start

Returns:

this

appendPgEnd

public IPATranscriptBuilder appendPgEnd()

Append phonetic group marker end

Returns:

this

appendPg

public IPATranscriptBuilder appendPg(PhoneticGroupMarkerType type)

toIPATranscript

public IPATranscript toIPATranscript()

Return the IPATranscript object

Returns:

ipa

last

public IPAElement last()

Return the last element in the buffer or null if buffer is empty.

Returns:

last element in buffer

removeLast

public IPAElement removeLast()

reverse

public IPATranscriptBuilder reverse()

Reverse elements in this builder.

size

public int size()

Return the length of the current IPATranscript in the buffer.

Returns:

size of buffer

toString

public String toString()

Overrides:

toString in class Object