inpro.incremental.unit
Class PhraseIU

java.lang.Object
  inpro.incremental.unit.IU
      inpro.incremental.unit.PhraseIU

All Implemented Interfaces:

java.lang.Comparable<IU>

public class PhraseIU
extends IU

an IU that binds several WordIUs together to form a phrase. phrases are a convenient level for synthesis output if they contain words in units that roughly correspond to prosodic phrases

Author:

timo

Nested Class Summary

static class	PhraseIU.PhraseStatus
static class	PhraseIU.PhraseType

Nested classes/interfaces inherited from class inpro.incremental.unit.IU

IU.IUUpdateListener, IU.Progress

Field Summary

(package private) java.lang.String	phrase
(package private) IU.Progress	progress the state of delivery that this unit is in
private PhraseIU.PhraseStatus	status
private PhraseIU.PhraseType	type

Fields inherited from class inpro.incremental.unit.IU

creationTime, FIRST_IU, groundedIn, grounds, nextSameLevelLinks, previousSameLevelLink, updateListeners

Constructor Summary

PhraseIU(java.lang.String phrase, PhraseIU.PhraseStatus status)

PhraseIU(java.lang.String phrase, PhraseIU.PhraseStatus status, PhraseIU.PhraseType type)

PhraseIU(WordIU word)

Method Summary

int	expectedWordCount() the number of white-space delimited tokens in the payload
IU.Progress	getProgress() by default, an IU - is complete if the last grounding unit is complete, - is upcoming if the first grounding unit is upcoming, - is ongoing if inbetween those two states - is null if there are no grounding units.
PhraseIU.PhraseStatus	getStatus()
PhraseIU.PhraseType	getType()
void	groundIn(java.util.List<IU> ius) grounds in the list of wordIUs, which must have the expected number of elements
void	setFinal()
void	setProgress(IU.Progress p)
void	setStatus(PhraseIU.PhraseStatus status)
java.lang.String	toPayLoad()

Methods inherited from class inpro.incremental.unit.IU

addNextSameLevelLink, addUpdateListener, commit, compareTo, connectSLL, deepToString, duration, endTime, equals, getAge, getAmongNextSameLevelLinks, getCreationTime, getID, getNextSameLevelLink, getNextSameLevelLinks, getOngoingGroundedIU, getSameLevelLink, ground, groundedIn, groundIn, grounds, hashCode, isCommitted, isCompleted, isOngoing, isRevoked, isUpcoming, notifyListeners, payloadEquals, removeAllNextSameLevelLinks, removeGrin, removeGrin, reorderNextSameLevelLink, revoke, setAsTopNextSameLevelLink, setSameLevelLink, startTime, toLabelLine, toString, toTEDviewXML, updateOnGrinUpdates

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

phrase

final java.lang.String phrase

type

private PhraseIU.PhraseType type

status

private PhraseIU.PhraseStatus status

progress

IU.Progress progress

the state of delivery that this unit is in

Constructor Detail

PhraseIU

public PhraseIU(WordIU word)

PhraseIU

public PhraseIU(java.lang.String phrase,
                PhraseIU.PhraseStatus status)

PhraseIU

public PhraseIU(java.lang.String phrase,
                PhraseIU.PhraseStatus status,
                PhraseIU.PhraseType type)

Method Detail

toPayLoad

public java.lang.String toPayLoad()

Specified by:

toPayLoad in class IU

expectedWordCount

public int expectedWordCount()

the number of white-space delimited tokens in the payload

groundIn

public void groundIn(java.util.List<IU> ius)

grounds in the list of wordIUs, which must have the expected number of elements

Overrides:

groundIn in class IU

setProgress

public void setProgress(IU.Progress p)

getProgress

public IU.Progress getProgress()

Description copied from class: IU

by default, an IU - is complete if the last grounding unit is complete, - is upcoming if the first grounding unit is upcoming, - is ongoing if inbetween those two states - is null if there are no grounding units.

Overrides:

getProgress in class IU

setFinal

public void setFinal()

getStatus

public PhraseIU.PhraseStatus getStatus()

setStatus

public void setStatus(PhraseIU.PhraseStatus status)

getType

public PhraseIU.PhraseType getType()