Package ca.phon.orthography

Class Orthography

java.lang.Object

ca.phon.orthography.Orthography

All Implemented Interfaces:

IExtendable, Visitable<OrthoElement>, Iterable<OrthoElement>

public class Orthography
extends Object
implements Iterable<OrthoElement>, Visitable<OrthoElement>, IExtendable

Container for orthographic transcriptions. This class is immutable after being created. To append/modify the data in the Orthography, use the OrthographyBuilder class to create a modified Orthography instance.

Constructor Summary

Constructors

Constructor	Description
Orthography()
Orthography(OrthoElement[] eles)
Orthography(Collection<? extends OrthoElement> elements)

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor<OrthoElement> visitor)	Accept the given visitor.
OrthoElement	elementAt(int idx)
<T> T	getExtension(Class<T> cap)	Get the requested extension if available.
Set<Class<?>>	getExtensions()	Return all extension types supported
int	indexOf(OrthoElement ele)
Iterator<OrthoElement>	iterator()
int	length()
static Orthography	parseOrthography(String text)	Parse the given text into a new Orthography object.
<T> T	putExtension(Class<T> cap, T impl)	Add a new extension.
<T> T	removeExtension(Class<T> cap)	Remove a capability.
Orthography	subsection(int start, int end)
List<OrthoElement>	toList()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Orthography

public Orthography()

Orthography

public Orthography(Collection<? extends OrthoElement> elements)

Orthography

public Orthography(OrthoElement[] eles)

Method Details

parseOrthography

public static Orthography parseOrthography(String text)
                                    throws ParseException

Parse the given text into a new Orthography object.

Throws:

ParseException

getExtensions

public Set<Class<?>> getExtensions()

Description copied from interface: IExtendable

Return all extension types supported

Specified by:

getExtensions in interface IExtendable

getExtension

public <T> T getExtension(Class<T> cap)

Description copied from interface: IExtendable

Get the requested extension if available.

Specified by:

getExtension in interface IExtendable

Returns:

the capability object or null if the cability is not available

putExtension

public <T> T putExtension(Class<T> cap,
 T impl)

Description copied from interface: IExtendable

Add a new extension.

Specified by:

putExtension in interface IExtendable

Parameters:

cap - the extension to add

Returns:

the added extension implementation

removeExtension

public <T> T removeExtension(Class<T> cap)

Description copied from interface: IExtendable

Remove a capability.

Specified by:

removeExtension in interface IExtendable

Parameters:

cap - the capability to remove

accept

public void accept(Visitor<OrthoElement> visitor)

Description copied from interface: Visitable

Accept the given visitor.

Specified by:

accept in interface Visitable<OrthoElement>

subsection

public Orthography subsection(int start,
 int end)

length

public int length()

elementAt

public OrthoElement elementAt(int idx)

indexOf

public int indexOf(OrthoElement ele)

toString

public String toString()

Overrides:

toString in class Object

toList

public List<OrthoElement> toList()

iterator

public Iterator<OrthoElement> iterator()

Specified by:

iterator in interface Iterable<OrthoElement>