sigmlanim.sigmlstream.interfaces

Interface StreamedSiGMLReceiver

All Known Implementing Classes:

SiGMLInputAnimGenCoordinator

public interface StreamedSiGMLReceiver

Interface to be implemented by an object able to receive the signs in a SiGML document as an event stream. This event stream may include nested event streams specified by <signing_ref> elements in the SiGML document, and the interface provides a checkpoint/abort mechanism for use by the relevant SiGML document scanning controller.

Method Summary

Modifier and Type	Method and Description
void	abortCurrentSiGMLStream() Notifies this receiver that the sign stream associated with the most recent checkpoint (established using addStreamAbortCheckpoint()) has now been aborted, so that the receiver can respond appropriately.
void	addStreamAbortCheckpoint() Sets a checkpoint for abortion of the sign stream generated for an individual SiGML document.
void	beginSignStream() Notifies the receiver of the start of the SiGML sequence, including possibly the start of a nested sequence specified by a SiGML <signing_ref> element.
void	clearStreamAbortCheckpoint() Clears the most recently established stream abortion checkpoint.
void	endSignStream() Notifies the receiver that the most recently begun SiGML content stream is now complete.
void	setNewPlayerSettings(sigmlgen.playerctrl.PlayerSettings ps) Notifies the receiver that the next sign to be received (via setNextSign(String,String)) has the given PlayerSettings attached to it.
void	setNextSign(java.lang.String gsigml, java.lang.String gloss) Supplies the next sign in the source SiGML document to the receiver, in the form of its gestural SiGML text and its gloss name.
void	setNextSignWithAnim(AnimatedSign sign) Supplies the next sign obtained (indirectly) from the source SiGML document to the receiver, as a sign with animation data already attached.

Method Detail

beginSignStream

void beginSignStream()

Notifies the receiver of the start of the SiGML sequence, including possibly the start of a nested sequence specified by a SiGML <signing_ref> element.

setNewPlayerSettings

void setNewPlayerSettings(sigmlgen.playerctrl.PlayerSettings ps)

Notifies the receiver that the next sign to be received (via setNextSign(String,String)) has the given PlayerSettings attached to it.

setNextSign

void setNextSign(java.lang.String gsigml,
                 java.lang.String gloss)

Supplies the next sign in the source SiGML document to the receiver, in the form of its gestural SiGML text and its gloss name.

setNextSignWithAnim

void setNextSignWithAnim(AnimatedSign sign)

Supplies the next sign obtained (indirectly) from the source SiGML document to the receiver, as a sign with animation data already attached.

endSignStream

void endSignStream()

Notifies the receiver that the most recently begun SiGML content stream is now complete.

addStreamAbortCheckpoint

void addStreamAbortCheckpoint()

Sets a checkpoint for abortion of the sign stream generated for an individual SiGML document. It is expected that the controller of the SiGML scanning process will set a checkpoint for each individual SiGML document scanned, but this is not strictly required. What is required is that each invocation of this method should should be matched by a subsequent invocation either of clearStreamAbortCheckpoint() or of abortCurrentSiGMLStream().

abortCurrentSiGMLStream

void abortCurrentSiGMLStream()

Notifies this receiver that the sign stream associated with the most recent checkpoint (established using addStreamAbortCheckpoint()) has now been aborted, so that the receiver can respond appropriately.

clearStreamAbortCheckpoint

void clearStreamAbortCheckpoint()

Clears the most recently established stream abortion checkpoint.