Class PhoneMap

java.lang.Object

ca.phon.alignment.AlignmentMap<IPAElement>

ca.phon.ipa.alignment.PhoneMap

All Implemented Interfaces:

IExtendable

public class PhoneMap
extends AlignmentMap<IPAElement>
implements IExtendable

Field Summary

Fields inherited from class ca.phon.alignment.AlignmentMap

bottomAlignment, bottomElements, INDEL_VALUE, SPACER_VALUE, topAlignment, topElements

Constructor Summary

Constructors

Constructor	Description
PhoneMap()
PhoneMap(IPATranscript targetRep, IPATranscript actualRep)	Constructor

Method Summary

Modifier and Type	Method	Description
PhoneMap	append(PhoneMap phoneMap)	Create a new PhoneMap by appending another.
static PhoneMap	fromString(IPATranscript target, IPATranscript actual, String align)	Utility method for building a PhoneMap object given a string provided by the toString method.
static PhoneMap	fromString(String align)	Construct alignment given the input string.
IPATranscript	getActualRep()
<T> T	getExtension(Class<T> cap)	Get the requested extension if available.
Set<Class<?>>	getExtensions()	Return all extension types supported
PhoneMap	getSubAlignment(IPATranscript ipaT, IPATranscript ipaA)	Get the sub-alignment from the given elements.
int	getSubAlignmentEnd(IPATranscript ipaT, IPATranscript ipaA)
int	getSubAlignmentIndex(IPATranscript ipaT, IPATranscript ipaA)
IPATranscript	getTargetRep()
<T> T	putExtension(Class<T> cap, T impl)	Add a new extension.
<T> T	removeExtension(Class<T> cap)	Remove a capability.
void	setActualRep(IPATranscript actualRep)
void	setTargetRep(IPATranscript targetRep)
String	toString()
String	toString(boolean includeScType)

Methods inherited from class ca.phon.alignment.AlignmentMap

getAligned, getAligned, getAligned, getAlignedElement, getAlignedElements, getAlignmentLength, getBottomAlignment, getBottomAlignmentElements, getBottomElements, getTopAlignment, getTopAlignmentElements, getTopElements, setBottomAlignment, setBottomElements, setTopAlignment, setTopElements

Methods inherited from class java.lang.Object

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

Constructor Details

PhoneMap

public PhoneMap()

PhoneMap

public PhoneMap(IPATranscript targetRep,
 IPATranscript actualRep)

Constructor

Method Details

getActualRep

public IPATranscript getActualRep()

setActualRep

public void setActualRep(IPATranscript actualRep)

getTargetRep

public IPATranscript getTargetRep()

setTargetRep

public void setTargetRep(IPATranscript targetRep)

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

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean includeScType)

fromString

public static PhoneMap fromString(IPATranscript target,
 IPATranscript actual,
 String align)

Utility method for building a PhoneMap object given a string provided by the toString method. Original transcriptions are also required.

Parameters:

target -

actual -

align - the string representation of the alignment

Throws:

IllegalArgumentException - if the phones found in the align string do not match the give target/actual forms

fromString

public static PhoneMap fromString(String align)

Construct alignment given the input string. This method constructs the IPATranscript references from the given input.

Parameters:

align -

Returns:

alignment

Throws:

IllegalArgumentException - if align is not a valid string

getSubAlignmentIndex

public int getSubAlignmentIndex(IPATranscript ipaT,
 IPATranscript ipaA)

getSubAlignmentEnd

public int getSubAlignmentEnd(IPATranscript ipaT,
 IPATranscript ipaA)

getSubAlignment

public PhoneMap getSubAlignment(IPATranscript ipaT,
 IPATranscript ipaA)

Get the sub-alignment from the given elements.

Parameters:

ipaT -

ipaA -

Returns:

sub-alignment containing the given top/bottom elements

append

public PhoneMap append(PhoneMap phoneMap)

Create a new PhoneMap by appending another. A word boundary will be placed before the new content and all alignment indices will be updated.

Parameters:

phoneMap -

Returns:

new phonemap with appended data