org.dmd.templates.shared.generated.dmo

Class TextualArtifactDMO

java.lang.Object

org.dmd.dmc.DmcObject

org.dmd.dms.generated.dmo.DSDefinitionDMO

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

org.dmd.templates.shared.generated.dmo.TextualArtifactDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

public class TextualArtifactDMO
extends TdlDefinitionDMO
implements DmcNamedObjectIF, Serializable

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 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
	TextualArtifactDMO()
	TextualArtifactDMO(DmcTypeModifierMV mods)
protected	TextualArtifactDMO(String oc)

Method Summary

Modifier and Type	Method and Description
DmcAttribute<?>	addContains(Contains value) Adds another contains to the specified value.
DmcAttribute<?>	addContains(Object value) Adds another contains value.
boolean	containsContains(Contains value)
DmcAttribute<?>	delContains(Contains value) Deletes a contains from the specified value.
DmcAttribute<?>	delContains(Object value) Deletes a contains 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<Contains>	getContains()
int	getContainsSize()
TextualArtifactDMO	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.
TextualArtifactDMO	getNew() Auto-generated derived classes override this to return an empty instance of themselves.
Contains	getNthContains(int i)
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
TextualArtifactDMO	getSlice(DmcSliceInfo info) Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
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.shared.generated.dmo.TdlDefinitionDMO

addDescription, addDescription, delDescription, delDescription, descriptionContains, getDefinedInTdlModule, getDefinedInTdlModuleREF, getDescription, getDescriptionSize, getDotName, getNthDescription, remDefinedInTdlModule, remDescription, remDotName, setDefinedInTdlModule, setDefinedInTdlModule, setDotName, setDotName

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, getNvp, getObsolete, getOptimize, getQuestion, getRelationship, getSearchable, getSkip, 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

TextualArtifactDMO

public TextualArtifactDMO()

TextualArtifactDMO

protected TextualArtifactDMO(String oc)

TextualArtifactDMO

public TextualArtifactDMO(DmcTypeModifierMV mods)

Method Detail

getNew

public TextualArtifactDMO getNew()

Description copied from class: DmcObject

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

Overrides:

getNew in class DSDefinitionDMO

Returns:

An instance of the derived class.

getSlice

public TextualArtifactDMO 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.

Overrides:

getSlice in class DSDefinitionDMO

Parameters:

info - the slice info

Returns:

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

getModificationRecorder

public TextualArtifactDMO getModificationRecorder()

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class TdlDefinitionDMO

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class TdlDefinitionDMO

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 TdlDefinitionDMO

Parameters:

obj - The comparison object.

Returns:

true if we equal the specified object

hashCode

public int hashCode()

Overrides:

hashCode in class TdlDefinitionDMO

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 TdlDefinitionDMO

Returns:

the DefinitionName

setName

public void setName(DefinitionName value)

Sets name to the specified value.

Overrides:

setName in class TdlDefinitionDMO

Parameters:

value - DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class TdlDefinitionDMO

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if value is not correct

remName

public void remName()

Removes the name attribute value.

Overrides:

remName in class TdlDefinitionDMO

getContains

public Iterator<Contains> getContains()

Returns:

An Iterator of Contains objects.

getNthContains

public Contains getNthContains(int i)

Parameters:

i - the index

Returns:

The nth Contains value.

addContains

public DmcAttribute<?> addContains(Contains value)

Adds another contains to the specified value.

Parameters:

value - Contains

Returns:

the attribute instance

containsContains

public boolean containsContains(Contains value)

Parameters:

value - Contains

Returns:

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

addContains

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

Adds another contains value.

Parameters:

value - A value compatible with Contains

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getContainsSize

public int getContainsSize()

Returns:

the number of values in contains

delContains

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

Deletes a contains value.

Parameters:

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

Returns:

the deleted attribute instance

Throws:

DmcValueException - if the value is incorrect

delContains

public DmcAttribute<?> delContains(Contains value)

Deletes a contains from the specified value.

Parameters:

value - Contains

Returns:

the deleted attribute instance

remContains

public void remContains()

Removes the contains attribute value.