org.dmd.templates.shared.generated.dmo

Class TdlDefinitionDMO

java.lang.Object

org.dmd.dmc.DmcObject

org.dmd.dms.generated.dmo.DSDefinitionDMO

org.dmd.templates.shared.generated.dmo.TdlDefinitionDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

Direct Known Subclasses:

ContainedElementDMO, TdlModuleDMO, TextualArtifactDMO

public abstract class TdlDefinitionDMO
extends DSDefinitionDMO
implements DmcNamedObjectIF, Serializable

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 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
	TdlDefinitionDMO()
protected	TdlDefinitionDMO(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.
TdlModuleREF	getDefinedInTdlModule()
TdlModuleREF	getDefinedInTdlModuleREF()
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
DotName	getDotName() The dotName attribute is used to store dot separated names.
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	getNthDescription(int i)
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 definedInTdlModule to the specified value.
void	setDefinedInTdlModule(TdlModuleDMO value) Sets 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.generated.dmo.DSDefinitionDMO

addComment, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getDefinedIn, getDescriptionWithNewlines, getDmoFromModule, getExample, getFile, getHint, getIdToAttrInfo, getLineNumber, getNew, getNvp, getObsolete, getOptimize, getQuestion, getRelationship, getSearchable, getSkip, getSlice, getSortName, getStringToAttrInfo, getTags, getVersion, getWhy, setDefinedIn, setDmoFromModule, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

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

TdlDefinitionDMO

public TdlDefinitionDMO()

TdlDefinitionDMO

protected TdlDefinitionDMO(String oc)

Method Detail

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class DSDefinitionDMO

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class DSDefinitionDMO

Returns:

The name attribute.

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

getDescription

public Iterator<String> getDescription()

Description copied from class: DSDefinitionDMO

The description attribute is used to provide descriptive\n documentation for schema related definitions. The text provided should conform\n to XHTML concepts since it will be dumped in the context of the generated HTML\n documentation.

Overrides:

getDescription in class DSDefinitionDMO

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.

Overrides:

addDescription in class DSDefinitionDMO

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()

Description copied from class: DSDefinitionDMO

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.

Overrides:

getName in class DSDefinitionDMO

Returns:

the DefinitionName

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.

Overrides:

setName in class DSDefinitionDMO

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if value is not correct

remName

public void remName()

Removes the name attribute value.

getDotName

public DotName getDotName()

Description copied from class: DSDefinitionDMO

The dotName attribute is used to store dot separated names.

Overrides:

getDotName in class DSDefinitionDMO

Returns:

the DotName

setDotName

public void setDotName(DotName value)

Sets dotName to the specified value.

Parameters:

value - DotName

setDotName

public void setDotName(Object value)
                throws DmcValueException

Sets dotName to the specified value.

Overrides:

setDotName in class DSDefinitionDMO

Parameters:

value - A value compatible with DmcTypeDotNameSV

Throws:

DmcValueException - if value is not correct

remDotName

public void remDotName()

Removes the dotName attribute value.

getDefinedInTdlModule

public TdlModuleREF getDefinedInTdlModule()

Returns:

the TdlModuleREF

getDefinedInTdlModuleREF

public TdlModuleREF getDefinedInTdlModuleREF()

Returns:

the reference to TdlModule without attempting lazy resolution (if turned on).

setDefinedInTdlModule

public void setDefinedInTdlModule(TdlModuleDMO value)

Sets definedInTdlModule to the specified value.

Parameters:

value - TdlModuleDMO

setDefinedInTdlModule

public void setDefinedInTdlModule(Object value)
                           throws DmcValueException

Sets definedInTdlModule to the specified value.

Parameters:

value - A value compatible with DmcTypeTdlModuleREFSV

Throws:

DmcValueException - if value is not correct

remDefinedInTdlModule

public void remDefinedInTdlModule()

Removes the definedInTdlModule attribute value.