eu.bandm.tools.lablog.xml

Class Element_a_list

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_a_list

All Implemented Interfaces:

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

@User
public class Element_a_list
extends Element
implements Visitable<Visitor>, Matchable<BaseMatcher>

<!ELEMENT a:list ((a:listSymbol)?, (a:listStartnum | a:listContinues)?, (a:label)?, (a:listitem)+) >.
This class realizes the element definition from the source DTD.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Element_a_list.Choice_1 Realizes the content model (a:listStartnum | a:listContinues)? , which is the 1st choice clause in the enclosing content model, realized by Element_a_list.
static class	Element_a_list.Choice_1_Alt_1 Realizes te content model a:listStartnum, which is the 1st alternative in the enclosing choice, realized by Element_a_list.Choice_1.
static class	Element_a_list.Choice_1_Alt_2 Realizes te content model a:listContinues, which is the 2nd alternative in the enclosing choice, realized by Element_a_list.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 and Description
static NamespaceName	name Name of the Element is in namespace-enabled mode, namely {http://bandm.eu/doctypes/d2d_gp/basic}a:list.
static int	TAG_INDEX
static String	TAG_NAME The name of the element, as it appears literally in the underlying DTD.

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

getDeepPCData, getFlatPCData

Constructor Summary

Constructors

Constructor and Description
Element_a_list(Attributes attrs, Element... content) Semi-parsing constructor which tries to parse sequences of model content.
Element_a_list(Element_a_listSymbol elem_1_a_listSymbol, Element_a_list.Choice_1 choice_1, Element_a_label elem_1_a_label, Element_a_listitem... elems_1_a_listitem) Statically typed w.r.t. the contents, as far as possible.
Element_a_list(Element... content) Semi-parsing constructor which tries to parse sequences of model elements.

Method Summary

Modifier and Type	Method and Description
void	__dumpElementSnapshot(List<TypedSubstantial<Extension>> list)
Element_a_list	checkRequiredAttrs()
int	countElems_1_a_listitem()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
@Opt Element_a_list.Choice_1	getChoice_1()
@Opt Element_a_label	getElem_1_a_label()
Element_a_listitem	getElem_1_a_listitem(int index)
@Opt Element_a_listSymbol	getElem_1_a_listSymbol()
Element_a_listitem[]	getElems_1_a_listitem()
static TypedDTD.ElementInfo	getInterfaceInfo() Give reflexive info object about the generated class.
int	getTagIndex()
boolean	hasChoice_1()
boolean	hasElem_1_a_label()
boolean	hasElem_1_a_listSymbol()
void	host(Visitor visitor) Send the visitor to this instance.
void	identify(BaseMatcher matcher)
static Element_a_list	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
void	set(Element_a_listSymbol elem_1_a_listSymbol, Element_a_list.Choice_1 choice_1, Element_a_label elem_1_a_label, Element_a_listitem... elems_1_a_listitem) Set all contents fields to a new value, after checking.
Element_a_list.Choice_1	setChoice_1(@Opt Element_a_list.Choice_1 newChoice_1)
Element_a_label	setElem_1_a_label(@Opt Element_a_label newElem_1_a_label)
Element_a_listitem	setElem_1_a_listitem(int index, Element_a_listitem newElem_1_a_listitem)
Element_a_listSymbol	setElem_1_a_listSymbol(@Opt Element_a_listSymbol newElem_1_a_listSymbol)
Element_a_listitem[]	setElems_1_a_listitem(Element_a_listitem... newElems_1_a_listitem)
void	visitElems_1_a_listitem(Visitor visitor) Sends the visitor to all items currently contained in the 1st appearance of Element_a_listitem 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.message.Locatable

getLocation

Field Detail

TAG_INDEX

public static final int TAG_INDEX

See Also:

Constant Field Values

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

name

public static final NamespaceName name

Name of the Element is in namespace-enabled mode, namely {http://bandm.eu/doctypes/d2d_gp/basic}a:list.

Constructor Detail

Element_a_list

@User
public Element_a_list(Element_a_listSymbol elem_1_a_listSymbol,
                            Element_a_list.Choice_1 choice_1,
                            Element_a_label elem_1_a_label,
                            Element_a_listitem... elems_1_a_listitem)

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, except where explicitly allowed by (..)? in the content model.

IllegalArgumentException - if an array for a (..)+ in the content model is empty.

Element_a_list

@SafeVarargs
 @User
public Element_a_list(@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, except where explicitly allowed by (..)? in the content model.

Element_a_list

@SafeVarargs
 @User
public Element_a_list(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, except where explicitly allowed by (..)? in the content model.

Method Detail

set

@User
public void set(Element_a_listSymbol elem_1_a_listSymbol,
                      Element_a_list.Choice_1 choice_1,
                      Element_a_label elem_1_a_label,
                      Element_a_listitem... elems_1_a_listitem)

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, except where explicitly allowed by (..)? in the content model.

IllegalArgumentException - if an array for a (..)+ in the content model is empty.

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

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

hasElem_1_a_listSymbol

@User
public boolean hasElem_1_a_listSymbol()

Returns:

whether the 1st appearance of Element_a_listSymbol in the content model of this is not set to null

getElem_1_a_listSymbol

@User
 @Opt
public @Opt Element_a_listSymbol getElem_1_a_listSymbol()

Returns:

(maybe null) the current value of the 1st appearance of Element_a_listSymbol in the content model of this.

setElem_1_a_listSymbol

@User
public Element_a_listSymbol setElem_1_a_listSymbol(@Opt
                                                         @Opt Element_a_listSymbol newElem_1_a_listSymbol)

Parameters:

newElem_1_a_listSymbol - (maybe null) new value for the 1st appearance of Element_a_listSymbol in the content model of this.

Returns:

(maybe null) the overwritten value.

hasChoice_1

@User
public boolean hasChoice_1()

Returns:

whether the 1st appearance of Element_a_list.Choice_1 in the content model of this is not set to null

getChoice_1

@User
 @Opt
public @Opt Element_a_list.Choice_1 getChoice_1()

Returns:

(maybe null) the current value of the 1st appearance of Element_a_list.Choice_1 in the content model of this.

setChoice_1

@User
public Element_a_list.Choice_1 setChoice_1(@Opt
                                                 @Opt Element_a_list.Choice_1 newChoice_1)

Parameters:

newChoice_1 - (maybe null) new value for the 1st appearance of Element_a_list.Choice_1 in the content model of this.

Returns:

(maybe null) the overwritten value.

hasElem_1_a_label

@User
public boolean hasElem_1_a_label()

Returns:

whether the 1st appearance of Element_a_label in the content model of this is not set to null

getElem_1_a_label

@User
 @Opt
public @Opt Element_a_label getElem_1_a_label()

Returns:

(maybe null) the current value of the 1st appearance of Element_a_label in the content model of this.

setElem_1_a_label

@User
public Element_a_label setElem_1_a_label(@Opt
                                               @Opt Element_a_label newElem_1_a_label)

Parameters:

newElem_1_a_label - (maybe null) new value for the 1st appearance of Element_a_label in the content model of this.

Returns:

(maybe null) the overwritten value.

getElems_1_a_listitem

@User
public Element_a_listitem[] getElems_1_a_listitem()

Returns:

(never null) an array of all items (never null) currently contained in the 1st appearance of Element_a_listitem 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_a_listitem

@User
public Element_a_listitem getElem_1_a_listitem(int index)

Returns:

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

Throws:

ArrayIndexOutOfBoundsException

countElems_1_a_listitem

public int countElems_1_a_listitem()

Returns:

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

visitElems_1_a_listitem

@User
public void visitElems_1_a_listitem(Visitor visitor)

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

setElem_1_a_listitem

@User
public Element_a_listitem setElem_1_a_listitem(int index,
                                                     Element_a_listitem newElem_1_a_listitem)

Parameters:

newElem_1_a_listitem - (never null) new value at the given index position in the 1st appearance of Element_a_listitem 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_a_listitem

@User
public Element_a_listitem[] setElems_1_a_listitem(Element_a_listitem... newElems_1_a_listitem)

Parameters:

newElems_1_a_listitem - (never null) an array of all values (never null) in the 1st appearance of Element_a_listitem 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 , or the array is empty.

parse

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

Throws:

TdomXmlException

TdomContentException

TdomAttributeException

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_a_list checkRequiredAttrs()

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.