eu.bandm.tools.lablog.xml

Class Element_note

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_note

All Implemented Interfaces:

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

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

<!ELEMENT note (authors, date, (ACCEPTED | FIXED | CLOSED | WONTFIX | WORKSFORME | REOPENED)?, (prior)?, (costs)?, (a:p | a:SRC)*) >.
This class realizes the element definition from the source DTD.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Element_note.Choice_1 Realizes the content model (ACCEPTED | FIXED | CLOSED | WONTFIX | WORKSFORME | REOPENED)? , which is the 1st choice clause in the enclosing content model, realized by Element_note.
static class	Element_note.Choice_1_Alt_1 Realizes te content model ACCEPTED, which is the 1st alternative in the enclosing choice, realized by Element_note.Choice_1.
static class	Element_note.Choice_1_Alt_2 Realizes te content model FIXED, which is the 2nd alternative in the enclosing choice, realized by Element_note.Choice_1.
static class	Element_note.Choice_1_Alt_3 Realizes te content model CLOSED, which is the 3rd alternative in the enclosing choice, realized by Element_note.Choice_1.
static class	Element_note.Choice_1_Alt_4 Realizes te content model WONTFIX, which is the 4th alternative in the enclosing choice, realized by Element_note.Choice_1.
static class	Element_note.Choice_1_Alt_5 Realizes te content model WORKSFORME, which is the 5th alternative in the enclosing choice, realized by Element_note.Choice_1.
static class	Element_note.Choice_1_Alt_6 Realizes te content model REOPENED, which is the 6th alternative in the enclosing choice, realized by Element_note.Choice_1.
static class	Element_note.Choice_2 Realizes the content model (a:p | a:SRC)* , which is the 2nd choice clause in the enclosing content model, realized by Element_note.
static class	Element_note.Choice_2_Alt_1 Realizes te content model a:p, which is the 1st alternative in the enclosing choice, realized by Element_note.Choice_2.
static class	Element_note.Choice_2_Alt_2 Realizes te content model a:SRC, which is the 2nd alternative in the enclosing choice, realized by Element_note.Choice_2.

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 {}note.
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_note(Attributes attrs, Element... content) Semi-parsing constructor which tries to parse sequences of model content.
Element_note(Element_authors elem_1_authors, Element_date elem_1_date, Element_note.Choice_1 choice_1, Element_prior elem_1_prior, Element_costs elem_1_costs, Element_note.Choice_2... choices_2) Statically typed w.r.t. the contents, as far as possible.
Element_note(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_note	checkRequiredAttrs()
int	countChoices_2()
void	encode(EncodingOutputStream out, Extension ext) Abstract fall-back method which MUST be overridden and always throws an Exception.
@Opt Element_note.Choice_1	getChoice_1()
Element_note.Choice_2	getChoice_2(int index)
Element_note.Choice_2[]	getChoices_2()
Element_authors	getElem_1_authors()
@Opt Element_costs	getElem_1_costs()
Element_date	getElem_1_date()
@Opt Element_prior	getElem_1_prior()
static TypedDTD.ElementInfo	getInterfaceInfo() Give reflexive info object about the generated class.
int	getTagIndex()
boolean	hasChoice_1()
boolean	hasElem_1_costs()
boolean	hasElem_1_prior()
void	host(Visitor visitor) Send the visitor to this instance.
void	identify(BaseMatcher matcher)
static Element_note	parse(SAXEventStream in, Extension ext, TypedNode.ParseListener<Element> listener)
void	set(Element_authors elem_1_authors, Element_date elem_1_date, Element_note.Choice_1 choice_1, Element_prior elem_1_prior, Element_costs elem_1_costs, Element_note.Choice_2... choices_2) Set all contents fields to a new value, after checking.
Element_note.Choice_1	setChoice_1(@Opt Element_note.Choice_1 newChoice_1)
Element_note.Choice_2	setChoice_2(int index, Element_note.Choice_2 newChoice_2)
Element_note.Choice_2[]	setChoices_2(Element_note.Choice_2... newChoices_2)
Element_authors	setElem_1_authors(Element_authors newElem_1_authors)
Element_costs	setElem_1_costs(@Opt Element_costs newElem_1_costs)
Element_date	setElem_1_date(Element_date newElem_1_date)
Element_prior	setElem_1_prior(@Opt Element_prior newElem_1_prior)
void	visitChoices_2(Visitor visitor) Sends the visitor to all items currently contained in the 2nd appearance of Element_note.Choice_2 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 {}note.

Constructor Detail

Element_note

@User
public Element_note(Element_authors elem_1_authors,
                          Element_date elem_1_date,
                          Element_note.Choice_1 choice_1,
                          Element_prior elem_1_prior,
                          Element_costs elem_1_costs,
                          Element_note.Choice_2... choices_2)

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.

Element_note

@SafeVarargs
 @User
public Element_note(@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_note

@SafeVarargs
 @User
public Element_note(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_authors elem_1_authors,
                      Element_date elem_1_date,
                      Element_note.Choice_1 choice_1,
                      Element_prior elem_1_prior,
                      Element_costs elem_1_costs,
                      Element_note.Choice_2... choices_2)

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.

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>

getElem_1_authors

@User
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

@User
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

@User
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

@User
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.

hasChoice_1

@User
public boolean hasChoice_1()

Returns:

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

getChoice_1

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

Returns:

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

setChoice_1

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

Parameters:

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

Returns:

(maybe null) the overwritten value.

hasElem_1_prior

@User
public boolean hasElem_1_prior()

Returns:

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

getElem_1_prior

@User
 @Opt
public @Opt Element_prior getElem_1_prior()

Returns:

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

setElem_1_prior

@User
public Element_prior setElem_1_prior(@Opt
                                           @Opt Element_prior newElem_1_prior)

Parameters:

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

Returns:

(maybe null) the overwritten value.

hasElem_1_costs

@User
public boolean hasElem_1_costs()

Returns:

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

getElem_1_costs

@User
 @Opt
public @Opt Element_costs getElem_1_costs()

Returns:

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

setElem_1_costs

@User
public Element_costs setElem_1_costs(@Opt
                                           @Opt Element_costs newElem_1_costs)

Parameters:

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

Returns:

(maybe null) the overwritten value.

getChoices_2

@User
public Element_note.Choice_2[] getChoices_2()

Returns:

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

getChoice_2

@User
public Element_note.Choice_2 getChoice_2(int index)

Returns:

(never null) the current value at the index position of the 2nd appearance of Element_note.Choice_2 in the content model of this.

Throws:

ArrayIndexOutOfBoundsException

countChoices_2

public int countChoices_2()

Returns:

the current number of items in the 2nd appearance of Element_note.Choice_2 in the content model of this.

visitChoices_2

@User
public void visitChoices_2(Visitor visitor)

Sends the visitor to all items currently contained in the 2nd appearance of Element_note.Choice_2 in the content model of this.

setChoice_2

@User
public Element_note.Choice_2 setChoice_2(int index,
                                               Element_note.Choice_2 newChoice_2)

Parameters:

newChoice_2 - (never null) new value at the given index position in the 2nd appearance of Element_note.Choice_2 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_2

@User
public Element_note.Choice_2[] setChoices_2(Element_note.Choice_2... newChoices_2)

Parameters:

newChoices_2 - (never null) an array of all values (never null) in the 2nd appearance of Element_note.Choice_2 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

public static Element_note 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_note checkRequiredAttrs()

getInterfaceInfo

@User
public static TypedDTD.ElementInfo getInterfaceInfo()

Give reflexive info object about the generated class.