org.dmd.templates.shared.generated.dmo

Class TemplateDMO

java.lang.Object

org.dmd.dmc.DmcObject

org.dmd.templates.shared.generated.dmo.TemplateDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

public class TemplateDMO
extends DmcObject
implements DmcNamedObjectIF, Serializable

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 dmogenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dms.util.DmoFormatter.dumpDMO(DmoFormatter.java:134)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	constructionClassName

Fields inherited from class org.dmd.dmc.DmcObject

__objectClass, attributes

Constructor Summary

Constructors

Modifier	Constructor and Description
	TemplateDMO()
	TemplateDMO(DmcTypeModifierMV mods)
protected	TemplateDMO(String oc)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addDescription(Object value) Adds another description value.
DmcAttribute<?>	addDescription(String value) Adds another description to the specified value.
DmcAttribute<?>	delDescription(Object value) Deletes a description value.
DmcAttribute<?>	delDescription(String value) Deletes a description from the specified value.
boolean	descriptionContains(String value)
boolean	equals(Object obj) This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.
Iterator<String>	getDescription()
int	getDescriptionSize()
String	getFile()
String	getFormat()
Integer	getLineNumber()
TemplateDMO	getModificationRecorder()
DefinitionName	getName()
TemplateDMO	getNew() Auto-generated derived classes override this to return an empty instance of themselves.
String	getNthDescription(int i)
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
TemplateDMO	getSlice(DmcSliceInfo info) Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
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.dmc.DmcObject

add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, get, get, get, getAdditionalAttributes, getAttributeInfo, getAttributeInfo, getAttributeIterator, getAttributeNames, getAttributes, getAttributeValidators, getBackref, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getContainer, getDataType, getFullClassName, getLastValue, getModifier, getObjectClass, getObjectValidators, getReferringObjects, getReferringObjectsViaAttribute, getStagingObject, hasAux, hasValue, isModrec, isReferenced, isStaging, modrec, nth, nthNullFromEmptyAttribute, numberOfAttributes, populateSlice, referenceCount, rem, rem, removeAux, removeBackref, resolveReferences, resolveReferences, resolveReferences, resolveReferencesExceptClass, resolveReferencesExceptClass, serializeIt, set, set, setContainer, setLastValue, setModifier, shallowCopy, staging, supportsBackrefTracking, toCompactJSON, toCompactJSON, toJSON, toJSON, toJSON, toOIF, toOIF, toOIFNoPadding, toPersistentOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class java.lang.Object

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

Field Detail

constructionClassName

public static final String constructionClassName

See Also:

Constant Field Values

Constructor Detail

TemplateDMO

public TemplateDMO()

TemplateDMO

protected TemplateDMO(String oc)

TemplateDMO

public TemplateDMO(DmcTypeModifierMV mods)

Method Detail

getNew

public TemplateDMO getNew()

Description copied from class: DmcObject

Auto-generated derived classes override this to return an empty instance of themselves. This supports cloning.

Specified by:

getNew in class DmcObject

Returns:

An instance of the derived class.

getSlice

public TemplateDMO getSlice(DmcSliceInfo info)

Description copied from class: DmcObject

Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes. In the case of named objects, the object name is always part of the slice.

Specified by:

getSlice in class DmcObject

Parameters:

info - the slice info

Returns:

An instance of the derived class with the specified slice of attributes.

getModificationRecorder

public TemplateDMO getModificationRecorder()

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Returns:

The name of the 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 class: DmcObject

This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class DmcObject

Parameters:

obj - The comparison object.

Returns:

true if we equal the specified object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFile

public String getFile()

setFile

public void setFile(String value)

Sets file to the specified value.

Parameters:

value - String

setFile

public void setFile(Object value)
             throws DmcValueException

Sets file to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if value is not correct

remFile

public void remFile()

Removes the file attribute value.

getLineNumber

public Integer getLineNumber()

setLineNumber

public void setLineNumber(Integer value)

Sets lineNumber to the specified value.

Parameters:

value - Integer

setLineNumber

public void setLineNumber(Object value)
                   throws DmcValueException

Sets lineNumber to the specified value.

Parameters:

value - A value compatible with DmcTypeIntegerSV

Throws:

DmcValueException - if value is not correct

remLineNumber

public void remLineNumber()

Removes the lineNumber attribute value.

isDebugOn

public Boolean isDebugOn()

setDebugOn

public void setDebugOn(Boolean value)

Sets debugOn to the specified value.

Parameters:

value - Boolean

setDebugOn

public void setDebugOn(Object value)
                throws DmcValueException

Sets debugOn to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if value is not correct

remDebugOn

public void remDebugOn()

Removes the debugOn attribute value.

getDescription

public Iterator<String> getDescription()

Returns:

An Iterator of String objects.

getNthDescription

public String getNthDescription(int i)

Parameters:

i - the index

Returns:

The nth String value.

addDescription

public DmcAttribute<?> addDescription(String value)

Adds another description to the specified value.

Parameters:

value - String

Returns:

the attribute instance

descriptionContains

public boolean descriptionContains(String value)

Parameters:

value - String

Returns:

true if we contain a valued keyed by the specified String.

addDescription

public DmcAttribute<?> addDescription(Object value)
                               throws DmcValueException

Adds another description value.

Parameters:

value - A value compatible with String

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getDescriptionSize

public int getDescriptionSize()

Returns:

the number of values in description

delDescription

public DmcAttribute<?> delDescription(Object value)
                               throws DmcValueException

Deletes a description value.

Parameters:

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

Returns:

the deleted attribute instance

Throws:

DmcValueException - if the value is incorrect

delDescription

public DmcAttribute<?> delDescription(String value)

Deletes a description from the specified value.

Parameters:

value - String

Returns:

the deleted attribute instance

remDescription

public void remDescription()

Removes the description attribute value.

getName

public DefinitionName getName()

setName

public void setName(DefinitionName value)

Sets name to the specified value.

Parameters:

value - DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if value is not correct

remName

public void remName()

Removes the name attribute value.

getFormat

public String getFormat()

setFormat

public void setFormat(String value)

Sets format to the specified value.

Parameters:

value - String

setFormat

public void setFormat(Object value)
               throws DmcValueException

Sets format to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if value is not correct

remFormat

public void remFormat()

Removes the format attribute value.