@Runtime

Package eu.bandm.tools.tdom.runtime

Contains base and auxiliary classes for code generated by tdom. This package contains

• the base classes used by the tdom compiler to derive the generated classes,
• auxiliary data types and exceptions supporting consistency checks and de-serialization.

For a bird-eye description of user input, compilation and run-time classes see the tdom user documentation.
Naming conventions for the doc texts in this package:
The [XML] specification is not very clear w.r.t. the distinction of a model instance, the external representation as a text file, and the exact time point of parsing. For the discussion in the resp. method definitions we define

1. "tdom model" to stand for all Java source files, generated when applying TypedDOMGenerator to one particular DTD file (or to an internal DTD model), and the class files compiled therefrom,
2. "the underlying DTD" to stand for this particular DTD,
3. "tdom model instance" for a collection of objects/instances of the classes of such a tdom tdom model, representing one particular text object by classes from the tdom model,
4. "Element's class" and "Attribute's class" to stand for the classes generated for one particular Element or Attribute definition from the DTD,
5. "model (instance) initialization" to stand for the exact time point when parsing a text file, or receiving a SAX event, or executing an Element's class constructor explicitly from some user's code. I.e. all possible activities which create a fresh instance of an Element's or Attribute's class. The wording "... when initializing (a tdom model instance) ..." is meant accordingly.

Interface Summary

Interface	Description
EnumerationValue	Indicates that a generated attribute has a generated enumeration as its value.
ErrorHandler
FiniteStateMachine.Action
Identifiable	Indicates the presence of an ID attribute.
ImpliedAttribute	Indicates that an anttribute has been declared as #IMPLIED.
Matchable<M>
PCDataVisitor	Indicates that PCData can be visited.
TdomAttributeMissingSupplier<A>	Intended to match tdom element constructor calls as arguments for exception handler strategies.
TypedContent
TypedContent.DecodingConstructor<C extends TypedContent,X extends TypedExtension,Y extends java.lang.Exception>
TypedContent.ParsingConstructor<C extends TypedContent,E extends TypedElement<E,X>,X extends TypedExtension,Y extends java.lang.Exception>
TypedElement.MixedContentContainer	Implemented by all Element types which include PCDATA and other elements.
TypedElement.PCDataContainer	Implemented by all Element types which include PCDATA.
TypedNode.ParseListener<E extends TypedElement<?,?>>	Listener interface which may be registered with the tdom generated parsing code and will be called after each successful parsing step.
Visitable<V extends BaseVisitor>	Marks all generated classes which are reachable by the generated Visitor class.

Class Summary

Class	Description
BaseMatcher	Super class for all generated matcher classes of a tdom model.
BaseVisitor<V extends Visitable<? extends BaseVisitor>>
CDataAttribute	Base class for all generated classes which realize an Attribute with type CDATA.
CheckedListPlus<T>	Extends the checked list to ensure that it does not become empty.
ContentMapping	INTERNAL USE ONLY.
ContentMapping.Choice
ContentMapping.Empty
ContentMapping.Sequence
ContentMapping.Singleton
ContentPath
ContentPath.Choice
ContentPath.Choice.End
ContentPath.Repetition
ContentPath.Sequence
DecodingInputStream
DefaultErrorHandler	Implementation which sends error messages to a MessageReceiver.
ElementDictionary<E extends TypedElement<E,X>,X extends TypedExtension>	Realizes a map from String values to Elements.
EncodingOutputStream	DOCME CHECK: Uses direct and inherited aggregation in parallel ? (=inherited and overwritten methods?)
EnumerationAttribute<V extends java.lang.Enum<V> & EnumerationValue>	Base class for all generated classes which realize an Attribute with an "enumeration type", like
FiniteStateMachine	INTERNAL USE ONLY.
IdAttribute	Implements an Attribute of "ID" type, which holds as its value a single id value.
IdRefAttribute	Implements an Attribute of "IDREF" type, which holds as its value a single id value.
IdRefsAttribute	Implements an Attribute of "IDREFS" type, which holds as its value a list of id values.
NmTokenAttribute	Base class for all generated classes which realize an Attribute with an "NMTOKEN" type.
NmTokensAttribute	Implements an Attribute of "NMTOKENS" type, which holds as its value a list of NMTOKEN tokens separated by blanks.
SelectedIntegersAttribute	Base class for all generated classes which realize an Attribute with a type which is defined as a disjunction of integer values, like
TypedAttribute<V>	Common base class for all attributes from some DTD.
TypedAttribute.__PreAtts	Auxiliary class to signal in a type signature of a constructor that it is called locally by another constructor which will handle attributes afterwards.
TypedAttribute.SafeValues	Auxiliary class to signal in a type signature that no TdomAttributeSyntaxExceptions can be thrown.
TypedChoice<E extends TypedExtension>	Base class for all model classes which represent a choice in a content model.
TypedComment	Realizes comments in a tdom model instance.
TypedDocument<E extends TypedElement<E,X>,X extends TypedExtension>	Fundamental base class for all Elements which can serve as a "document element" / "root element".
TypedDTD	Common superclass for generated subclasses called "DTD.java", one for each tdom generated model.
TypedDTD.AbstractElementInfo	Reflection information for a "synthetic" element in the generated code, caused by a "<?tdom abstract ..>" directive in the underlying DTD.
TypedDTD.AttributeInfo	Reflection information for one particular Attribute definition from the DTD.
TypedDTD.DTDInfo	Container for all different kinds of reflection info objects.
TypedDTD.ElementInfo	Reflection information for one particular Element definition from the DTD.
TypedDTD.ImplementationInfo<C>	Reflection information which indicates one(1) particular Java class, which has been generated to implement one(1) particular concept.
TypedDTD.NamedImplementationInfo<C>	Reflection information which indicates one(1) particular Java class, generated to implement one(1) particular concept which carries a NamespaceName.
TypedElement<E extends TypedElement<E,X>,X extends TypedExtension>
TypedElement.AttributeDecoder
TypedElement.AttributeEncoder
TypedElement.MixedContent<E extends TypedElement<E,X>,X extends TypedExtension>	Base class for all generated classes which model "mixed contents" or "unmixed contents".
TypedElement.MixedContentFactory<C extends TypedElement.MixedContent<E,X>,E extends TypedElement<E,X>,X extends TypedExtension,Y extends java.lang.Exception>
TypedElement.UnmixedContent<E extends TypedElement<E,X>,X extends TypedExtension>	Content class in case that only PCData is contained, can be reused between models and instances.
TypedEthereal	Common superclass for free floating, ubiquituous and syntactically unconstrained model components, namels comments and processing instructions.
TypedEtherealContainer	Gives access to the TypedEthereal (Comments and PIs) which follow the open tag and precede the close tag of an Element, or stand at the begin and end of a document.
TypedExtension	Base class for the generated "Extension" class.
TypedExtension.ExtendedElement<E extends TypedElement>	FIXME ????
TypedNode<X extends TypedExtension>	Fundamental superclass for all classes which implement tdom components.
TypedPCData	Represents a piece of contiguous PCData in a model instance.
TypedProcessingInstruction	Realizes "PIs" = Processing Instructions in a tdom model instance.
TypedSubstantial<X extends TypedExtension>	Common superclass for the first class and syntactically constrained model components, namely Elements and PCData.
TypedSubtree<E extends TypedExtension>
UntypedVisitor<E extends TypedElement<E,X>,X extends TypedExtension>	Visits a tdom Element or Document class in a uniform way, e.g.

Exception Summary

Exception	Description
DanglingIdException	Signals the case that a particular ID string value in a IDREF or IDREFS attribute value of a particular document is not related to a value of an ID attribute in the same document.
FiniteStateMachine.NondeterminismException
FiniteStateMachine.SyntaxException
HomonymousIdException	Signals the case that one(1) particular ID string value is related to two(2) different elements.
IdException	Common superclass of several exceptions related to unconsistent usage of id values.
SynonymousIdException	Signals the case that one(1) particular Element shall be identified by two(2) different ID string values.
TdomAttributeException	Signals that, when initializing a model instance, the treatment of one particular attribute does not fulfill the definitions for the currently parsed element, as defined by the DTD.
TdomAttributeFixedException	Signals that, when initializing or updating a model instance, it is tried to assign a value to an attribute, which differs from that value which is declared "#FIXED by the DTD.
TdomAttributeMissingException	Signals that, when initializing a model instance, the value assigned to one particular attribute does not match the syntax defined by the DTD.
TdomAttributeSyntaxException	Signals that, when initializing or updating a model instance, the value assigned to one particular attribute does not match the syntax defined by the DTD.
TdomAttributeUndefException	Signals that, when initializing a model instance, an attempt is made to assign a value to an undefined attribute.
TdomContentEndException	Signals that, when initializing a model instance, a sequence of elements is not long enough w.r.t. the content model defined for the currently parsed element.
TdomContentException	Signals that, when initializing a model instance, a sequence of elements or nodes does not match the content model defined for the currently parsed element.
TdomException	Signals that, when initializing a model instance, a violation of the document type format occured, as it is defined by the DTD.
TdomXmlException	Signals that, when initializing a model instance, something went wrong with the underlying XML stream.

Annotation Types Summary

Annotation Type	Description
SemiparsingConstructor	Is needed by xslt implementation to find the correct constructor.