org.dmd.templates.server.generated.dmw

Class TdlDefinitionDMW

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

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

TdlDefinition

public abstract class TdlDefinitionDMW
extends DSDefinition
implements DmcDefinitionIF, DmcNamedObjectIF

The TdlDefinition provides a common base for all dark-matter\n Template Definition Language (TDL) definitions.

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
protected	TdlDefinitionDMW()
protected	TdlDefinitionDMW(TdlDefinitionDMO 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.
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.
TdlModule	getDefinedInTdlModule()
ArrayList<String>	getDescriptionCopy()
boolean	getDescriptionHasValue()
boolean	getDescriptionIsEmpty()
StringIterableDMW	getDescriptionIterable()
int	getDescriptionSize()
TdlDefinitionDMO	getDMO()
DotName	getDotName() The dotName attribute is used to store dot separated names.
abstract TdlDefinition	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.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
int	hashCode()
void	remDefinedInTdlModule() Removes the definedInTdlModule attribute value.
void	remDescription() Removes the description attribute value.
void	remDotName() Removes the dotName attribute value.
void	remName() Removes the name attribute value.
void	setDefinedInTdlModule(Object value) Sets the definedInTdlModule to the specified value.
void	setDefinedInTdlModule(TdlModule value) Sets the definedInTdlModule to the specified value.
void	setDotName(DotName value) Sets dotName to the specified value.
void	setDotName(Object value) Sets dotName 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.dms.DSDefinition

equals, getFullDotName, getNameOfModuleWhereThisCameFrom

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

Constructor Detail

TdlDefinitionDMW

protected TdlDefinitionDMW()

TdlDefinitionDMW

protected TdlDefinitionDMW(TdlDefinitionDMO obj,
                           ClassDefinition cd)

Method Detail

getModificationRecorder

public abstract TdlDefinition getModificationRecorder()

getDMO

public TdlDefinitionDMO getDMO()

Overrides:

getDMO in class DSDefinitionDMW

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class DSDefinitionDMW

Returns:

The name of this object from the name attribute.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class DSDefinitionDMW

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 DmwWrapper

Parameters:

obj - The comparison object.

Returns:

True if the names match.

getDefinedInTdlModule

public TdlModule getDefinedInTdlModule()

Returns:

A TdlModule object.

setDefinedInTdlModule

public void setDefinedInTdlModule(TdlModule value)

Sets the definedInTdlModule to the specified value.

Parameters:

value - A value compatible with TdlModuleREF

setDefinedInTdlModule

public void setDefinedInTdlModule(Object value)
                           throws DmcValueException

Sets the definedInTdlModule to the specified value.

Parameters:

value - A value compatible with TdlModuleREF

Throws:

DmcValueException - is the value is incorrect

remDefinedInTdlModule

public void remDefinedInTdlModule()

Removes the definedInTdlModule attribute value.

getDescriptionSize

public int getDescriptionSize()

Overrides:

getDescriptionSize in class DSDefinitionDMW

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.

Overrides:

addDescription in class DSDefinitionDMW

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.

getDotName

public DotName getDotName()

Description copied from class: DSDefinitionDMW

The dotName attribute is used to store dot separated names.

Specified by:

getDotName in interface DmcDefinitionIF

Overrides:

getDotName in class DSDefinitionDMW

Returns:

the DotName

setDotName

public void setDotName(Object value)
                throws DmcValueException

Sets dotName to the specified value.

Overrides:

setDotName in class DSDefinitionDMW

Parameters:

value - A value compatible with DmcTypeDotName

Throws:

DmcValueException - if the value is incorrect

setDotName

public void setDotName(DotName value)

Sets dotName to the specified value.

Parameters:

value - DotName

remDotName

public void remDotName()

Removes the dotName 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 DSDefinitionDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class DSDefinitionDMW

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.

Parameters:

value - DefinitionName

remName

public void remName()

Removes the name attribute value.