org.dmd.templates.server.generated.dmw

Class SectionDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.DSDefinitionDMW

org.dmd.dms.DSDefinition

org.dmd.templates.server.generated.dmw.TdlDefinitionDMW

org.dmd.templates.server.extended.TdlDefinition

org.dmd.templates.server.generated.dmw.ContainedElementDMW

org.dmd.templates.server.extended.ContainedElement

org.dmd.templates.server.generated.dmw.SectionDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

Section

public abstract class SectionDMW
extends ContainedElement
implements DmcDefinitionIF, DmcNamedObjectIF

A Section represents part of a textual artifact that you want to format.\n The artifact could be an XHTML document, an XML document, a piece of code, a form\n letter - whatever. The content of a Section may start with another Section or static\n piece of text and, likewise, end with a Section or static piece of text.\n

\n Sections can also contain other (sub) Sections. \n

\n Sections can also have named values that can be inserted into Templates. By specifying\n values, you define a set of values that can be accessed and embedded within the associated\n Template.\n

\n When a Section's format() method is called, it will dump the contents in the following order:\n

\n
• any starts with material
\n
• the formatted contents of the associated Template
\n
• the formatted contents of any contained Sections
\n
• any ends with material
\n

Generated from the dmtdl schema at version unknown

This code was auto-generated by the dmggenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dmg.generators.BaseDMWGenerator.dumpWrapper(BaseDMWGenerator.java:488)

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	SectionDMW()
	SectionDMW(DmcTypeModifierMV mods)
	SectionDMW(SectionDMO obj)
protected	SectionDMW(SectionDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addContains(Contains value) Adds another contains value.
void	addContains(Object value) Adds another contains value.
void	addValue(Object value) Adds another value value.
void	addValue(Value value) Adds another value value.
Section	cloneIt()
boolean	containsContains(Contains value)
void	delContains(Contains value) Deletes a contains value.
void	delContains(Object value) Deletes a contains value.
void	delValue(Object value) Deletes a value value.
void	delValue(Value value) Deletes a value value.
boolean	equals(Object obj) This method should check the type of the obj param and compare the name of this object with the one passed as argument.
ArrayList<Contains>	getContainsCopy()
boolean	getContainsHasValue()
boolean	getContainsIsEmpty()
ContainsIterableDMW	getContainsIterable()
int	getContainsSize()
SectionDMO	getDMO()
Section	getEndsWith()
String	getEndsWithText()
Section	getModificationRecorder()
DefinitionName	getName() The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part.
String	getNameOfModuleWhereThisCameFrom() This method indicates the name of the module from which this definition was loaded.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
Section	getStartsWith()
String	getStartsWithText()
ArrayList<Value>	getValueCopy()
boolean	getValueHasValue()
boolean	getValueIsEmpty()
ValueIterableDMW	getValueIterable()
int	getValueSize()
int	hashCode()
Boolean	isHasTemplate()
Boolean	isUsesTemplate()
void	remContains() Removes the contains attribute value.
void	remEndsWith() Removes the endsWith attribute value.
void	remEndsWithText() Removes the endsWithText attribute value.
void	remHasTemplate() Removes the hasTemplate attribute value.
void	remName() Removes the name attribute value.
void	remStartsWith() Removes the startsWith attribute value.
void	remStartsWithText() Removes the startsWithText attribute value.
void	remUsesTemplate() Removes the usesTemplate attribute value.
void	remValue() Removes the value attribute value.
void	setEndsWith(Object value) Sets the endsWith to the specified value.
void	setEndsWith(Section value) Sets the endsWith to the specified value.
void	setEndsWithText(Object value) Sets endsWithText to the specified value.
void	setEndsWithText(String value) Sets endsWithText to the specified value.
void	setHasTemplate(Boolean value) Sets hasTemplate to the specified value.
void	setHasTemplate(Object value) Sets hasTemplate to the specified value.
void	setName(DefinitionName value) Sets name to the specified value.
void	setName(Object value) Sets name to the specified value.
void	setStartsWith(Object value) Sets the startsWith to the specified value.
void	setStartsWith(Section value) Sets the startsWith to the specified value.
void	setStartsWithText(Object value) Sets startsWithText to the specified value.
void	setStartsWithText(String value) Sets startsWithText to the specified value.
void	setUsesTemplate(Boolean value) Sets usesTemplate to the specified value.
void	setUsesTemplate(Object value) Sets usesTemplate to the specified value.
boolean	valueContains(Value value)

Methods inherited from class org.dmd.templates.server.extended.TdlDefinition

initialize

Methods inherited from class org.dmd.templates.server.generated.dmw.TdlDefinitionDMW

addDescription, addDescription, delDescription, delDescription, descriptionContains, getDefinedInTdlModule, getDescriptionCopy, getDescriptionHasValue, getDescriptionIsEmpty, getDescriptionIterable, getDescriptionSize, getDotName, remDefinedInTdlModule, remDescription, remDotName, setDefinedInTdlModule, setDefinedInTdlModule, setDotName, setDotName

Methods inherited from class org.dmd.dms.DSDefinition

equals, getFullDotName

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW

addComment, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDescription, getDescriptionWithNewlines, getDmoFromModule, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDefinedIn, setDmcObject, setDmoFromModule, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

getDefinedIn, getDotName, toOIF

Constructor Detail

SectionDMW

public SectionDMW()

SectionDMW

public SectionDMW(DmcTypeModifierMV mods)

SectionDMW

public SectionDMW(SectionDMO obj)

SectionDMW

protected SectionDMW(SectionDMO obj,
                     ClassDefinition cd)

Method Detail

getModificationRecorder

public Section getModificationRecorder()

Specified by:

getModificationRecorder in class ContainedElementDMW

cloneIt

public Section cloneIt()

getDMO

public SectionDMO getDMO()

Overrides:

getDMO in class ContainedElementDMW

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class ContainedElementDMW

Returns:

The name of this object from the name attribute.

hashCode

public int hashCode()

Overrides:

hashCode in class ContainedElementDMW

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class ContainedElementDMW

Returns:

The name attribute.

equals

public boolean equals(Object obj)

Description copied from interface: DmcNamedObjectIF

This method should check the type of the obj param and compare the name of this object with the one passed as argument.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class ContainedElementDMW

Parameters:

obj - The comparison object.

Returns:

True if the names match.

getContainsSize

public int getContainsSize()

Returns:

The number of Contains items.

getContainsIsEmpty

public boolean getContainsIsEmpty()

Returns:

true if there are no ContainsDMO items.

getContainsHasValue

public boolean getContainsHasValue()

Returns:

true if there are any ContainsDMO items.

getContainsIterable

public ContainsIterableDMW getContainsIterable()

Returns:

An Iterator of Contains objects.

addContains

public void addContains(Object value)
                 throws DmcValueException

Adds another contains value.

Parameters:

value - A value compatible with Contains

Throws:

DmcValueException - if value is incorrect

addContains

public void addContains(Contains value)

Adds another contains value.

Parameters:

value - A value compatible with Contains

containsContains

public boolean containsContains(Contains value)

Parameters:

value - A value compatible with Contains

Returns:

true if the collection contains the contains value.

getContainsCopy

public ArrayList<Contains> getContainsCopy()

Returns:

A COPY of the collection of Contains objects.

delContains

public void delContains(Object value)
                 throws DmcValueException

Deletes a contains value.

Parameters:

value - The Contains to be deleted from set of attribute values.

Throws:

DmcValueException - if value is incorrect

delContains

public void delContains(Contains value)

Deletes a contains value.

Parameters:

value - The Contains to be deleted from set of attribute values.

remContains

public void remContains()

Removes the contains attribute value.

getEndsWith

public Section getEndsWith()

Returns:

A Section object.

setEndsWith

public void setEndsWith(Section value)

Sets the endsWith to the specified value.

Parameters:

value - A value compatible with SectionREF

setEndsWith

public void setEndsWith(Object value)
                 throws DmcValueException

Sets the endsWith to the specified value.

Parameters:

value - A value compatible with SectionREF

Throws:

DmcValueException - is the value is incorrect

remEndsWith

public void remEndsWith()

Removes the endsWith attribute value.

getEndsWithText

public String getEndsWithText()

setEndsWithText

public void setEndsWithText(Object value)
                     throws DmcValueException

Sets endsWithText to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException

setEndsWithText

public void setEndsWithText(String value)

Sets endsWithText to the specified value.

Parameters:

value - String

remEndsWithText

public void remEndsWithText()

Removes the endsWithText attribute value.

isHasTemplate

public Boolean isHasTemplate()

setHasTemplate

public void setHasTemplate(Object value)
                    throws DmcValueException

Sets hasTemplate to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

DmcValueException

setHasTemplate

public void setHasTemplate(Boolean value)

Sets hasTemplate to the specified value.

Parameters:

value - Boolean

remHasTemplate

public void remHasTemplate()

Removes the hasTemplate attribute value.

getName

public DefinitionName getName()

Description copied from class: DSDefinitionDMW

The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part. A name starts with a letter followed\n by letters and numbers.

Specified by:

getName in interface DmcDefinitionIF

Overrides:

getName in class ContainedElementDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class ContainedElementDMW

Parameters:

value - A value compatible with DmcTypeDefinitionName

Throws:

DmcValueException - if the value is incorrect

setName

public void setName(DefinitionName value)

Sets name to the specified value.

Overrides:

setName in class ContainedElementDMW

Parameters:

value - DefinitionName

remName

public void remName()

Removes the name attribute value.

Overrides:

remName in class ContainedElementDMW

getStartsWith

public Section getStartsWith()

Returns:

A Section object.

setStartsWith

public void setStartsWith(Section value)

Sets the startsWith to the specified value.

Parameters:

value - A value compatible with SectionREF

setStartsWith

public void setStartsWith(Object value)
                   throws DmcValueException

Sets the startsWith to the specified value.

Parameters:

value - A value compatible with SectionREF

Throws:

DmcValueException - is the value is incorrect

remStartsWith

public void remStartsWith()

Removes the startsWith attribute value.

getStartsWithText

public String getStartsWithText()

setStartsWithText

public void setStartsWithText(Object value)
                       throws DmcValueException

Sets startsWithText to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException

setStartsWithText

public void setStartsWithText(String value)

Sets startsWithText to the specified value.

Parameters:

value - String

remStartsWithText

public void remStartsWithText()

Removes the startsWithText attribute value.

isUsesTemplate

public Boolean isUsesTemplate()

setUsesTemplate

public void setUsesTemplate(Object value)
                     throws DmcValueException

Sets usesTemplate to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

DmcValueException

setUsesTemplate

public void setUsesTemplate(Boolean value)

Sets usesTemplate to the specified value.

Parameters:

value - Boolean

remUsesTemplate

public void remUsesTemplate()

Removes the usesTemplate attribute value.

getValueSize

public int getValueSize()

Returns:

The number of Value items.

getValueIsEmpty

public boolean getValueIsEmpty()

Returns:

true if there are no ValueDMO items.

getValueHasValue

public boolean getValueHasValue()

Returns:

true if there are any ValueDMO items.

getValueIterable

public ValueIterableDMW getValueIterable()

Returns:

An Iterator of Value objects.

addValue

public void addValue(Object value)
              throws DmcValueException

Adds another value value.

Parameters:

value - A value compatible with Value

Throws:

DmcValueException - if value is incorrect

addValue

public void addValue(Value value)

Adds another value value.

Parameters:

value - A value compatible with Value

valueContains

public boolean valueContains(Value value)

Parameters:

value - A value compatible with Value

Returns:

true if the collection contains the value value.

getValueCopy

public ArrayList<Value> getValueCopy()

Returns:

A COPY of the collection of Value objects.

delValue

public void delValue(Object value)
              throws DmcValueException

Deletes a value value.

Parameters:

value - The Value to be deleted from set of attribute values.

Throws:

DmcValueException - if value is incorrect

delValue

public void delValue(Value value)

Deletes a value value.

Parameters:

value - The Value to be deleted from set of attribute values.

remValue

public void remValue()

Removes the value attribute value.

getNameOfModuleWhereThisCameFrom

public String getNameOfModuleWhereThisCameFrom()

This method indicates the name of the module from which this definition was loaded.

Overrides:

getNameOfModuleWhereThisCameFrom in class DSDefinition