org.dmd.dmu.shared.types

Class DmcTypePathAndKey

java.lang.Object

org.dmd.dmc.DmcAttribute<PathAndKey>

org.dmd.dmu.shared.types.DmcTypePathAndKey

All Implemented Interfaces:

Serializable, Cloneable, Comparable<String>

Direct Known Subclasses:

DmcTypePathAndKeyMV, DmcTypePathAndKeySET, DmcTypePathAndKeySV

public abstract class DmcTypePathAndKey
extends DmcAttribute<PathAndKey>
implements Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dmd.dmc.DmcAttribute

attrInfo, ID

Constructor Summary

Constructors

Constructor and Description
DmcTypePathAndKey()
DmcTypePathAndKey(DmcAttributeInfo ai)

Method Summary

Modifier and Type	Method and Description
PathAndKey	cloneValue(PathAndKey original) This method must be overridden to clone whatever value is stored in this attribute.
PathAndKey	deserializeValue(DmcInputStreamIF dis) This method must be overridden to read a single value from the input stream.
void	serializeValue(DmcOutputStreamIF dos, PathAndKey value) This method must be overridden to serialize the specified value to the output stream.
PathAndKey	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.DmcAttribute

add, addModsMV, addModsSV, cloneIt, compareTo, contains, containsKey, del, deserializeIt, formatValue, formatValueAsCompactJSON, formatValueAsJSON, 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

DmcTypePathAndKey

public DmcTypePathAndKey()

DmcTypePathAndKey

public DmcTypePathAndKey(DmcAttributeInfo ai)

Method Detail

typeCheck

public PathAndKey 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<PathAndKey>

Parameters:

value - the value to be checked

Returns:

a value holder

Throws:

DmcValueException - if the value is incorrect

cloneValue

public PathAndKey cloneValue(PathAndKey original)

Description copied from class: DmcAttribute

This method must be overridden to clone whatever value is stored in this attribute. The concept of clone constructors was considered, but this doesn't work for enumerated values.

Specified by:

cloneValue in class DmcAttribute<PathAndKey>

Parameters:

original - the original value

Returns:

A clone of the value.

serializeValue

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

Description copied from class: DmcAttribute

This method must be overridden to serialize the specified value to the output stream.

Specified by:

serializeValue in class DmcAttribute<PathAndKey>

Parameters:

dos - The output stream.

value - The value to be serialized.

Throws:

Exception - if problems occur

deserializeValue

public PathAndKey deserializeValue(DmcInputStreamIF dis)
                            throws Exception

Description copied from class: DmcAttribute

This method must be overridden to read a single value from the input stream.

Specified by:

deserializeValue in class DmcAttribute<PathAndKey>

Parameters:

dis - the input stream.

Returns:

A value read from the input stream.

Throws:

Exception - if problems occur