org.dmd.templates.server.generated.dmw

Class TextualArtifactDMW

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.TextualArtifactDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

TextualArtifact

public abstract class TextualArtifactDMW
extends TdlDefinition
implements DmcDefinitionIF, DmcNamedObjectIF

A TextualArtifact is the top level entity that is comprised of Sections\n and formatted via Templates.

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
	TextualArtifactDMW()
	TextualArtifactDMW(DmcTypeModifierMV mods)
	TextualArtifactDMW(TextualArtifactDMO obj)
protected	TextualArtifactDMW(TextualArtifactDMO 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.
TextualArtifact	cloneIt()
boolean	containsContains(Contains value)
void	delContains(Contains value) Deletes a contains value.
void	delContains(Object value) Deletes a contains 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()
TextualArtifactDMO	getDMO()
TextualArtifact	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()
int	hashCode()
void	remContains() Removes the contains attribute value.
void	remName() Removes the name attribute 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.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

TextualArtifactDMW

public TextualArtifactDMW()

TextualArtifactDMW

public TextualArtifactDMW(DmcTypeModifierMV mods)

TextualArtifactDMW

public TextualArtifactDMW(TextualArtifactDMO obj)

TextualArtifactDMW

protected TextualArtifactDMW(TextualArtifactDMO obj,
                             ClassDefinition cd)

Method Detail

getModificationRecorder

public TextualArtifact getModificationRecorder()

Specified by:

getModificationRecorder in class TdlDefinitionDMW

cloneIt

public TextualArtifact cloneIt()

getDMO

public TextualArtifactDMO getDMO()

Overrides:

getDMO in class TdlDefinitionDMW

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class TdlDefinitionDMW

Returns:

The name of this object from the name attribute.

hashCode

public int hashCode()

Overrides:

hashCode in class TdlDefinitionDMW

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class TdlDefinitionDMW

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 TdlDefinitionDMW

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.

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 TdlDefinitionDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class TdlDefinitionDMW

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 TdlDefinitionDMW

Parameters:

value - DefinitionName

remName

public void remName()

Removes the name attribute value.

Overrides:

remName in class TdlDefinitionDMW

getNameOfModuleWhereThisCameFrom

public String getNameOfModuleWhereThisCameFrom()

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

Overrides:

getNameOfModuleWhereThisCameFrom in class DSDefinition