edu.ucsb.nmsl.tools
Interface TranscriptFileReader

All Known Implementing Classes:

QADTranscriptFileReader

public interface TranscriptFileReader

This class was created to allow for the easy integration of many file formats for specifying captions. The responsibility of any class implementing this interface is to take a Transcript object and read the captions along with their time-stamp from a file or stream. The input can then be used to display captioned media.

Version:

1.0

Method Summary

Transcript	readTranscript(org.w3c.dom.Document d) This method accepts a Document instance to read captions and time stamps from in order to create an instance of a Transcript object.
Transcript	readTranscript(java.io.InputStream in) This method accepts an InputStream instance to read captions and time stamps from in order to create an instance of a Transcript object.

Method Detail

readTranscript

Transcript readTranscript(java.io.InputStream in)

This method accepts an InputStream instance to read captions and time stamps from in order to create an instance of a Transcript object.

Parameters:

in - - An InputStream instance that Transcript information will be read from.

Returns:

A newly created Transcript instance created based on the information read from the InputStream.

readTranscript

Transcript readTranscript(org.w3c.dom.Document d)

This method accepts a Document instance to read captions and time stamps from in order to create an instance of a Transcript object. The Document object is defined as part of the default XML DOM implementation that accompanies the JVM from Sun.

Parameters:

d - - An instance of a Document object that contains the caption information in an XML DOM object.

Returns:

A newly created Transcript instance created based on the information read from the InputStream.