org.dmd.templates.shared.generated.dmo

Class SectionDMO

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

org.dmd.templates.shared.generated.dmo.SectionDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

public class SectionDMO
extends ContainedElementDMO
implements DmcNamedObjectIF, Serializable

A Section represents part of a textual artifact that you want to format.\n The artifact could be an XHTML document, an XML document, a piece of code, a form\n letter - whatever. The content of a Section may start with another Section or static\n piece of text and, likewise, end with a Section or static piece of text.\n

\n Sections can also contain other (sub) Sections. \n

\n Sections can also have named values that can be inserted into Templates. By specifying\n values, you define a set of values that can be accessed and embedded within the associated\n Template.\n

\n When a Section's format() method is called, it will dump the contents in the following order:\n

\n
• any starts with material
\n
• the formatted contents of the associated Template
\n
• the formatted contents of any contained Sections
\n
• any ends with material
\n

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
	SectionDMO()
	SectionDMO(DmcTypeModifierMV mods)
protected	SectionDMO(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.
DmcAttribute<?>	addValue(Object value) Adds another value value.
DmcAttribute<?>	addValue(Value value) Adds another value to the specified value.
boolean	containsContains(Contains value)
DmcAttribute<?>	delContains(Contains value) Deletes a contains from the specified value.
DmcAttribute<?>	delContains(Object value) Deletes a contains value.
DmcAttribute<?>	delValue(Object value) Deletes a value value.
DmcAttribute<?>	delValue(Value value) Deletes a value from the specified 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()
SectionREF	getEndsWith()
SectionREF	getEndsWithREF()
String	getEndsWithText()
SectionDMO	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.
SectionDMO	getNew() Auto-generated derived classes override this to return an empty instance of themselves.
Contains	getNthContains(int i)
Value	getNthValue(int i)
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
SectionDMO	getSlice(DmcSliceInfo info) Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
SectionREF	getStartsWith()
SectionREF	getStartsWithREF()
String	getStartsWithText()
Iterator<Value>	getValue()
int	getValueSize()
int	hashCode()
Boolean	isHasTemplate()
Boolean	isUsesTemplate()
void	remContains() Removes the contains attribute value.
void	remEndsWith() Removes the endsWith attribute value.
void	remEndsWithText() Removes the endsWithText attribute value.
void	remHasTemplate() Removes the hasTemplate attribute value.
void	remName() Removes the name attribute value.
void	remStartsWith() Removes the startsWith attribute value.
void	remStartsWithText() Removes the startsWithText attribute value.
void	remUsesTemplate() Removes the usesTemplate attribute value.
void	remValue() Removes the value attribute value.
void	setEndsWith(Object value) Sets endsWith to the specified value.
void	setEndsWith(SectionDMO value) Sets endsWith to the specified value.
void	setEndsWithText(Object value) Sets endsWithText to the specified value.
void	setEndsWithText(String value) Sets endsWithText to the specified value.
void	setHasTemplate(Boolean value) Sets hasTemplate to the specified value.
void	setHasTemplate(Object value) Sets hasTemplate to the specified value.
void	setName(DefinitionName value) Sets name to the specified value.
void	setName(Object value) Sets name to the specified value.
void	setStartsWith(Object value) Sets startsWith to the specified value.
void	setStartsWith(SectionDMO value) Sets startsWith to the specified value.
void	setStartsWithText(Object value) Sets startsWithText to the specified value.
void	setStartsWithText(String value) Sets startsWithText to the specified value.
void	setUsesTemplate(Boolean value) Sets usesTemplate to the specified value.
void	setUsesTemplate(Object value) Sets usesTemplate to the specified value.
boolean	valueContains(Value 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

SectionDMO

public SectionDMO()

SectionDMO

protected SectionDMO(String oc)

SectionDMO

public SectionDMO(DmcTypeModifierMV mods)

Method Detail

getNew

public SectionDMO 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 SectionDMO 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 SectionDMO getModificationRecorder()

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class ContainedElementDMO

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class ContainedElementDMO

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 ContainedElementDMO

Parameters:

obj - The comparison object.

Returns:

true if we equal the specified object

hashCode

public int hashCode()

Overrides:

hashCode in class ContainedElementDMO

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.

getStartsWith

public SectionREF getStartsWith()

Returns:

the SectionREF

getStartsWithREF

public SectionREF getStartsWithREF()

Returns:

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

setStartsWith

public void setStartsWith(SectionDMO value)

Sets startsWith to the specified value.

Parameters:

value - SectionDMO

setStartsWith

public void setStartsWith(Object value)
                   throws DmcValueException

Sets startsWith to the specified value.

Parameters:

value - A value compatible with DmcTypeSectionREFSV

Throws:

DmcValueException - if value is not correct

remStartsWith

public void remStartsWith()

Removes the startsWith attribute value.

getEndsWith

public SectionREF getEndsWith()

Returns:

the SectionREF

getEndsWithREF

public SectionREF getEndsWithREF()

Returns:

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

setEndsWith

public void setEndsWith(SectionDMO value)

Sets endsWith to the specified value.

Parameters:

value - SectionDMO

setEndsWith

public void setEndsWith(Object value)
                 throws DmcValueException

Sets endsWith to the specified value.

Parameters:

value - A value compatible with DmcTypeSectionREFSV

Throws:

DmcValueException - if value is not correct

remEndsWith

public void remEndsWith()

Removes the endsWith attribute value.

getStartsWithText

public String getStartsWithText()

setStartsWithText

public void setStartsWithText(String value)

Sets startsWithText to the specified value.

Parameters:

value - String

setStartsWithText

public void setStartsWithText(Object value)
                       throws DmcValueException

Sets startsWithText to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if value is not correct

remStartsWithText

public void remStartsWithText()

Removes the startsWithText attribute value.

getEndsWithText

public String getEndsWithText()

setEndsWithText

public void setEndsWithText(String value)

Sets endsWithText to the specified value.

Parameters:

value - String

setEndsWithText

public void setEndsWithText(Object value)
                     throws DmcValueException

Sets endsWithText to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if value is not correct

remEndsWithText

public void remEndsWithText()

Removes the endsWithText attribute value.

getValue

public Iterator<Value> getValue()

Returns:

An Iterator of Value objects.

getNthValue

public Value getNthValue(int i)

Parameters:

i - the index

Returns:

The nth Value value.

addValue

public DmcAttribute<?> addValue(Value value)

Adds another value to the specified value.

Parameters:

value - Value

Returns:

the attribute instance

valueContains

public boolean valueContains(Value value)

Parameters:

value - Value

Returns:

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

addValue

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

Adds another value value.

Parameters:

value - A value compatible with Value

Returns:

the attribute instance

Throws:

DmcValueException - if value is not correct

getValueSize

public int getValueSize()

Returns:

the number of values in value

delValue

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

Deletes a value value.

Parameters:

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

Returns:

the deleted attribute instance

Throws:

DmcValueException - if the value is incorrect

delValue

public DmcAttribute<?> delValue(Value value)

Deletes a value from the specified value.

Parameters:

value - Value

Returns:

the deleted attribute instance

remValue

public void remValue()

Removes the value attribute value.

isHasTemplate

public Boolean isHasTemplate()

setHasTemplate

public void setHasTemplate(Boolean value)

Sets hasTemplate to the specified value.

Parameters:

value - Boolean

setHasTemplate

public void setHasTemplate(Object value)
                    throws DmcValueException

Sets hasTemplate to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if value is not correct

remHasTemplate

public void remHasTemplate()

Removes the hasTemplate attribute value.

isUsesTemplate

public Boolean isUsesTemplate()

setUsesTemplate

public void setUsesTemplate(Boolean value)

Sets usesTemplate to the specified value.

Parameters:

value - Boolean

setUsesTemplate

public void setUsesTemplate(Object value)
                     throws DmcValueException

Sets usesTemplate to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if value is not correct

remUsesTemplate

public void remUsesTemplate()

Removes the usesTemplate 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 ContainedElementDMO

Returns:

the DefinitionName

setName

public void setName(DefinitionName value)

Sets name to the specified value.

Overrides:

setName in class ContainedElementDMO

Parameters:

value - DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class ContainedElementDMO

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 ContainedElementDMO