org.dmd.dms.generated.dmw

Class AttributeDefinitionDMW

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

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

AttributeDefinition

public class AttributeDefinitionDMW
extends DmsDefinition
implements DmcDefinitionIF

This class is used to define attributes to be used\n as part of a class definition.

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

Method Summary

Modifier and Type	Method and Description
void	addDescription(Object value) Adds another description value.
String	getAbbrev() This attribute stores an abbreviated form of the name of an attribute or class.
DataTypeEnum	getDataType() This attribute indicates the persistence characteristics of an attribute or\n class of object.
Iterator<String>	getDescription() The description attribute is used to provide descriptive\n documentation for schema related definitions.
int	getDescriptionSize()
Iterator<String>	getDescriptionWithNewlines()
Boolean	getDesignatedFilterAttribute() The designatedFilterAttribute flag is used to identify the attribute\n designated as the standard wrapper for filters of a particular type.
Boolean	getDesignatedNameAttribute() The designatedNameAttribute flag is used to identify the attribute\n designated as the standard wrapper for names of a particular type.
Integer	getDmdID() The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.
AttributeDefinitionDMO	getDMO()
String	getGenericArgs() This attribute indicates the generic arguments to be supplied in the\n use of a class in an autogenerated Iterable.
String	getGenericArgsImport() Indicates the import required to support a genericArgs specification i.e.
Integer	getIndexSize() The indexSize is used in conjunction with the MULTI valueType to\n indicate that the attribute may have the specified number of values and is integer indexed.\n Indexed attributes may be thought of as having a predetermined number of slots into which\n values may be stored.
Boolean	getInternalUse() Indicates if an attribute is used and set within the Dark Matter Data\n code generation mechanisms.
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	getNullReturnValue() This attribute is used in TypeDefinitions to indicate the value that should be returned when\n an attribute of the specified type doesn't exist in the object.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
String	getObsoleteVersion() This indicates the version at which something became obsolete.\n Generally speaking you shouldn't ever delete definitions for products that have\n been released to the field, this may break backwards compatibility.
Boolean	getPreserveNewlines() Indicates that newline characters should be preserved when an\n attribute is parsed by the DmcUncheckedOIFParser.
Boolean	getSecure() This attribute indicates whether or not the attribute should\n be encrypted before being transported over the wire or stored in a file or\n repository
TypeDefinition	getType() Indicates the type of an attribute.
ValueTypeEnum	getValueType() This attribute indicates the cardinality and storage mechanism for an\n attribute.
Boolean	getWeakReference() A flag to indicate that a reference attribute is weak i.e.
void	setAbbrev(Object value) Sets abbrev to the specified value.
void	setDataType(Object value) Sets dataType to the specified value.
void	setDesignatedFilterAttribute(Object value) Sets designatedFilterAttribute to the specified value.
void	setDesignatedNameAttribute(Object value) Sets designatedNameAttribute to the specified value.
void	setDmcObject(DmcObject obj) Sets the core object.
void	setDmdID(Object value) Sets dmdID to the specified value.
void	setGenericArgs(Object value) Sets genericArgs to the specified value.
void	setGenericArgsImport(Object value) Sets genericArgsImport to the specified value.
void	setIndexSize(Object value) Sets indexSize to the specified value.
void	setInternalUse(Object value) Sets internalUse to the specified value.
void	setName(Object value) Sets name to the specified value.
void	setNullReturnValue(Object value) Sets nullReturnValue to the specified value.
void	setObsoleteVersion(Object value) Sets obsoleteVersion to the specified value.
void	setPreserveNewlines(Object value) Sets preserveNewlines to the specified value.
void	setSecure(Object value) Sets secure to the specified value.
void	setType(TypeDefinition value) Sets type to the specified value.
void	setValueType(Object value) Sets valueType to the specified value.
void	setWeakReference(Object value) Sets weakReference 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

AttributeDefinitionDMW

protected AttributeDefinitionDMW()

AttributeDefinitionDMW

protected AttributeDefinitionDMW(DmcObject obj)

AttributeDefinitionDMW

protected AttributeDefinitionDMW(DmcObject obj,
                                 ClassDefinition cd)

AttributeDefinitionDMW

protected AttributeDefinitionDMW(ClassDefinition cd)

AttributeDefinitionDMW

protected AttributeDefinitionDMW(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 AttributeDefinitionDMO 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

getType

public TypeDefinition getType()

Indicates the type of an attribute. The value is the name of any\n previously defined TypeDefinition, ClassDefinition, EnumDefinition or ComplexTypeDefinition.

Returns:

the TypeDefinition

setType

public void setType(TypeDefinition value)
             throws DmcValueException

Sets type to the specified value.

Parameters:

value - A value compatible with TypeDefinition

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.

getValueType

public ValueTypeEnum getValueType()

This attribute indicates the cardinality and storage mechanism for an\n attribute.

Returns:

the ValueTypeEnum

setValueType

public void setValueType(Object value)
                  throws DmcValueException

Sets valueType to the specified value.

Parameters:

value - A value compatible with DmcTypeValueTypeEnumSV

Throws:

DmcValueException - if the value is incorrect

getNullReturnValue

public String getNullReturnValue()

This attribute is used in TypeDefinitions to indicate the value that should be returned when\n an attribute of the specified type doesn't exist in the object. For example, Boolean values are defined\n to return false when they aren't actually set on an object. This just gives a convenient mechanism to\n provide a default value for non-existent attribute values.

Returns:

the String

setNullReturnValue

public void setNullReturnValue(Object value)
                        throws DmcValueException

Sets nullReturnValue to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getAbbrev

public String getAbbrev()

This attribute stores an abbreviated form of the name of an attribute or class. This\n concept is borrowed from directory technology where shortened name forms are often\n used as part of distinguished names (DNs).

Returns:

the String

setAbbrev

public void setAbbrev(Object value)
               throws DmcValueException

Sets abbrev to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getObsoleteVersion

public String getObsoleteVersion()

This indicates the version at which something became obsolete.\n Generally speaking you shouldn't ever delete definitions for products that have\n been released to the field, this may break backwards compatibility. Instead, you\n should mark them as obsolete.

Returns:

the String

setObsoleteVersion

public void setObsoleteVersion(Object value)
                        throws DmcValueException

Sets obsoleteVersion to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getSecure

public Boolean getSecure()

This attribute indicates whether or not the attribute should\n be encrypted before being transported over the wire or stored in a file or\n repository

Returns:

the Boolean

setSecure

public void setSecure(Object value)
               throws DmcValueException

Sets secure to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getDataType

public DataTypeEnum getDataType()

This attribute indicates the persistence characteristics of an attribute or\n class of object. How this information is used is application dependent.

Returns:

the DataTypeEnum

setDataType

public void setDataType(Object value)
                 throws DmcValueException

Sets dataType to the specified value.

Parameters:

value - A value compatible with DmcTypeDataTypeEnumSV

Throws:

DmcValueException - if the value is incorrect

getDmdID

public Integer getDmdID()

The dmdID attribute is used to store a unique Dark Matter Definition ID for attributes.\n This is used as part of the serialization mechanisms built into Dark Matter Objects.

Returns:

the Integer

setDmdID

public void setDmdID(Object value)
              throws DmcValueException

Sets dmdID to the specified value.

Parameters:

value - A value compatible with DmcTypeIntegerSV

Throws:

DmcValueException - if the value is incorrect

getGenericArgs

public String getGenericArgs()

This attribute indicates the generic arguments to be supplied in the\n use of a class in an autogenerated Iterable.

Returns:

the String

setGenericArgs

public void setGenericArgs(Object value)
                    throws DmcValueException

Sets genericArgs to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getGenericArgsImport

public String getGenericArgsImport()

Indicates the import required to support a genericArgs specification i.e. if you're\n not specifying something like , an additional import may be required.

Returns:

the String

setGenericArgsImport

public void setGenericArgsImport(Object value)
                          throws DmcValueException

Sets genericArgsImport to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if the value is incorrect

getDesignatedNameAttribute

public Boolean getDesignatedNameAttribute()

The designatedNameAttribute flag is used to identify the attribute\n designated as the standard wrapper for names of a particular type. One, and only one,\n attribute definition can be the designatedNameAttribute for a TypeDefinition that has\n isNameType true.

Returns:

the Boolean

setDesignatedNameAttribute

public void setDesignatedNameAttribute(Object value)
                                throws DmcValueException

Sets designatedNameAttribute to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getDesignatedFilterAttribute

public Boolean getDesignatedFilterAttribute()

The designatedFilterAttribute flag is used to identify the attribute\n designated as the standard wrapper for filters of a particular type. \n One, and only one, attribute definition can be the designatedFilterAttribute for a \n TypeDefinition that is identified as isFilterType.

Returns:

the Boolean

setDesignatedFilterAttribute

public void setDesignatedFilterAttribute(Object value)
                                  throws DmcValueException

Sets designatedFilterAttribute to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getInternalUse

public Boolean getInternalUse()

Indicates if an attribute is used and set within the Dark Matter Data\n code generation mechanisms. In the documentation generation code, attributes marked as\n internalUse WILL NOT be displayed unless you set the -internalUse flag is indicated.

Returns:

the Boolean

setInternalUse

public void setInternalUse(Object value)
                    throws DmcValueException

Sets internalUse to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getIndexSize

public Integer getIndexSize()

The indexSize is used in conjunction with the MULTI valueType to\n indicate that the attribute may have the specified number of values and is integer indexed.\n Indexed attributes may be thought of as having a predetermined number of slots into which\n values may be stored. When indexed, an attribute has values added to it using the setMVnth()\n interface, not the usual add() interface. If you attempt to use add() with an indexed attribute,\n an exception will be thrown.

Returns:

the Integer

setIndexSize

public void setIndexSize(Object value)
                  throws DmcValueException

Sets indexSize to the specified value.

Parameters:

value - A value compatible with DmcTypeIntegerSV

Throws:

DmcValueException - if the value is incorrect

getPreserveNewlines

public Boolean getPreserveNewlines()

Indicates that newline characters should be preserved when an\n attribute is parsed by the DmcUncheckedOIFParser. This is useful for certain attributes\n when newlines are required to properly format the contents of the attribute at\n a later time. For example, the description attribute is later dumped as part of \n HTML documentation and, if the newlines are stripped, it won't be properly formatted.

Returns:

the Boolean

setPreserveNewlines

public void setPreserveNewlines(Object value)
                         throws DmcValueException

Sets preserveNewlines to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

getWeakReference

public Boolean getWeakReference()

A flag to indicate that a reference attribute is weak i.e. \n if the object can't be resolved, no exception is thrown.

Returns:

the Boolean

setWeakReference

public void setWeakReference(Object value)
                      throws DmcValueException

Sets weakReference to the specified value.

Parameters:

value - A value compatible with DmcTypeBooleanSV

Throws:

DmcValueException - if the value is incorrect

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.