org.dmd.dmt.dsd.dsda.shared.generated.types

Class DmcTypeReference

java.lang.Object

org.dmd.dmc.DmcAttribute<VALUE>

org.dmd.dmc.types.DmcTypeComplexTypeWithRefs<Reference>

org.dmd.dmt.dsd.dsda.shared.generated.types.DmcTypeReference

All Implemented Interfaces:

Serializable, Cloneable, Comparable<String>

Direct Known Subclasses:

DmcTypeReferenceMV, DmcTypeReferenceSET, DmcTypeReferenceSV

public abstract class DmcTypeReference
extends DmcTypeComplexTypeWithRefs<Reference>
implements Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dmd.dmc.DmcAttribute

attrInfo, ID

Constructor Summary

Constructors

Constructor and Description
DmcTypeReference() Default constructor.
DmcTypeReference(DmcAttributeInfo ai) Default constructor.

Method Summary

Modifier and Type	Method and Description
Reference	cloneValue(Reference val) Returns a clone of a value associated with this type.
Reference	deserializeValue(DmcInputStreamIF dis) Reads a Reference.
void	formatValueAsJSON(StringBuffer sb, int padding, String indent) This method may be overloaded to properly format attributes that refer directly to DmcObjects or that are object references.
void	removeBackRefsFromValue(Reference value) Removes references to other objects from a Reference.
void	resolveValue(DmcNameResolverIF resolver, Reference value, String attrName) Resolves a Reference.
void	resolveValue(DmcNameResolverWithClashSupportIF resolver, Reference value, DmcObject object, DmcNameClashResolverIF ncr, DmcAttributeInfo ai) Resolves a Reference.
void	serializeValue(DmcOutputStreamIF dos, Reference value) Writes a Reference.
Reference	typeCheck(Object value) Derived classes must overload this method to determine if the value passed in conforms with their type criteria.

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

removeBackReferences, resolve, resolve

Methods inherited from class org.dmd.dmc.DmcAttribute

add, addModsMV, addModsSV, cloneIt, compareTo, contains, containsKey, del, deserializeIt, formatValue, formatValueAsCompactJSON, getAttributeInfo, getByKey, getID, getMV, getMVnth, getMVSize, getName, getNew, 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

Constructor Detail

DmcTypeReference

public DmcTypeReference()

Default constructor.

DmcTypeReference

public DmcTypeReference(DmcAttributeInfo ai)

Default constructor.

Method Detail

formatValueAsJSON

public void formatValueAsJSON(StringBuffer sb,
                              int padding,
                              String indent)

Description copied from class: DmcAttribute

This method may be overloaded to properly format attributes that refer directly to DmcObjects or that are object references.

Overrides:

formatValueAsJSON in class DmcAttribute<Reference>

Parameters:

sb - the string buffer we write to

padding - the padding

indent - the indent

typeCheck

public Reference typeCheck(Object value)
                    throws DmcValueException

Description copied from class: DmcAttribute

Derived classes must overload this method to determine if the value passed in conforms with their type criteria.

Specified by:

typeCheck in class DmcAttribute<Reference>

Parameters:

value - the value to be checked

Returns:

a value holder

Throws:

DmcValueException - if the value is incorrect

cloneValue

public Reference cloneValue(Reference val)

Returns a clone of a value associated with this type. Generated from: org.dmd.dms.util.GenUtility.dumpComplexTypeDmcType(GenUtility.java:3366)

Specified by:

cloneValue in class DmcAttribute<Reference>

Parameters:

val - the original value

Returns:

A clone of the value.

serializeValue

public void serializeValue(DmcOutputStreamIF dos,
                           Reference value)
                    throws Exception

Writes a Reference. Generated from: org.dmd.dms.util.GenUtility.dumpComplexTypeDmcType(GenUtility.java:3374)

Specified by:

serializeValue in class DmcAttribute<Reference>

Parameters:

dos - The output stream.

value - The value to be serialized.

Throws:

Exception - if problems occur

deserializeValue

public Reference deserializeValue(DmcInputStreamIF dis)
                           throws Exception

Reads a Reference. Generated from: org.dmd.dms.util.GenUtility.dumpComplexTypeDmcType(GenUtility.java:3383)

Specified by:

deserializeValue in class DmcAttribute<Reference>

Parameters:

dis - the input stream.

Returns:

A value read from the input stream.

Throws:

Exception - if problems occur

resolveValue

public void resolveValue(DmcNameResolverIF resolver,
                         Reference value,
                         String attrName)
                  throws DmcValueException

Resolves a Reference. Generated from: org.dmd.dms.util.GenUtility.dumpComplexTypeDmcType(GenUtility.java:3395)

Specified by:

resolveValue in class DmcTypeComplexTypeWithRefs<Reference>

Throws:

DmcValueException

resolveValue

public void resolveValue(DmcNameResolverWithClashSupportIF resolver,
                         Reference value,
                         DmcObject object,
                         DmcNameClashResolverIF ncr,
                         DmcAttributeInfo ai)
                  throws DmcValueException,
                         DmcValueExceptionSet

Resolves a Reference. Generated from: org.dmd.dms.util.GenUtility.dumpComplexTypeDmcType(GenUtility.java:3404)

Specified by:

resolveValue in class DmcTypeComplexTypeWithRefs<Reference>

Throws:

DmcValueException

DmcValueExceptionSet

removeBackRefsFromValue

public void removeBackRefsFromValue(Reference value)

Removes references to other objects from a Reference. Generated from: org.dmd.dms.util.GenUtility.dumpComplexTypeDmcType(GenUtility.java:3413)

Specified by:

removeBackRefsFromValue in class DmcTypeComplexTypeWithRefs<Reference>