org.dmd.dms.generated.dmw

Class ComplexTypeDefinitionDMW

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

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

ComplexTypeDefinition

public class ComplexTypeDefinitionDMW
extends DmsDefinition
implements DmcDefinitionIF

The ComplexTypeDefinition provides a mechanism for defining the structure of\n a complex type composed of other types. From this definition, a new DmcType is generated that\n has all of the required methods automatically defined.\n

\n An example definition is the RuleParam:\n

\n
 ComplexTypeDefinition\n name                   RuleParam\n fieldSeparator :\n field String
 importStatement The import for the type of parameter\n field String
 genericArgs     The generic arguments associated with this parameter\n
 field String name            The name of the parameter\n field String
 description     A description of the parameter\n description The RuleParam
 type is used to succintly describe a parameter\n  to be supplied to a rule
 when it is executed.\n 

\n In this case, the type has four fields, all of String type. An example of the String\n format of the field might be:

 org.dmc.DmcObject::obj:The object to be validated

In this\n case, the generic args field isn't available and will be the empty string. When a field\n seperator is specified, all fields are, more or less optional, but the underlying type\n must be able to handle the empty string as a valid value. This wouldn't work with Integer.\n

\n If no field separator is specified, the separator is assumed to be whitespace and additional\n whitespace is consumed during the parsing.

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	ComplexTypeDefinitionDMW()
protected	ComplexTypeDefinitionDMW(ClassDefinition cd)
protected	ComplexTypeDefinitionDMW(DmcObject obj)
protected	ComplexTypeDefinitionDMW(DmcObject obj, ClassDefinition cd)
protected	ComplexTypeDefinitionDMW(String mn)

Method Summary

Modifier and Type	Method and Description
void	addDescription(Object value) Adds another description value.
void	addField(Object value) Adds another field value.
void	addOptionalPart(Object value) Adds another optionalPart value.
void	addRequiredPart(Object value) Adds another requiredPart value.
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
Iterator<String>	getDescriptionWithNewlines()
ComplexTypeDefinitionDMO	getDMO()
String	getExtendedClass() The extendedClass indicates the fully qualified name of the class\n that is derived from the generated ComplexType to provide additional behaviour.
Iterator<Field>	getField() The field indicates a type and name for a field in a ComplexType.
String	getFieldSeparator() The fieldSeparator is used to indicate the separation character used\n when a ComplexType is represented as a String.
int	getFieldSize()
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()
Iterator<Part>	getOptionalPart() Indicates an optional part of a complex type definition.
int	getOptionalPartSize()
Iterator<Part>	getRequiredPart() Indicates a required part of a complex type definition.
int	getRequiredPartSize()
void	setDmcObject(DmcObject obj) Sets the core object.
void	setExtendedClass(Object value) Sets extendedClass to the specified value.
void	setFieldSeparator(Object value) Sets fieldSeparator to the specified value.
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, equals, 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

ComplexTypeDefinitionDMW

protected ComplexTypeDefinitionDMW()

ComplexTypeDefinitionDMW

protected ComplexTypeDefinitionDMW(DmcObject obj)

ComplexTypeDefinitionDMW

protected ComplexTypeDefinitionDMW(DmcObject obj,
                                   ClassDefinition cd)

ComplexTypeDefinitionDMW

protected ComplexTypeDefinitionDMW(ClassDefinition cd)

ComplexTypeDefinitionDMW

protected ComplexTypeDefinitionDMW(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 ComplexTypeDefinitionDMO 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

getField

public Iterator<Field> getField()

The field indicates a type and name for a field in a ComplexType.

Returns:

the Field

addField

public void addField(Object value)
              throws DmcValueException

Adds another field value.

Parameters:

value - A value compatible with DmcTypeFieldMV

Throws:

DmcValueException - if the value is incorrect

getFieldSize

public int getFieldSize()

Returns:

the number of field values.

getRequiredPart

public Iterator<Part> getRequiredPart()

Indicates a required part of a complex type definition.

Returns:

the Part

addRequiredPart

public void addRequiredPart(Object value)
                     throws DmcValueException

Adds another requiredPart value.

Parameters:

value - A value compatible with DmcTypePartMV

Throws:

DmcValueException - if the value is incorrect

getRequiredPartSize

public int getRequiredPartSize()

Returns:

the number of requiredPart values.

getOptionalPart

public Iterator<Part> getOptionalPart()

Indicates an optional part of a complex type definition.

Returns:

the Part

addOptionalPart

public void addOptionalPart(Object value)
                     throws DmcValueException

Adds another optionalPart value.

Parameters:

value - A value compatible with DmcTypePartMV

Throws:

DmcValueException - if the value is incorrect

getOptionalPartSize

public int getOptionalPartSize()

Returns:

the number of optionalPart values.

getFieldSeparator

public String getFieldSeparator()

The fieldSeparator is used to indicate the separation character used\n when a ComplexType is represented as a String. If a fieldSeparator isn't specified, it is\n assumed to be a space.

Returns:

the String

setFieldSeparator

public void setFieldSeparator(Object value)
                       throws DmcValueException

Sets fieldSeparator to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getExtendedClass

public String getExtendedClass()

The extendedClass indicates the fully qualified name of the class\n that is derived from the generated ComplexType to provide additional behaviour.

Returns:

the String

setExtendedClass

public void setExtendedClass(Object value)
                      throws DmcValueException

Sets extendedClass to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

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.