org.dmd.templates.shared.generated.types

Class DmcTypeTemplateREFMAP

java.lang.Object

org.dmd.dmc.DmcAttribute<HELPER>

org.dmd.dmc.types.DmcTypeNamedObjectREF<TemplateREF,DefinitionName>

org.dmd.templates.shared.generated.types.DmcTypeTemplateREF

org.dmd.templates.shared.generated.types.DmcTypeTemplateREFMAP

All Implemented Interfaces:

Serializable, Cloneable, Comparable<String>

Direct Known Subclasses:

TemplateREFMAPAdapter

public class DmcTypeTemplateREFMAP
extends DmcTypeTemplateREF
implements Serializable

The DmcTypeTemplateREFMAP provides storage for a map of TemplateREF

This code was auto-generated and shouldn't be altered manually! Generated from: org.dmd.dms.util.GenUtility.dumpMAPType(GenUtility.java:3044) Called from: org.dmd.dms.util.DmoTypeFormatter.dumpNamedREF(DmoTypeFormatter.java:544)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<DefinitionName,TemplateREF>	value

Fields inherited from class org.dmd.dmc.DmcAttribute

attrInfo, ID

Constructor Summary

Constructors

Constructor and Description
DmcTypeTemplateREFMAP()
DmcTypeTemplateREFMAP(DmcAttributeInfo ai)

Method Summary

Modifier and Type	Method and Description
TemplateREF	add(Object v) Adds the specified value to a multi-valued attribute.
DmcAttribute<TemplateREF>	cloneIt() This method is overridden in the auto-generated classes to create a deep clone of the attribute.
boolean	contains(Object v) If we have a multi-valued attribute, we checked to see it it contains the specified value.
boolean	containsKey(Object key) If we have a mapped attribute, we checked to see it it contains the specified key.
TemplateREF	del(Object key) Removes a value from a multi-valued attribute.
DefinitionName	firstKey()
TemplateREF	getByKey(Object key) This method is overloaded in DmcHashedAttribute - it returns null at this level.
Iterator<TemplateREF>	getMV() Returns an Iterator over a multi-valued attribute's values.
Map<DefinitionName,TemplateREF>	getMVCopy()
int	getMVSize() For a multi-valued attribute, this returns the number of values in the attribute.
DmcTypeTemplateREFMAP	getNew() Derived classes must return a new, empty version of themselves.

Methods inherited from class org.dmd.templates.shared.generated.types.DmcTypeTemplateREF

cloneValue, deserializeValue, getDMOClassName, getNewHelper, getNewName, isDMO, serializeValue, typeCheck

Methods inherited from class org.dmd.dmc.types.DmcTypeNamedObjectREF

doLazyResolution, removeBackReferences, resolveReferences, weAreResolved

Methods inherited from class org.dmd.dmc.DmcAttribute

addModsMV, addModsSV, compareTo, deserializeIt, formatValue, formatValueAsCompactJSON, formatValueAsJSON, getAttributeInfo, getID, getMVnth, getName, getSV, hasValue, modifierFormat, serializeIt, set, setAttributeInfo, setMVnth, toOIF, toOIF, valueChangedMV, valueChangedSV

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

protected Map<DefinitionName,TemplateREF> value

Constructor Detail

DmcTypeTemplateREFMAP

public DmcTypeTemplateREFMAP()

DmcTypeTemplateREFMAP

public DmcTypeTemplateREFMAP(DmcAttributeInfo ai)

Method Detail

firstKey

public DefinitionName firstKey()

getNew

public DmcTypeTemplateREFMAP getNew()

Description copied from class: DmcAttribute

Derived classes must return a new, empty version of themselves. This is required in order to be GWT compatible since the Class.newInstance() method IS NOT SUPPORTED.

Specified by:

getNew in class DmcAttribute<TemplateREF>

Returns:

An instance of the appropriate DmcAttribute derivative. This mechanism is required to support the DmcTypeModifier concepts that allow you to record the changes made on an object and transmit them in modification events.

cloneIt

public DmcAttribute<TemplateREF> cloneIt()

Description copied from class: DmcAttribute

This method is overridden in the auto-generated classes to create a deep clone of the attribute.

Specified by:

cloneIt in class DmcAttribute<TemplateREF>

Returns:

a clone of the attribute

add

public TemplateREF add(Object v)
                throws DmcValueException

Description copied from class: DmcAttribute

Adds the specified value to a multi-valued attribute. NOTE: multi-valued attributes DON'T allow duplicate values.

Overrides:

add in class DmcAttribute<TemplateREF>

Parameters:

v - The value to be added

Returns:

the attribute value

Throws:

DmcValueException - if the value is not compatible with the underlying type.

del

public TemplateREF del(Object key)

Description copied from class: DmcAttribute

Removes a value from a multi-valued attribute.

Overrides:

del in class DmcAttribute<TemplateREF>

Parameters:

key - The value to be removed.

Returns:

the attribute value

getMV

public Iterator<TemplateREF> getMV()

Description copied from class: DmcAttribute

Returns an Iterator over a multi-valued attribute's values.

Overrides:

getMV in class DmcAttribute<TemplateREF>

Returns:

Iterator<VALUE>

getMVCopy

public Map<DefinitionName,TemplateREF> getMVCopy()

getMVSize

public int getMVSize()

Description copied from class: DmcAttribute

For a multi-valued attribute, this returns the number of values in the attribute. If the attribute is single-valued, 0 is returned.

Overrides:

getMVSize in class DmcAttribute<TemplateREF>

Returns:

the number of values.

getByKey

public TemplateREF getByKey(Object key)

Description copied from class: DmcAttribute

This method is overloaded in DmcHashedAttribute - it returns null at this level.

Overrides:

getByKey in class DmcAttribute<TemplateREF>

Parameters:

key - the key value

Returns:

the value associated with the specified key for HASHMAPPED or TREEMAPPED attributes.

contains

public boolean contains(Object v)

Description copied from class: DmcAttribute

If we have a multi-valued attribute, we checked to see it it contains the specified value.

Overrides:

contains in class DmcAttribute<TemplateREF>

Parameters:

v - The object we're looking for.

Returns:

true if the object is contained by the attribute.

containsKey

public boolean containsKey(Object key)

Description copied from class: DmcAttribute

If we have a mapped attribute, we checked to see it it contains the specified key.

Overrides:

containsKey in class DmcAttribute<TemplateREF>

Parameters:

key - The key we're looking for.

Returns:

true if the object is contained by the attribute.