Package eu.bandm.tools.lablog.xml

Class Element_docmat

java.lang.Object

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

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

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

eu.bandm.tools.lablog.xml.Element

eu.bandm.tools.lablog.xml.Element_docmat

All Implemented Interfaces:

Locatable<XMLDocumentIdentifier>, Matchable<BaseMatcher>, TypedContent, Visitable<Visitor>

@Undocumented
public class Element_docmat
extends Element
implements Visitable<Visitor>, Matchable<BaseMatcher>

<!ELEMENT docmat (name, authors, date, (reference)*, (a:p | a:SRC)*) >.
This class realizes the element definition from the source DTD.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Element_docmat.Choice_1	Realizes the content model (a:p | a:SRC)* , which is the 1st choice clause in the enclosing content model, realized by Element_docmat.
static class	Element_docmat.Choice_1_Alt_1	Realizes te content model a:p, which is the 1st alternative in the enclosing choice, realized by Element_docmat.Choice_1.
static class	Element_docmat.Choice_1_Alt_2	Realizes te content model a:SRC, which is the 2nd alternative in the enclosing choice, realized by Element_docmat.Choice_1.

Nested classes/interfaces inherited from class eu.bandm.tools.lablog.xml.Element

Element.UnmixedContent

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

TypedElement.AttributeDecoder, TypedElement.AttributeEncoder, TypedElement.MixedContent<E extends TypedElement<E,X>,X extends TypedExtension>, TypedElement.MixedContentContainer, TypedElement.MixedContentFactory<C extends TypedElement.MixedContent<E,X>,E extends TypedElement<E,X>,X extends TypedExtension,Y extends Exception>, TypedElement.PCDataContainer

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
(package private) Element_docmat.Choice_1[]	choices_1
(package private) Element_authors	elem_1_authors
(package private) Element_date	elem_1_date
(package private) Element_name	elem_1_name
(package private) Element_reference[]	elems_1_reference
(package private) static final String	localName
static final NamespaceName	name	Name of the Element is in namespace-enabled mode, namely {}docmat.
(package private) static final String	namespaceURI
(package private) static final String	prefix
static final int	TAG_INDEX
static final String	TAG_NAME	The name of the element, as it appears literally in the underlying DTD.

Fields inherited from class eu.bandm.tools.lablog.xml.Element

decodeTable, parseTable

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

getDeepPCData, getFlatPCData

Constructor Summary

Constructors

Constructor	Description
Element_docmat(Element_name elem_1_name, Element_authors elem_1_authors, Element_date elem_1_date, Element_reference[] elems_1_reference, Element_docmat.Choice_1... choices_1)	Statically typed w.r.t. the contents, as far as possible.
Element_docmat(Element... content)	Semi-parsing constructor which tries to parse sequences of model elements.
Element_docmat(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener)
Element_docmat(Attributes attrs, Element... content)	Semi-parsing constructor which tries to parse sequences of model content.

Method Summary

Modifier and Type	Method	Description
void	__dumpElementSnapshot(List<TypedSubstantial<Extension>> list)
final Element_docmat	checkRequiredAttrs()
int	countChoices_1()
int	countElems_1_reference()
(package private) static Element_docmat	decode(DecodingInputStream in, Extension ext)
final void	encode(EncodingOutputStream out, Extension ext)	Abstract fall-back method which MUST be overridden and always throws an Exception.
Element_docmat.Choice_1	getChoice_1(int index)
Element_docmat.Choice_1[]	getChoices_1()
(package private) static TypedContent.DecodingConstructor<? extends Element_docmat,Extension,TdomAttributeException>	getDecodeClosure()
Element_authors	getElem_1_authors()
Element_date	getElem_1_date()
Element_name	getElem_1_name()
Element_reference	getElem_1_reference(int index)
Element_reference[]	getElems_1_reference()
static TypedDTD.ElementInfo	getInterfaceInfo()	Give reflexive info object about the generated class.
(package private) static TypedContent.ParsingConstructor<? extends Element_docmat,Element,Extension,TdomAttributeException>	getParseClosure()
final int	getTagIndex()
void	host(Visitor visitor)	Send the visitor to this instance.
void	identify(BaseMatcher matcher)
(package private) static boolean	lookahead(Iterators.MultipleLookaheadIterator<? extends Element> i, boolean optional)
(package private) static boolean	lookahead(SAXEventStream in, Extension ext, boolean optional)
(package private) static Element_docmat	parse(ContentMapping content, Extension ext, TypedNode.ParseListener<Element> listener)
static Element_docmat	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_docmat	parse(Element domElement, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_docmat	parseOptional(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_docmat[]	parsePlus(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_docmat[]	parseStar(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
(package private) static Element_docmat	semiparse(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static @Opt Element_docmat	semiparseOptional(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static Element_docmat[]	semiparsePlus(Iterators.MultipleLookaheadIterator<? extends Element> i)
(package private) static Element_docmat[]	semiparseStar(Iterators.MultipleLookaheadIterator<? extends Element> i)
void	set(Element_name elem_1_name, Element_authors elem_1_authors, Element_date elem_1_date, Element_reference[] elems_1_reference, Element_docmat.Choice_1... choices_1)	Set all contents fields to a new value, after checking.
Element_docmat.Choice_1	setChoice_1(int index, Element_docmat.Choice_1 newChoice_1)
Element_docmat.Choice_1[]	setChoices_1(Element_docmat.Choice_1... newChoices_1)
Element_authors	setElem_1_authors(Element_authors newElem_1_authors)
Element_date	setElem_1_date(Element_date newElem_1_date)
Element_name	setElem_1_name(Element_name newElem_1_name)
Element_reference	setElem_1_reference(int index, Element_reference newElem_1_reference)
Element_reference[]	setElems_1_reference(Element_reference... newElems_1_reference)
void	visitChoices_1(Visitor visitor)	Sends the visitor to all items currently contained in the 1st appearance of Element_docmat.Choice_1 in the content model of this.
void	visitElems_1_reference(Visitor visitor)	Sends the visitor to all items currently contained in the 1st appearance of Element_reference in the content model of this.

Methods inherited from class eu.bandm.tools.lablog.xml.Element

getDeepPCData

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

__getAllAttrs, classifyForException, decodeMixed, decodeOptional, decodePlus, decodePlusList, decodeStar, decodeStarList, encode, encodeMixed, end, ensureSize, extractElement, getAttrsSnapshot, getAttrsSnapshot, getElemsSnapshot, getEtherealContainer, getLocalName, getName, getNamespaceURI, getPCData, getTagName, initAttrs, initAttrs, initAttrsSafe, matchEndElement, matchEndElement, matchStartElement, matchStartElement, parseAbstract, parseAndClose, parseAndClose, parseMixed, parseMixed, parseOptional, parsePlus, parsePlusList, parseStar, parseStarList, semiparseEmpty, semiparseMixed, setResizing, start, w3c_getNamespaceName

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, 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

TAG_INDEX

public static final int TAG_INDEX

See Also:

• Constant Field Values

elem_1_name

Element_name elem_1_name

elem_1_authors

Element_authors elem_1_authors

elem_1_date

Element_date elem_1_date

elems_1_reference

Element_reference[] elems_1_reference

choices_1

Element_docmat.Choice_1[] choices_1

TAG_NAME

public static final String TAG_NAME

The name of the element, as it appears literally in the underlying DTD.

See Also:

• Constant Field Values

namespaceURI

static final String namespaceURI

See Also:

• Constant Field Values

prefix

static final String prefix

See Also:

• Constant Field Values

localName

static final String localName

See Also:

• Constant Field Values

name

public static final NamespaceName name

Name of the Element is in namespace-enabled mode, namely {}docmat.

Constructor Details

Element_docmat

@Undocumented
public Element_docmat(Element_name elem_1_name,
 Element_authors elem_1_authors,
 Element_date elem_1_date,
 Element_reference[] elems_1_reference,
 Element_docmat.Choice_1... choices_1)

Statically typed w.r.t. the contents, as far as possible. So a TdomContentException can not occur.

Throws:

IllegalArgumentException - if any input to contents is null.

Element_docmat

Element_docmat(ContentMapping content,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
        throws TdomContentException,
TdomAttributeException

Throws:

TdomContentException

TdomAttributeException

Element_docmat

@SafeVarargs
@Undocumented
public Element_docmat(@Opt
 Attributes attrs,
 Element... content)
               throws TdomContentException

Semi-parsing constructor which tries to parse sequences of model content. Dynamically typed.

Parameters:

content - the Element sequence to parse.

Throws:

TdomContentException - if the sequence in 'contents' does not match the content model.

IllegalArgumentException - if any input to contents is null.

Element_docmat

@SafeVarargs
@Undocumented
public Element_docmat(Element... content)
               throws TdomContentException

Semi-parsing constructor which tries to parse sequences of model elements. Dynamically typed.

Parameters:

content - the Element sequence to parse.

Throws:

TdomContentException - if the sequence in 'contents' does not match the content model.

IllegalArgumentException - if any input to contents is null.

Method Details

set

@Undocumented
public void set(Element_name elem_1_name,
 Element_authors elem_1_authors,
 Element_date elem_1_date,
 Element_reference[] elems_1_reference,
 Element_docmat.Choice_1... choices_1)

Set all contents fields to a new value, after checking. Statically typed, as far as possible. So a TdomContentException can not occur.
(Values of Attributes are not affected.)

Throws:

IllegalArgumentException - if any input to contents is null.

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.

Specified by:

encode in class TypedNode<Extension>

Throws:

IOException

decode

static Element_docmat decode(DecodingInputStream in,
 Extension ext)
                      throws TdomContentException,
IOException,
TdomAttributeException

Throws:

TdomContentException

IOException

TdomAttributeException

__dumpElementSnapshot

public void __dumpElementSnapshot(List<TypedSubstantial<Extension>> list)

Specified by:

__dumpElementSnapshot in class TypedElement<Element,Extension>

getTagIndex

public final int getTagIndex()

Specified by:

getTagIndex in class TypedElement<Element,Extension>

getElem_1_name

@Undocumented
public Element_name getElem_1_name()

Returns:

(never null) the current value of the 1st appearance of Element_name in the content model of this.

setElem_1_name

@Undocumented
public Element_name setElem_1_name(Element_name newElem_1_name)

Parameters:

newElem_1_name - (never null) new value for the 1st appearance of Element_name in the content model of this.

Returns:

(never null) the overwritten value.

Throws:

IllegalArgumentException - in case of null.

getElem_1_authors

@Undocumented
public Element_authors getElem_1_authors()

Returns:

(never null) the current value of the 1st appearance of Element_authors in the content model of this.

setElem_1_authors

@Undocumented
public Element_authors setElem_1_authors(Element_authors newElem_1_authors)

Parameters:

newElem_1_authors - (never null) new value for the 1st appearance of Element_authors in the content model of this.

Returns:

(never null) the overwritten value.

Throws:

IllegalArgumentException - in case of null.

getElem_1_date

@Undocumented
public Element_date getElem_1_date()

Returns:

(never null) the current value of the 1st appearance of Element_date in the content model of this.

setElem_1_date

@Undocumented
public Element_date setElem_1_date(Element_date newElem_1_date)

Parameters:

newElem_1_date - (never null) new value for the 1st appearance of Element_date in the content model of this.

Returns:

(never null) the overwritten value.

Throws:

IllegalArgumentException - in case of null.

getElems_1_reference

@Undocumented
public Element_reference[] getElems_1_reference()

Returns:

(never null) an array of all items (never null) currently contained in the 1st appearance of Element_reference in the content model of this. This is directly the storage of the element's contents and all manipulations affect the element instance.

getElem_1_reference

@Undocumented
public Element_reference getElem_1_reference(int index)

Returns:

(never null) the current value at the index position of the 1st appearance of Element_reference in the content model of this.

Throws:

ArrayIndexOutOfBoundsException

countElems_1_reference

public int countElems_1_reference()

Returns:

the current number of items in the 1st appearance of Element_reference in the content model of this.

visitElems_1_reference

@Undocumented
public void visitElems_1_reference(Visitor visitor)

Sends the visitor to all items currently contained in the 1st appearance of Element_reference in the content model of this.

setElem_1_reference

@Undocumented
public Element_reference setElem_1_reference(int index,
 Element_reference newElem_1_reference)

Parameters:

newElem_1_reference - (never null) new value at the given index position in the 1st appearance of Element_reference in the content model of this.

Returns:

(never null) the overwritten value.

Throws:

IllegalArgumentException - on attempt to set null value.

IndexOutOfBoundsException - if current array is not large enough.

setElems_1_reference

@Undocumented
public Element_reference[] setElems_1_reference(Element_reference... newElems_1_reference)

Parameters:

newElems_1_reference - (never null) an array of all values (never null) in the 1st appearance of Element_reference in the content model of this.

Returns:

(never null) an array of the overwritten values (never null).

Throws:

IllegalArgumentException - if the array is null, or a null value is contained therein .

getChoices_1

@Undocumented
public Element_docmat.Choice_1[] getChoices_1()

Returns:

(never null) an array of all items (never null) currently contained in the 1st appearance of Element_docmat.Choice_1 in the content model of this. This is directly the storage of the element's contents and all manipulations affect the element instance.

getChoice_1

@Undocumented
public Element_docmat.Choice_1 getChoice_1(int index)

Returns:

(never null) the current value at the index position of the 1st appearance of Element_docmat.Choice_1 in the content model of this.

Throws:

ArrayIndexOutOfBoundsException

countChoices_1

public int countChoices_1()

Returns:

the current number of items in the 1st appearance of Element_docmat.Choice_1 in the content model of this.

visitChoices_1

@Undocumented
public void visitChoices_1(Visitor visitor)

Sends the visitor to all items currently contained in the 1st appearance of Element_docmat.Choice_1 in the content model of this.

setChoice_1

@Undocumented
public Element_docmat.Choice_1 setChoice_1(int index,
 Element_docmat.Choice_1 newChoice_1)

Parameters:

newChoice_1 - (never null) new value at the given index position in the 1st appearance of Element_docmat.Choice_1 in the content model of this.

Returns:

(never null) the overwritten value.

Throws:

IllegalArgumentException - on attempt to set null value.

IndexOutOfBoundsException - if current array is not large enough.

setChoices_1

@Undocumented
public Element_docmat.Choice_1[] setChoices_1(Element_docmat.Choice_1... newChoices_1)

Parameters:

newChoices_1 - (never null) an array of all values (never null) in the 1st appearance of Element_docmat.Choice_1 in the content model of this.

Returns:

(never null) an array of the overwritten values (never null).

Throws:

IllegalArgumentException - if the array is null, or a null value is contained therein .

parse

static Element_docmat parse(Element domElement,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                     throws TdomContentException,
TdomAttributeException

Throws:

TdomContentException

TdomAttributeException

parse

static Element_docmat parse(ContentMapping content,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                     throws TdomContentException,
TdomAttributeException

Throws:

TdomContentException

TdomAttributeException

getParseClosure

static TypedContent.ParsingConstructor<? extends Element_docmat,Element,Extension,TdomAttributeException> getParseClosure()

getDecodeClosure

static TypedContent.DecodingConstructor<? extends Element_docmat,Extension,TdomAttributeException> getDecodeClosure()

parseStar

static Element_docmat[] parseStar(SAXEventStream in,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                           throws TdomContentException,
TdomAttributeException,
TdomXmlException

Throws:

TdomContentException

TdomAttributeException

TdomXmlException

parsePlus

static Element_docmat[] parsePlus(SAXEventStream in,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                           throws TdomContentException,
TdomAttributeException,
TdomXmlException

Throws:

TdomContentException

TdomAttributeException

TdomXmlException

parseOptional

static Element_docmat parseOptional(SAXEventStream in,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                             throws TdomContentException,
TdomAttributeException,
TdomXmlException

Throws:

TdomContentException

TdomAttributeException

TdomXmlException

lookahead

static boolean lookahead(SAXEventStream in,
 Extension ext,
 boolean optional)

parse

public static Element_docmat parse(SAXEventStream in,
 Extension ext,
 TypedNode.ParseListener<Element> listener)
                            throws TdomContentException,
TdomAttributeException,
TdomXmlException

Throws:

TdomContentException

TdomAttributeException

TdomXmlException

semiparseStar

static Element_docmat[] semiparseStar(Iterators.MultipleLookaheadIterator<? extends Element> i)
                               throws TdomContentException

Throws:

TdomContentException

semiparsePlus

static Element_docmat[] semiparsePlus(Iterators.MultipleLookaheadIterator<? extends Element> i)
                               throws TdomContentException

Throws:

TdomContentException

semiparseOptional

@Opt
static @Opt Element_docmat semiparseOptional(Iterators.MultipleLookaheadIterator<? extends Element> i)
                                      throws TdomContentException

Throws:

TdomContentException

lookahead

static boolean lookahead(Iterators.MultipleLookaheadIterator<? extends Element> i,
 boolean optional)

semiparse

static Element_docmat semiparse(Iterators.MultipleLookaheadIterator<? extends Element> i)
                         throws TdomContentException

Throws:

TdomContentException

host

public void host(Visitor visitor)

Description copied from interface: Visitable

Send the visitor to this instance.

Specified by:

host in interface Visitable<Visitor>

identify

public void identify(BaseMatcher matcher)

Specified by:

identify in interface Matchable<BaseMatcher>

checkRequiredAttrs

public final Element_docmat checkRequiredAttrs()

getInterfaceInfo

@Undocumented
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.