Package de.saar.chorus.domgraph.codec

Provides basic classes for implementing codecs.

See:
          Description

Class Summary
CodecManager A registry and factory for codecs.
CodecTools Methods that are useful in the implementation of codecs.
InputCodec The abstract base class for all input codecs.
MultiOutputCodec  
OutputCodec The abstract base class for all output codecs.
 

Exception Summary
CodecRegistrationException This exception represents an error that occurs while registering a codec.
MalformedDomgraphException An exception representing semantic errors in codecs.
ParserException An exception representing parsing errors of various types.
 

Annotation Types Summary
CodecConstructor An annotation type for marking the constructor of a codec class that should be used to construct new objects of this class from the codec manager.
CodecMetadata An annotation type for adding metadata to a codec class.
CodecOption An annotation type for adding metadata to codec options.
 

Package de.saar.chorus.domgraph.codec Description

Provides basic classes for implementing codecs. A codec is a class which supports the conversion of an underspecified representation in some concrete syntax into a labelled dominance graph (input codec) or vice versa (output codec).

This package contains the following groups of classes:

Codecs must follow certain fairly strict rules that guarantee that they can be used from a variety of different contexts (such as the main Utool command-line tool and the GUI). These rules are as follows. The intended way to instantiate a codec class is by calling one of the getInputCodecFor... or getOutputCodecFor... methods of a CodecManager object. These methods all expect either a codec name or a filename as their first arguments. As their second arguments, you can pass either a string or a map specifying the options that should be passed to the constructor of the new codec object. The map should associate each parameter name of the codec constructor (as per the CodecOption annotations) with a String value for this option. This string is then automatically translated into the appropriate primitive or enum type if needed, as per the valueOf methods in the case of the primitive types. If you pass the options in a string, this string is assumed to be of the form "opt1=val1,opt2=val2,...,optn=valn". It is then broken up into a map that assigns values to option names, and instantiation proceeds as above.