Package eu.bandm.tools.tdom.runtime

Class TypedElement<E extends TypedElement<E,X>,X extends TypedExtension>

java.lang.Object

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

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

eu.bandm.tools.tdom.runtime.TypedElement<E,X>

All Implemented Interfaces:

Locatable<XMLDocumentIdentifier>, TypedContent

Direct Known Subclasses:

Element, Element, eu.bandm.tools.metajava.tdom.Element, Element, Element

public abstract class TypedElement<E extends TypedElement<E,X>,X extends TypedExtension>
extends TypedSubstantial<X>
implements TypedContent, Locatable<XMLDocumentIdentifier>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TypedElement.AttributeDecoder
static class	TypedElement.AttributeEncoder
static class	TypedElement.MixedContent<E extends TypedElement<E,X>,X extends TypedExtension>	Base class for all generated classes which model "mixed contents" or "unmixed contents".
static interface	TypedElement.MixedContentContainer	Implemented by all Element types which include PCDATA and other elements.
static class	TypedElement.MixedContentFactory<C extends TypedElement.MixedContent<E,X>,E extends TypedElement<E,X>,X extends TypedExtension,Y extends Exception>
static interface	TypedElement.PCDataContainer	Implemented by all Element types which include PCDATA.
static class	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.

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

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

Nested classes/interfaces inherited from interface eu.bandm.tools.tdom.runtime.TypedContent

TypedContent.DecodingConstructor<C extends TypedContent,X extends TypedExtension,Y extends Exception>, TypedContent.ParsingConstructor<C extends TypedContent,E extends TypedElement<E,X>,X extends TypedExtension,Y extends Exception>

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<TypedElement,String>	getDeepPCData
static final Function<TypedElement.MixedContentContainer,String>	getFlatPCData
protected final NamespaceName	name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypedElement(NamespaceName name)
protected	TypedElement(String name)	Deprecated.
protected	TypedElement(Element domElement)

Method Summary

Modifier and Type	Method	Description
abstract void	__dumpElementSnapshot(List<TypedSubstantial<X>> list)
protected TypedAttribute[]	__getAllAttrs()
protected static @Opt NamespaceName	classifyForException(TypedSubstantial s)
protected static <C extends TypedElement.MixedContent<E, X>, E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> C[]	decodeMixed(TypedElement.MixedContentFactory<C,E,X,Y> factory, DecodingInputStream in, X ext, Class<? extends C> contentClass, int max)
static <C extends TypedContent, E extends TypedExtension, Y extends Exception> C	decodeOptional(TypedContent.DecodingConstructor<C,E,Y> constructor, DecodingInputStream in, E ext)
static <C extends TypedContent, E extends TypedExtension, Y extends Exception> C[]	decodePlus(TypedContent.DecodingConstructor<? extends C,E,Y> constructor, DecodingInputStream in, E ext, Class<C> contentClass)
static <C extends TypedContent, E extends TypedExtension, Y extends Exception> CheckedListPlus<C>	decodePlusList(TypedContent.DecodingConstructor<? extends C,E,Y> constructor, DecodingInputStream in, E ext, Class<C> contentClass)
static <C extends TypedContent, E extends TypedExtension, Y extends Exception> C[]	decodeStar(TypedContent.DecodingConstructor<? extends C,E,Y> constructor, DecodingInputStream in, E ext, Class<C> contentClass)
static <C extends TypedContent, E extends TypedExtension, Y extends Exception> CheckedList<C>	decodeStarList(TypedContent.DecodingConstructor<? extends C,E,Y> constructor, DecodingInputStream in, E ext, Class<C> contentClass)
final void	encode(boolean asAbstract, EncodingOutputStream out, X ext)
protected static <E extends TypedExtension> void	encodeMixed(EncodingOutputStream out, E ext, int count, Iterator<? extends TypedElement.MixedContent<?,E>> i)
void	end(ContentHandler contentHandler, LexicalHandler lexicalHandler)
protected static void	ensureSize(List<?> list, int size)
protected static Element	extractElement(ContentMapping content)
List<TypedAttribute>	getAttrsSnapshot()	Call getAttrsSnapshot(boolean) in validating mode.
List<TypedAttribute>	getAttrsSnapshot(boolean validating)
abstract String	getDeepPCData()	Collect and concatenate all PCData, directly or indirectly contained in this model component (mostly: an Element).
List<TypedSubstantial<X>>	getElemsSnapshot()
TypedEtherealContainer	getEtherealContainer()	Gives access to the Comments and PIs after the opening tag and before the close tag.
final String	getLocalName()	Return the local part of the namespace name from this element's tag definition.
final NamespaceName	getName()	Return the NamespaceName.
final String	getNamespaceURI()	Return the URI part of the namespace name from this element's tag definition.
protected static String	getPCData(TypedElement.MixedContentContainer mcc)
abstract int	getTagIndex()
final String	getTagName()	Return the name as it was written in the original dtd.
protected void	initAttrs(@Opt Location<XMLDocumentIdentifier> from, @Opt Location<XMLDocumentIdentifier> to, Attributes attrs)	Will be called by generated code.
protected void	initAttrs(Attributes attrs)	Will be overridden by generated code which picks attribute values.
protected void	initAttrsSafe(@Opt Location<XMLDocumentIdentifier> from, @Opt Location<XMLDocumentIdentifier> to, Attributes attrs)	Will be called by generated code if not TdomAttributeSyntaxException can arise when parsing the attributes.
static void	matchEndElement(SAXEventStream in, NamespaceName name)
static void	matchEndElement(SAXEventStream in, String tag)
static Attributes	matchStartElement(SAXEventStream in, NamespaceName name)
static Attributes	matchStartElement(SAXEventStream in, String tag)
protected static <E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> TypedContent	parseAbstract(TypedDTD dtd, X ext, TypedNode.ParseListener<E> listener, Map<? super String,? extends TypedContent.ParsingConstructor<?,E,X,Y>> subclassTable, Element elem)
protected static <C extends TypedContent> C	parseAndClose(C content, SAXEventStream in, boolean explicit, String tagName)
protected static <C extends TypedContent> C	parseAndClose(C content, SAXEventStream in, String tagName)	Backwards compatibility definition.
protected static <E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> TypedElement.MixedContent[]	parseMixed(TypedElement.MixedContentFactory<?,E,X,Y> factory, SAXEventStream in, X ext, TypedNode.ParseListener<E> listener, TypedElement.MixedContent... array)
protected static <C extends TypedElement.MixedContent<E, X>, E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> void	parseMixed(TypedElement.MixedContentFactory<C,E,X,Y> factory, X ext, TypedNode.ParseListener<E> listener, Element domElement, List<? super C> l)
static <C extends TypedContent, E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> C	parseOptional(TypedContent.ParsingConstructor<C,E,X,Y> constructor, ContentMapping content, X ext, TypedNode.ParseListener<E> listener)
static <C extends TypedContent, E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> C[]	parsePlus(TypedContent.ParsingConstructor<? extends C,E,X,Y> constructor, ContentMapping content, X ext, TypedNode.ParseListener<E> listener, Class<C> contentClass)	DOCME ML ist das nur für w3cDom ??? und OHNE attribute ??? DANN nur TdomContentException !!
static <C extends TypedContent, E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> CheckedListPlus<C>	parsePlusList(TypedContent.ParsingConstructor<? extends C,E,X,Y> constructor, ContentMapping content, X ext, TypedNode.ParseListener<E> listener, Class<C> contentClass)
static <C extends TypedContent, E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> C[]	parseStar(TypedContent.ParsingConstructor<? extends C,E,X,Y> constructor, ContentMapping content, X ext, TypedNode.ParseListener<E> listener, Class<C> contentClass)
static <C extends TypedContent, E extends TypedElement<E, X>, X extends TypedExtension, Y extends Exception> CheckedList<C>	parseStarList(TypedContent.ParsingConstructor<? extends C,E,X,Y> constructor, ContentMapping content, X ext, TypedNode.ParseListener<E> listener, Class<C> contentClass)
protected static void	semiparseEmpty(TypedSubstantial<?>... content)
protected static <C extends TypedElement.MixedContent<E, X>, E extends TypedElement<E, X>, X extends TypedExtension> void	semiparseMixed(TypedElement.MixedContentFactory<C,E,X,?> factory, TypedSubstantial[] nodes, List<? super C> l)
protected static <A> void	setResizing(List<? super A> list, int index, A elem)
void	start(ContentHandler contentHandler, LexicalHandler lexicalHandler, Attributes attributes)
static NamespaceName	w3c_getNamespaceName(Node node)

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

dumpFollowingEthereals, dumpPrecedingEthereals, getFollowingEthereals, getPrecedingEthereals, readFollowingEthereals, readPrecedingEthereals

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

Methods inherited from interface eu.bandm.tools.location.Locatable

getLocation

Field Details

name

protected final NamespaceName name

getFlatPCData

public static final Function<TypedElement.MixedContentContainer,String> getFlatPCData

getDeepPCData

public static final Function<TypedElement,String> getDeepPCData

Constructor Details

TypedElement

@Deprecated
protected TypedElement(String name)

Deprecated.

TypedElement

protected TypedElement(NamespaceName name)

TypedElement

protected TypedElement(Element domElement)

Method Details

getEtherealContainer

public TypedEtherealContainer getEtherealContainer()

Gives access to the Comments and PIs after the opening tag and before the close tag.

Returns:

(never null) access to the Comments and PIs after the opening tag and before the close tag.

initAttrs

protected void initAttrs(Attributes attrs)
                  throws TdomAttributeSyntaxException

Will be overridden by generated code which picks attribute values. This default code simply does nothing, e.g. ignores the Attributes object and is sufficient for all Elements which do not carry Attributes.

Throws:

TdomAttributeSyntaxException

initAttrs

protected void initAttrs(@Opt
 @Opt Location<XMLDocumentIdentifier> from,
 @Opt
 @Opt Location<XMLDocumentIdentifier> to,
 Attributes attrs)
                  throws TdomAttributeSyntaxException

Will be called by generated code. Sets the location of the Element before invoking the generated code, which steps through the different Attributes. This is necessary for error messaging.

Throws:

TdomAttributeSyntaxException

initAttrsSafe

protected void initAttrsSafe(@Opt
 @Opt Location<XMLDocumentIdentifier> from,
 @Opt
 @Opt Location<XMLDocumentIdentifier> to,
 Attributes attrs)

Will be called by generated code if not TdomAttributeSyntaxException can arise when parsing the attributes. Sets the location of the Element before invoking the generated code, which steps through the different Attributes. This is necessary for error messaging.

getTagName

public final String getTagName()

Return the name as it was written in the original dtd. If the generation was NOT in namespace mode, then this name is a simple arbitrary identifier. The tdom application has been in namespace mode if ProcessingInstructions like "<? tdom xmlns:X='Y' ?>" have been present in the DTD source. Then there must be at most one(1) colon character ":" in the name, and it must be preceded by a prefix which appears in such a namespace declaration.

getNamespaceURI

public final String getNamespaceURI()

Return the URI part of the namespace name from this element's tag definition. If not in namespace mode (see getTagName()), it will be the empty string. See the documentation of NamespaceName for the different cases.

Returns:

(never null) the URI string of the namespace definition.

getLocalName

public final String getLocalName()

Return the local part of the namespace name from this element's tag definition. If not in namespace mode, this will be identic with getTagName(). Otherwise it is the part after the colon.

Returns:

(never null) the local string of the NamespaceName, in either mode.

getName

public final NamespaceName getName()

Return the NamespaceName. This class models names in both modes, namespace mode or non-namespace mode.

Returns:

(never null) the NamspaceName, in either mode.

getTagIndex

public abstract int getTagIndex()

extractElement

protected static Element extractElement(ContentMapping content)

parseOptional

public static <C extends TypedContent,
E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
C parseOptional(TypedContent.ParsingConstructor<C,E,X,Y> constructor,
 ContentMapping content,
 X ext,
 TypedNode.ParseListener<E> listener)
         throws TdomContentException,
Y

Throws:

TdomContentException

Y

parseStar

public static <C extends TypedContent,
E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
C[] parseStar(TypedContent.ParsingConstructor<? extends C,E,X,Y> constructor,
 ContentMapping content,
 X ext,
 TypedNode.ParseListener<E> listener,
 Class<C> contentClass)
       throws TdomContentException,
Y

Throws:

TdomContentException

Y

parseStarList

public static <C extends TypedContent,
E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
CheckedList<C> parseStarList(TypedContent.ParsingConstructor<? extends C,E,X,Y> constructor,
 ContentMapping content,
 X ext,
 TypedNode.ParseListener<E> listener,
 Class<C> contentClass)
                      throws TdomContentException,
Y

Throws:

TdomContentException

Y

parsePlus

public static <C extends TypedContent,
E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
C[] parsePlus(TypedContent.ParsingConstructor<? extends C,E,X,Y> constructor,
 ContentMapping content,
 X ext,
 TypedNode.ParseListener<E> listener,
 Class<C> contentClass)
       throws TdomContentException,
Y

DOCME ML ist das nur für w3cDom ??? und OHNE attribute ??? DANN nur TdomContentException !!

Throws:

TdomContentException

Y

parsePlusList

public static <C extends TypedContent,
E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
CheckedListPlus<C> parsePlusList(TypedContent.ParsingConstructor<? extends C,E,X,Y> constructor,
 ContentMapping content,
 X ext,
 TypedNode.ParseListener<E> listener,
 Class<C> contentClass)
                          throws TdomContentException,
Y

Throws:

TdomContentException

Y

encode

public final void encode(boolean asAbstract,
 EncodingOutputStream out,
 X ext)
                  throws IOException

Overrides:

encode in class TypedNode<X extends TypedExtension>

Throws:

IOException

decodeOptional

public static <C extends TypedContent,
E extends TypedExtension,
Y extends Exception>
C decodeOptional(TypedContent.DecodingConstructor<C,E,Y> constructor,
 DecodingInputStream in,
 E ext)
          throws IOException,
TdomContentException,
Y

Throws:

IOException

TdomContentException

Y

decodeStar

public static <C extends TypedContent,
E extends TypedExtension,
Y extends Exception>
C[] decodeStar(TypedContent.DecodingConstructor<? extends C,E,Y> constructor,
 DecodingInputStream in,
 E ext,
 Class<C> contentClass)
        throws IOException,
Y,
TdomContentException

Throws:

IOException

Y

TdomContentException

decodePlus

public static <C extends TypedContent,
E extends TypedExtension,
Y extends Exception>
C[] decodePlus(TypedContent.DecodingConstructor<? extends C,E,Y> constructor,
 DecodingInputStream in,
 E ext,
 Class<C> contentClass)
        throws IOException,
Y,
TdomContentException

Throws:

IOException

Y

TdomContentException

decodePlusList

public static <C extends TypedContent,
E extends TypedExtension,
Y extends Exception>
CheckedListPlus<C> decodePlusList(TypedContent.DecodingConstructor<? extends C,E,Y> constructor,
 DecodingInputStream in,
 E ext,
 Class<C> contentClass)
                           throws IOException,
Y,
TdomContentException

Throws:

IOException

Y

TdomContentException

decodeStarList

public static <C extends TypedContent,
E extends TypedExtension,
Y extends Exception>
CheckedList<C> decodeStarList(TypedContent.DecodingConstructor<? extends C,E,Y> constructor,
 DecodingInputStream in,
 E ext,
 Class<C> contentClass)
                       throws IOException,
Y,
TdomContentException

Throws:

IOException

Y

TdomContentException

w3c_getNamespaceName

public static NamespaceName w3c_getNamespaceName(Node node)

parseAbstract

protected static <E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
TypedContent parseAbstract(TypedDTD dtd,
 X ext,
 TypedNode.ParseListener<E> listener,
 Map<? super String,? extends TypedContent.ParsingConstructor<?,E,X,Y>> subclassTable,
 Element elem)
                    throws TdomContentException,
Y

Throws:

TdomContentException

Y

parseAndClose

protected static <C extends TypedContent> C parseAndClose(C content,
 SAXEventStream in,
 String tagName)
                                                   throws TdomXmlException

Backwards compatibility definition.

Throws:

TdomXmlException

parseAndClose

protected static <C extends TypedContent> C parseAndClose(C content,
 SAXEventStream in,
 boolean explicit,
 String tagName)
                                                   throws TdomXmlException

Throws:

TdomXmlException

matchStartElement

public static Attributes matchStartElement(SAXEventStream in,
 String tag)
                                    throws TdomContentException

Throws:

TdomContentException

matchStartElement

public static Attributes matchStartElement(SAXEventStream in,
 NamespaceName name)
                                    throws TdomContentException

Throws:

TdomContentException

matchEndElement

public static void matchEndElement(SAXEventStream in,
 String tag)
                            throws TdomXmlException

Throws:

TdomXmlException

matchEndElement

public static void matchEndElement(SAXEventStream in,
 NamespaceName name)
                            throws TdomXmlException

Throws:

TdomXmlException

parseMixed

protected static <C extends TypedElement.MixedContent<E,
X>,
E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
void parseMixed(TypedElement.MixedContentFactory<C,E,X,Y> factory,
 X ext,
 TypedNode.ParseListener<E> listener,
 Element domElement,
 List<? super C> l)
         throws TdomContentException,
Y

Throws:

TdomContentException

Y

semiparseMixed

protected static <C extends TypedElement.MixedContent<E,
X>,
E extends TypedElement<E,
X>,
X extends TypedExtension>
void semiparseMixed(TypedElement.MixedContentFactory<C,E,X,?> factory,
 TypedSubstantial[] nodes,
 List<? super C> l)
             throws TdomContentException

Throws:

TdomContentException

encodeMixed

protected static <E extends TypedExtension> void encodeMixed(EncodingOutputStream out,
 E ext,
 int count,
 Iterator<? extends TypedElement.MixedContent<?,E>> i)
                                                      throws IOException

Throws:

IOException

decodeMixed

protected static <C extends TypedElement.MixedContent<E,
X>,
E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
C[] decodeMixed(TypedElement.MixedContentFactory<C,E,X,Y> factory,
 DecodingInputStream in,
 X ext,
 Class<? extends C> contentClass,
 int max)
         throws IOException,
TdomContentException,
Y

Throws:

IOException

TdomContentException

Y

parseMixed

protected static <E extends TypedElement<E,
X>,
X extends TypedExtension,
Y extends Exception>
TypedElement.MixedContent[] parseMixed(TypedElement.MixedContentFactory<?,E,X,Y> factory,
 SAXEventStream in,
 X ext,
 TypedNode.ParseListener<E> listener,
 TypedElement.MixedContent... array)
                                throws Y,
TdomContentException,
TdomXmlException

Throws:

Y

TdomContentException

TdomXmlException

getPCData

protected static String getPCData(TypedElement.MixedContentContainer mcc)

getDeepPCData

public abstract String getDeepPCData()

Description copied from class: TypedSubstantial

Collect and concatenate all PCData, directly or indirectly contained in this model component (mostly: an Element).

Specified by:

getDeepPCData in class TypedSubstantial<X extends TypedExtension>

getAttrsSnapshot

public List<TypedAttribute> getAttrsSnapshot()

Call getAttrsSnapshot(boolean) in validating mode.

getAttrsSnapshot

public List<TypedAttribute> getAttrsSnapshot(boolean validating)

Parameters:

validating - If set to false, Attributes with no explicit value set by the user (i.e. only the default value) will not be contained in the snapshot.

__getAllAttrs

protected TypedAttribute[] __getAllAttrs()

__dumpElementSnapshot

public abstract void __dumpElementSnapshot(List<TypedSubstantial<X>> list)

getElemsSnapshot

public List<TypedSubstantial<X>> getElemsSnapshot()

ensureSize

protected static void ensureSize(List<?> list,
 int size)

setResizing

protected static <A> void setResizing(List<? super A> list,
 int index,
 A elem)

classifyForException

@Opt
protected static @Opt NamespaceName classifyForException(TypedSubstantial s)

semiparseEmpty

protected static void semiparseEmpty(TypedSubstantial<?>... content)
                              throws TdomContentException

Throws:

TdomContentException

start

public void start(ContentHandler contentHandler,
 LexicalHandler lexicalHandler,
 Attributes attributes)
           throws SAXException

Throws:

SAXException

end

public void end(ContentHandler contentHandler,
 LexicalHandler lexicalHandler)
         throws SAXException

Throws:

SAXException