sigmlanim
Class SiGMLReader

java.lang.Object
  extended by sigmlanim.SiGMLReader

public class SiGMLReader
extends java.lang.Object

A SiGMLReader is capable of reading a SiGML document text from sources of several different kinds, and of converting that document to a sequence sign descriptions. Each of these sign decriptions is an AnimatedSign, which includes the gestural SiGML (<hamgestural_sign>) text for the sign, but which does not at this stage include the corresponding animation frames. The animation frames can be obtained by feeding the signs' SiGML texts to an instance of JAnimgen.


Constructor Summary
SiGMLReader(java.net.URI baseuri)
          Constructs a new SiGML reader, which will use the given base URI to resolve system ids.
 
Method Summary
static void primeSiGMLInLib(sigmlinlib.SiGMLInLib sil)
          This method "primes" the given SiGMLInLib instance, by getting it to process a single HNS-SiGML sign, the intention being to get the (not inconsiderable) first-time-through overhead for the HNS-to-Gestural-SiGML translation code out of the way at a time of the caller's choosing.
 AnimatedSign[] readFile(java.io.File f)
          Reads SiGML from the given file, converts it to an array of AnimatedSign descriptions, and returns the result.
 AnimatedSign[] readFile(java.lang.String path)
          Reads SiGML from the given file path, converts it to an array of AnimatedSign descriptions, and returns the result.
 AnimatedSign[] readString(java.lang.String sigmlstr)
          Converts the given SiGML string to an array of AnimatedSign descriptions, and returns the result.
 AnimatedSign[] readURL(java.net.URL url)
          Reads SiGML from the given URL, converts it to an array of AnimatedSign descriptions, and returns the result.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SiGMLReader

public SiGMLReader(java.net.URI baseuri)
Constructs a new SiGML reader, which will use the given base URI to resolve system ids. and relative URIs.

Method Detail

readString

public AnimatedSign[] readString(java.lang.String sigmlstr)
                          throws java.io.IOException
Converts the given SiGML string to an array of AnimatedSign descriptions, and returns the result.

Throws:
java.io.IOException

readURL

public AnimatedSign[] readURL(java.net.URL url)
                       throws java.io.IOException
Reads SiGML from the given URL, converts it to an array of AnimatedSign descriptions, and returns the result.

Throws:
java.io.IOException

readFile

public AnimatedSign[] readFile(java.lang.String path)
                        throws java.io.IOException
Reads SiGML from the given file path, converts it to an array of AnimatedSign descriptions, and returns the result.

Throws:
java.io.IOException

readFile

public AnimatedSign[] readFile(java.io.File f)
                        throws java.io.IOException
Reads SiGML from the given file, converts it to an array of AnimatedSign descriptions, and returns the result.

Throws:
java.io.IOException

primeSiGMLInLib

public static void primeSiGMLInLib(sigmlinlib.SiGMLInLib sil)
This method "primes" the given SiGMLInLib instance, by getting it to process a single HNS-SiGML sign, the intention being to get the (not inconsiderable) first-time-through overhead for the HNS-to-Gestural-SiGML translation code out of the way at a time of the caller's choosing.