org.dmd.dms.generated.dmw

Class SliceDefinitionDMW

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.dms.generated.dmw.DmsDefinitionDMW

org.dmd.dms.DmsDefinition

org.dmd.dms.generated.dmw.SliceDefinitionDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

SliceDefinition

public class SliceDefinitionDMW
extends DmsDefinition
implements DmcDefinitionIF

The SliceDefinition class is used to define a named set of attributes\n that are used to retrieve a slice of an object i.e. an abbreviated set of\n values. These are used in the generation of static, named DmcSliceInfo instances.

Author:

Auto Generated Generated from: org.dmd.dms.meta.MetaGenerator.dumpDMWClasses(MetaGenerator.java:1649)

Field Summary

Fields inherited from class org.dmd.dms.DmsDefinition

metaname

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SliceDefinitionDMW()
protected	SliceDefinitionDMW(ClassDefinition cd)
protected	SliceDefinitionDMW(DmcObject obj)
protected	SliceDefinitionDMW(DmcObject obj, ClassDefinition cd)
protected	SliceDefinitionDMW(String mn)

Method Summary

Modifier and Type	Method and Description
void	addDescription(Object value) Adds another description value.
DmcAttribute<?>	addSelectAttribute(AttributeDefinition value) Adds another selectAttribute value.
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
Iterator<String>	getDescriptionWithNewlines()
SliceDefinitionDMO	getDMO()
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()
AttributeDefinitionIterableDMW	getSelectAttribute() The selectAttribute indicates an attribute to be used in the definition\n of a Slice.
int	getSelectAttributeSize()
void	setDmcObject(DmcObject obj) Sets the core object.
void	setName(Object value) Sets name to the specified value.

Methods inherited from class org.dmd.dms.DmsDefinition

getDmcObject

Methods inherited from class org.dmd.dms.generated.dmw.DmsDefinitionDMW

addRelatedToConcept, getRelatedToConcept, getRelatedToConceptSize

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, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDefinedIn, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, 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, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

getDefinedIn, getDotName, toOIF

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

equals

Constructor Detail

SliceDefinitionDMW

protected SliceDefinitionDMW()

SliceDefinitionDMW

protected SliceDefinitionDMW(DmcObject obj)

SliceDefinitionDMW

protected SliceDefinitionDMW(DmcObject obj,
                             ClassDefinition cd)

SliceDefinitionDMW

protected SliceDefinitionDMW(ClassDefinition cd)

SliceDefinitionDMW

protected SliceDefinitionDMW(String mn)
                      throws DmcValueException

Throws:

DmcValueException

Method Detail

setDmcObject

public void setDmcObject(DmcObject obj)

Description copied from class: DmcContainer

Sets the core object.

Specified by:

setDmcObject in interface DmcContainerIF

Overrides:

setDmcObject in class DmsDefinition

Parameters:

obj - The core object.

getDMO

public SliceDefinitionDMO getDMO()

Overrides:

getDMO in class DmsDefinitionDMW

getName

public 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. A name starts with a letter followed\n by letters and numbers.

Specified by:

getName in interface DmcDefinitionIF

Overrides:

getName in class DmsDefinitionDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class DmsDefinitionDMW

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if the value is incorrect

getSelectAttribute

public AttributeDefinitionIterableDMW getSelectAttribute()

The selectAttribute indicates an attribute to be used in the definition\n of a Slice.

Returns:

the AttributeDefinition

addSelectAttribute

public DmcAttribute<?> addSelectAttribute(AttributeDefinition value)
                                   throws DmcValueException

Adds another selectAttribute value.

Parameters:

value - A value compatible with AttributeDefinition

Returns:

the attribute instance

Throws:

DmcValueException - if the value is incorrect

getSelectAttributeSize

public int getSelectAttributeSize()

Returns:

the number of selectAttribute values.

getDescription

public Iterator<String> getDescription()

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 DSDefinitionDMW

Returns:

the String

getDescriptionWithNewlines

public Iterator<String> getDescriptionWithNewlines()

Overrides:

getDescriptionWithNewlines in class DSDefinitionDMW

addDescription

public void addDescription(Object value)
                    throws DmcValueException

Adds another description value.

Overrides:

addDescription in class DSDefinitionDMW

Parameters:

value - A value compatible with DmcTypeStringMV

Throws:

DmcValueException - if the value is incorrect

getDescriptionSize

public int getDescriptionSize()

Overrides:

getDescriptionSize in class DSDefinitionDMW

Returns:

the number of description values.

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class DmsDefinition

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class DmsDefinitionDMW

Returns:

The name attribute.