Package eu.bandm.tools.tdom

Class ContainerTemplate

java.lang.Object

eu.bandm.tools.tdom.Template

eu.bandm.tools.tdom.NodeTemplate

eu.bandm.tools.tdom.ContainerTemplate

Direct Known Subclasses:

AltTemplate, ChoiceTemplate, ElementTemplate, SequenceTemplate

abstract class ContainerTemplate
extends NodeTemplate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ContainerTemplate.ContentModelRenderer
(package private) static class	ContainerTemplate.ContentProperties	Analysis special for API DOC generation.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	childIndex
protected List<ContainerTemplate>	children
protected GeneratedMethod	decodeMethod
protected GeneratedConstructor	disambigConstructor
protected GeneratedConstructor	disambigConstructorSafe
protected GeneratedMethod	dumpElementsMethod
protected GeneratedMethod	dumpMethod
protected final ElementTemplate	elementTemplate
protected GeneratedMethod	encodeMethod
protected String	innerContainerPrefix
protected Set<String>	mandatoryDirector
protected int[]	numbering
protected Set<String>	optionalDirector
protected final ContainerTemplate	parentContainer
protected GeneratedMethod	setMethod
protected GeneratedConstructor	typedConstructor
protected GeneratedConstructor	untypedConstructor
protected GeneratedMethod	visitMethod

Fields inherited from class eu.bandm.tools.tdom.NodeTemplate

actionMethod, decodeClosure, getDecodeClosure, getParseClosure, nodeClass, packageTemplate, parseClosure, parseSAX, parseSAXArguments, parseSAXAttributes, semiparseArguments, semiparseStatements, usingSemiparser

Fields inherited from class eu.bandm.tools.tdom.Template

msg

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContainerTemplate(ContainerTemplate parentContainer)
(package private)	ContainerTemplate(PackageTemplate packageTemplate)

Method Summary

Modifier and Type	Method	Description
void	addAttrDescendStatement(String methodName)
void	addChild(ContainerTemplate child)
void	addDecodeArgument(Format decodeArgument)
(package private) void	addDescendStatement(Format template)
(package private) void	addDescendStatement(Format template, boolean priority)
void	addVisitContentStatement(String fieldName, String singularName, int modifier)
protected abstract DTD.ContentModel	contentModel()
protected void	finish()
protected void	generateDeclComment()
protected GeneratedMethod	generateDecodeMethod()
void	generateDecodeStatement()
protected GeneratedMethod	generateDumpElementsMethod()
protected GeneratedMethod	generateDumpMethod()
protected GeneratedMethod	generateEncodeMethod()
protected GeneratedMethod	generateParseMethod()
protected GeneratedMethod	generateSetMethod()	ATTENTION the set method serves as a prototype and the sequence of its parameters is copied to several other methods (for structured contents, defined by DTD.CP).
protected GeneratedConstructor	generateTypedConstructor()	The "typed constructor" has the same signature as the set(...) method, namely what corresponds correctly to the content model (notwithstanding null-checks and array length.)
protected GeneratedConstructor	generateUntypedConstructor()	The "untyped constructor" requires a tdom object and is NORMALLY NOT visible to/callable by the programmer.
protected GeneratedMethod	generateVisitMethod()	For TypedSequence, TypedChoice, TypedAlt.
int	getNumber()
protected void	init()
protected ContentParserGenerator.Rule	internalSetDirectors(ContentParserGenerator.Rule rule)
protected abstract void	setDirectors(ContentParserGenerator.Rule rule)
void	setNumbering(DTD.CP cp)
(package private) void	useSemiparser()

Methods inherited from class eu.bandm.tools.tdom.NodeTemplate

addGeneralizeParent, addLookaheadSAXStatement, addLookaheadSAXStatement, addLookaheadSemiparseStatement, addLookaheadSemiparseStatement, addParseSAXArgument, addParseSAXArgument, addParseSAXAttribute, addParseSAXStatement, addSemiparseArgument, addSemiparseArgument, addSemiparseStatement, generateActionMethod, generateDecodeClosure, generateHostMethod, generateMatchWithMethod, generateMatchWithMethod, generateParseClosure, generateParseSAXAction, generateSAXParser, generateSemiparseAction, generateSemiparser_includingAlt, generateSemiparser_nonAlt, getNodeClass, getVisiteeName, parseSAXArguments_asFormat

Methods inherited from class eu.bandm.tools.tdom.Template

error, error, expression, statement, statements, warning, warning

Methods inherited from class java.lang.Object

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

Field Details

elementTemplate

protected final ElementTemplate elementTemplate

parentContainer

protected final ContainerTemplate parentContainer

children

protected List<ContainerTemplate> children

innerContainerPrefix

protected String innerContainerPrefix

numbering

protected int[] numbering

childIndex

protected int childIndex

typedConstructor

protected GeneratedConstructor typedConstructor

untypedConstructor

protected GeneratedConstructor untypedConstructor

disambigConstructor

protected GeneratedConstructor disambigConstructor

disambigConstructorSafe

protected GeneratedConstructor disambigConstructorSafe

setMethod

protected GeneratedMethod setMethod

visitMethod

protected GeneratedMethod visitMethod

encodeMethod

protected GeneratedMethod encodeMethod

decodeMethod

protected GeneratedMethod decodeMethod

dumpMethod

protected GeneratedMethod dumpMethod

dumpElementsMethod

protected GeneratedMethod dumpElementsMethod

mandatoryDirector

protected Set<String> mandatoryDirector

optionalDirector

protected Set<String> optionalDirector

Constructor Details

ContainerTemplate

ContainerTemplate(PackageTemplate packageTemplate)

ContainerTemplate

protected ContainerTemplate(ContainerTemplate parentContainer)

Method Details

contentModel

protected abstract DTD.ContentModel contentModel()

init

protected void init()

Overrides:

init in class NodeTemplate

finish

protected void finish()

Overrides:

finish in class NodeTemplate

generateDeclComment

protected void generateDeclComment()

generateVisitMethod

protected GeneratedMethod generateVisitMethod()

For TypedSequence, TypedChoice, TypedAlt.

generateDumpMethod

protected GeneratedMethod generateDumpMethod()

generateDumpElementsMethod

protected GeneratedMethod generateDumpElementsMethod()

addAttrDescendStatement

public void addAttrDescendStatement(String methodName)

addDescendStatement

void addDescendStatement(Format template)

addDescendStatement

void addDescendStatement(Format template,
 boolean priority)

Overrides:

addDescendStatement in class NodeTemplate

setNumbering

public void setNumbering(DTD.CP cp)

getNumber

public int getNumber()

generateTypedConstructor

protected GeneratedConstructor generateTypedConstructor()

The "typed constructor" has the same signature as the set(...) method, namely what corresponds correctly to the content model (notwithstanding null-checks and array length.)

generateSetMethod

protected GeneratedMethod generateSetMethod()

ATTENTION the set method serves as a prototype and the sequence of its parameters is copied to several other methods (for structured contents, defined by DTD.CP). FIXME not yet correctly handled for mixed contents !?!?

generateUntypedConstructor

protected GeneratedConstructor generateUntypedConstructor()

The "untyped constructor" requires a tdom object and is NORMALLY NOT visible to/callable by the programmer.

addVisitContentStatement

public void addVisitContentStatement(String fieldName,
 String singularName,
 int modifier)

generateParseMethod

protected GeneratedMethod generateParseMethod()

generateEncodeMethod

protected GeneratedMethod generateEncodeMethod()

generateDecodeMethod

protected GeneratedMethod generateDecodeMethod()

addDecodeArgument

public void addDecodeArgument(Format decodeArgument)

generateDecodeStatement

public void generateDecodeStatement()

addChild

public void addChild(ContainerTemplate child)

internalSetDirectors

protected ContentParserGenerator.Rule internalSetDirectors(ContentParserGenerator.Rule rule)

setDirectors

protected abstract void setDirectors(ContentParserGenerator.Rule rule)

useSemiparser

void useSemiparser()

Overrides:

useSemiparser in class NodeTemplate