org.dmd.templates.server.generated.dmw

Class TemplateDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.templates.server.generated.dmw.TemplateDMW

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

Template

public class TemplateDMW
extends DmwNamedObjectWrapper
implements DmcNamedObjectIF

The Template object provides a mechanism to define an arbitrary set of\n text that allows for the insertion of the named values defined as part of the associated\n Section definition.\n

\n By convention, the Template associated with a Section has the same name as the Section. For example:\n

\n Section\n name Header\n 

\n would have a template as follows:\n

\n Template\n name Header\n 

\n Templates are kept separate from the Section definitions so that their content can be\n changed without regenerating code. Templates are loaded using the generated TemplateParser\n for a given TdlModule.

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
	TemplateDMW()
	TemplateDMW(DmcTypeModifierMV mods)
	TemplateDMW(TemplateDMO obj)
protected	TemplateDMW(TemplateDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addDescription(Object value) Adds another description value.
void	addDescription(String value) Adds another description value.
Template	cloneIt()
void	delDescription(Object value) Deletes a description value.
void	delDescription(String value) Deletes a description value.
boolean	descriptionContains(String 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<String>	getDescriptionCopy()
boolean	getDescriptionHasValue()
boolean	getDescriptionIsEmpty()
StringIterableDMW	getDescriptionIterable()
int	getDescriptionSize()
TemplateDMO	getDMO()
String	getFile()
String	getFormat()
Integer	getLineNumber()
Template	getModificationRecorder()
DefinitionName	getName()
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
int	hashCode()
Boolean	isDebugOn()
void	remDebugOn() Removes the debugOn attribute value.
void	remDescription() Removes the description attribute value.
void	remFile() Removes the file attribute value.
void	remFormat() Removes the format attribute value.
void	remLineNumber() Removes the lineNumber attribute value.
void	remName() Removes the name attribute value.
void	setDebugOn(Boolean value) Sets debugOn to the specified value.
void	setDebugOn(Object value) Sets debugOn to the specified value.
void	setFile(Object value) Sets file to the specified value.
void	setFile(String value) Sets file to the specified value.
void	setFormat(Object value) Sets format to the specified value.
void	setFormat(String value) Sets format to the specified value.
void	setLineNumber(Integer value) Sets lineNumber to the specified value.
void	setLineNumber(Object value) Sets lineNumber to the specified value.
void	setName(DefinitionName value) Sets name to the specified value.
void	setName(Object value) Sets name to the specified value.

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

Constructor Detail

TemplateDMW

public TemplateDMW()

TemplateDMW

public TemplateDMW(DmcTypeModifierMV mods)

TemplateDMW

public TemplateDMW(TemplateDMO obj)

TemplateDMW

protected TemplateDMW(TemplateDMO obj,
                      ClassDefinition cd)

Method Detail

getModificationRecorder

public Template getModificationRecorder()

cloneIt

public Template cloneIt()

getDMO

public TemplateDMO getDMO()

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Returns:

The name of the object.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Returns:

The naming attribute of the object.

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 DmwWrapper

Parameters:

obj - The comparison object.

Returns:

True if the names match.

isDebugOn

public Boolean isDebugOn()

setDebugOn

public void setDebugOn(Object value)
                throws DmcValueException

Sets debugOn to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

DmcValueException

setDebugOn

public void setDebugOn(Boolean value)

Sets debugOn to the specified value.

Parameters:

value - Boolean

remDebugOn

public void remDebugOn()

Removes the debugOn attribute value.

getDescriptionSize

public int getDescriptionSize()

Returns:

The number of String items.

getDescriptionIsEmpty

public boolean getDescriptionIsEmpty()

Returns:

true if there are no StringDMO items.

getDescriptionHasValue

public boolean getDescriptionHasValue()

Returns:

true if there are any StringDMO items.

getDescriptionIterable

public StringIterableDMW getDescriptionIterable()

Returns:

An Iterator of String objects.

addDescription

public void addDescription(Object value)
                    throws DmcValueException

Adds another description value.

Parameters:

value - A value compatible with String

Throws:

DmcValueException - if value is incorrect

addDescription

public void addDescription(String value)

Adds another description value.

Parameters:

value - A value compatible with String

descriptionContains

public boolean descriptionContains(String value)

Parameters:

value - A value compatible with String

Returns:

true if the collection contains the description value.

getDescriptionCopy

public ArrayList<String> getDescriptionCopy()

Returns:

A COPY of the collection of String objects.

delDescription

public void delDescription(Object value)
                    throws DmcValueException

Deletes a description value.

Parameters:

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

Throws:

DmcValueException - if value is incorrect

delDescription

public void delDescription(String value)

Deletes a description value.

Parameters:

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

remDescription

public void remDescription()

Removes the description attribute value.

getFile

public String getFile()

setFile

public void setFile(Object value)
             throws DmcValueException

Sets file to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException

setFile

public void setFile(String value)

Sets file to the specified value.

Parameters:

value - String

remFile

public void remFile()

Removes the file attribute value.

getFormat

public String getFormat()

setFormat

public void setFormat(Object value)
               throws DmcValueException

Sets format to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException

setFormat

public void setFormat(String value)

Sets format to the specified value.

Parameters:

value - String

remFormat

public void remFormat()

Removes the format attribute value.

getLineNumber

public Integer getLineNumber()

setLineNumber

public void setLineNumber(Object value)
                   throws DmcValueException

Sets lineNumber to the specified value.

Parameters:

value - A value compatible with DmcTypeInteger

Throws:

DmcValueException

setLineNumber

public void setLineNumber(Integer value)

Sets lineNumber to the specified value.

Parameters:

value - Integer

remLineNumber

public void remLineNumber()

Removes the lineNumber attribute value.

getName

public DefinitionName getName()

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Parameters:

value - A value compatible with DmcTypeDefinitionName

Throws:

DmcValueException

setName

public void setName(DefinitionName value)

Sets name to the specified value.

Parameters:

value - DefinitionName

remName

public void remName()

Removes the name attribute value.