jautil
Class SiGMLPipe

java.lang.Object
  jautil.SiGMLPipe

All Implemented Interfaces:

JALoadingPlayer.SiGMLPipeWriter

public class SiGMLPipe
extends java.lang.Object
implements JALoadingPlayer.SiGMLPipeWriter

A simple pipe for SiGML input, allowing the SiGML text to be supplied as a sequence of fragments over time.

Constructor Summary

SiGMLPipe()
Constructs a new SiGML pipe, which will wrap the sequence of SiGML fragments it receives in a pair of <sigml>...</sigml> element tags.

SiGMLPipe(boolean dosigmlwrap)
Constructs a new SiGML pipe, which, in accordance with the given flag parameter, will or will not wrap the sequence of SiGML fragments it receives in a pair of <sigml>...</sigml> element tags.

Method Summary

void	appendSiGMLFragment(java.lang.String sigmlfrag) Appends the given fragment of SiGML text to this pipe.
java.io.InputStream	getSiGMLInputStream() Returns the input stream for the SiGML data fed into this pipe.
void	terminatePipe() Terminates writing to this SiGML pipe.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiGMLPipe

public SiGMLPipe(boolean dosigmlwrap)
          throws java.io.IOException

Constructs a new SiGML pipe, which, in accordance with the given flag parameter, will or will not wrap the sequence of SiGML fragments it receives in a pair of <sigml>...</sigml> element tags.

Throws:

java.io.IOException

SiGMLPipe

public SiGMLPipe()
          throws java.io.IOException

Constructs a new SiGML pipe, which will wrap the sequence of SiGML fragments it receives in a pair of <sigml>...</sigml> element tags.

Throws:

java.io.IOException

Method Detail

getSiGMLInputStream

public java.io.InputStream getSiGMLInputStream()

Returns the input stream for the SiGML data fed into this pipe.

appendSiGMLFragment

public void appendSiGMLFragment(java.lang.String sigmlfrag)
                         throws java.io.IOException

Appends the given fragment of SiGML text to this pipe.

Specified by:

appendSiGMLFragment in interface JALoadingPlayer.SiGMLPipeWriter

Throws:

java.io.IOException

terminatePipe

public void terminatePipe()
                   throws java.io.IOException

Terminates writing to this SiGML pipe.

Specified by:

terminatePipe in interface JALoadingPlayer.SiGMLPipeWriter

Throws:

java.io.IOException