Package eu.bandm.tools.lablog.xml

Class Document_package

java.lang.Object

eu.bandm.tools.tdom.runtime.TypedNode<X>

eu.bandm.tools.tdom.runtime.TypedDocument<Element,Extension>

eu.bandm.tools.lablog.xml.Document

eu.bandm.tools.lablog.xml.Document_package

All Implemented Interfaces:

Visitable<Visitor>

@Undocumented
public class Document_package
extends Document

Document with an Element_package as its root (=topmost) element. Of main interest for the programmer are the constructors. These allow to read different external representations. Furthermore, each instance is visitable as a whole.Furthermore, the ID relation is managed by TypedDocument.createDictionary().

Nested Class Summary

Nested classes/interfaces inherited from class eu.bandm.tools.tdom.runtime.TypedNode

TypedNode.ParseListener<E extends TypedElement<?,?>>

Field Summary

Fields inherited from class eu.bandm.tools.tdom.runtime.TypedDocument

generationComment, root, STRING_ETHEREAL_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
Document_package(Element_package root)	Create a document in a bottom-up fashion from its toplevel element.
Document_package(SAXEventStream in, Extension ext)
Document_package(InputStream in, Extension ext)	Input must be tdom-spec compressed encoding, as written by encode(EncodingOutputStream).
Document_package(Document domDocument, Extension ext)	Parses an untyped W3C DOM document into a tdom instance.

Method Summary

Modifier and Type	Method	Description
protected final Element	decode(DecodingInputStream in, Extension ext)
final void	encode(EncodingOutputStream out)
final void	encode(EncodingOutputStream out, Extension ext)	Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_package	getDocumentElement()	Return the top level element.
final int	getTagIndex()
void	host(Visitor visitor)	Send the visitor to this instance.

Methods inherited from class eu.bandm.tools.tdom.runtime.TypedDocument

createDictionary, decode, decodeEthereals, encode, encodeEthereals, end, getDTD, getEtherealContainer, getGenerationComment, getRootUntyped, setGenerationComment, start

Methods inherited from class eu.bandm.tools.tdom.runtime.TypedNode

asBigDecimal, asBigDecimal, asBigDecimal, asBigDecimal, asBigInteger, asBigInteger, asBigInteger, asBigInteger, asBoolean, asBoolean, asDouble, asDouble, asDouble, asDouble, asFloat, asFloat, asFloat, asFloat, asHexInt, asHexInt, asHexInt, asHexInt, asInt, asInt, asInt, asInt, asLong, asLong, asLong, asLong, asTrimmedString, asTrimmedString, asTrimmedString, asTrimmedString, checkPlus, checkPlus, checkStar, checkStar, checkStrict, encode, encodeOptional, encodePlus, encodePlus, encodeStar, encodeStar, extractEthereals, getLocation, getPCData, setLocation, setLocation, setLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Document_package

@Undocumented
Document_package(Document domDocument,
 Extension ext)
          throws TdomContentException,
TdomAttributeException

Parses an untyped W3C DOM document into a tdom instance.

Throws:

TdomContentException - if content models of contained elements are violated.

TdomAttributeException - if required attributes are missing, or attribute syntax is violated.

Document_package

@Undocumented
public Document_package(Element_package root)

Create a document in a bottom-up fashion from its toplevel element.

Parameters:

root - (never null) top element.

Document_package

Document_package(SAXEventStream in,
 Extension ext)
          throws TdomContentException,
TdomXmlException,
TdomAttributeException

Throws:

TdomContentException

TdomXmlException

TdomAttributeException

Document_package

public Document_package(InputStream in,
 Extension ext)
                 throws TdomContentException,
IOException,
TdomAttributeException

Input must be tdom-spec compressed encoding, as written by encode(EncodingOutputStream). XML text representation requires some XML parser and piping its SAX Events into #Document_package(SAXEventStream)}.

Throws:

TdomContentException

IOException

TdomAttributeException

Method Details

getDocumentElement

@Undocumented
public Element_package getDocumentElement()

Return the top level element. @return (never null) the top element.

host

public void host(Visitor visitor)

Description copied from interface: Visitable

Send the visitor to this instance.

getTagIndex

public final int getTagIndex()

Overrides:

getTagIndex in class TypedDocument<Element,Extension>

decode

protected final Element decode(DecodingInputStream in,
 Extension ext)
                        throws TdomContentException,
IOException,
TdomAttributeException

Specified by:

decode in class TypedDocument<Element,Extension>

Throws:

TdomContentException

IOException

TdomAttributeException

encode

public final void encode(EncodingOutputStream out,
 Extension ext)
                  throws IOException

Description copied from class: TypedNode

Abstract fall-back method which MUST be overridden and always throws an Exception.

Overrides:

encode in class TypedDocument<Element,Extension>

Throws:

IOException

encode

public final void encode(EncodingOutputStream out)
                  throws IOException

Throws:

IOException