sigmlanim
Class StreamableAnimationLoader

java.lang.Object
  extended by sigmlanim.StreamableAnimationLoader
Direct Known Subclasses:
NonStreamedAnimationLoader, StreamedAnimationLoader

public abstract class StreamableAnimationLoader
extends java.lang.Object

Generates an animation for a given SiGML URL, string or input stream, using a SAX-based parsing infrastructure that allows streaming access to the animation, that is, early signs in the sequence may have their animations attached, and these animations may be used, before later signs in the sequence have been processed at all. This is an abstract class: a concrete subclass is responsible for specifying exactly how the animation is generated, including whether or not streamed access is supported.


Constructor Summary
StreamableAnimationLoader(java.lang.String av, JAOptions jopts, java.io.InputStream ins, SiGMLAnimationBuildHandler sabldr, java.lang.String TAG, java.lang.String MESSAGE)
          Constructs a new loader for the given SiGML stream, using the given JA options set, animation build handler, and subclass tag and announcement message.
StreamableAnimationLoader(java.lang.String av, JAOptions jopts, java.io.StringReader srdr, SiGMLAnimationBuildHandler sabldr, java.lang.String TAG, java.lang.String MESSAGE)
          Constructs a new loader for SiGML text accessible via the given reader, using the given JA options set, animation build handler, and subclass tag and announcement message.
StreamableAnimationLoader(java.lang.String av, JAOptions jopts, java.lang.String url, SiGMLAnimationBuildHandler sabldr, java.lang.String TAG, java.lang.String MESSAGE)
          Constructs a new loader for the given SiGML URL, using the given JA options set, animation build handler, and subclass tag and announcement message.
 
Method Summary
abstract  SiGMLAnimation getAnimation()
          Returns the animation that this loader generates, which may be incomplete at the time it is returned.
abstract  void processSiGML()
          Uses this loader's scanner and animation generation infrastructure to process its SiGML source, leading (possibly asynchronously) to the creation of its animation data.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StreamableAnimationLoader

public StreamableAnimationLoader(java.lang.String av,
                                 JAOptions jopts,
                                 java.lang.String url,
                                 SiGMLAnimationBuildHandler sabldr,
                                 java.lang.String TAG,
                                 java.lang.String MESSAGE)
Constructs a new loader for the given SiGML URL, using the given JA options set, animation build handler, and subclass tag and announcement message.


StreamableAnimationLoader

public StreamableAnimationLoader(java.lang.String av,
                                 JAOptions jopts,
                                 java.io.StringReader srdr,
                                 SiGMLAnimationBuildHandler sabldr,
                                 java.lang.String TAG,
                                 java.lang.String MESSAGE)
Constructs a new loader for SiGML text accessible via the given reader, using the given JA options set, animation build handler, and subclass tag and announcement message.


StreamableAnimationLoader

public StreamableAnimationLoader(java.lang.String av,
                                 JAOptions jopts,
                                 java.io.InputStream ins,
                                 SiGMLAnimationBuildHandler sabldr,
                                 java.lang.String TAG,
                                 java.lang.String MESSAGE)
Constructs a new loader for the given SiGML stream, using the given JA options set, animation build handler, and subclass tag and announcement message.

Method Detail

processSiGML

public abstract void processSiGML()
Uses this loader's scanner and animation generation infrastructure to process its SiGML source, leading (possibly asynchronously) to the creation of its animation data.


getAnimation

public abstract SiGMLAnimation getAnimation()
Returns the animation that this loader generates, which may be incomplete at the time it is returned.