org.dmd.dms.generated.types

Class DmcTypeFieldMV

java.lang.Object

org.dmd.dmc.DmcAttribute<VALUE>

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

org.dmd.dms.generated.types.DmcTypeField

org.dmd.dms.generated.types.DmcTypeFieldMV

All Implemented Interfaces:

Serializable, Cloneable, Comparable<String>

Direct Known Subclasses:

FieldMVAdapter

public class DmcTypeFieldMV
extends DmcTypeField
implements Serializable

The DmcTypeFieldMV provides storage for a multi-valued Field

This code was auto-generated and shouldn't be altered manually! Generated from: org.dmd.dms.util.GenUtility.dumpMVType(GenUtility.java:2515) Called from: org.dmd.dms.meta.MetaGenerator.dumpDerivedTypes(MetaGenerator.java:669)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<Field>	value

Fields inherited from class org.dmd.dmc.DmcAttribute

attrInfo, ID

Constructor Summary

Constructors

Constructor and Description
DmcTypeFieldMV()
DmcTypeFieldMV(DmcAttributeInfo ai)

Method Summary

Modifier and Type	Method and Description
Field	add(Object v) Adds the specified value to a multi-valued attribute.
DmcAttribute<Field>	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.
Field	del(Object v) Removes a value from a multi-valued attribute.
Iterator<Field>	getMV() Returns an Iterator over a multi-valued attribute's values.
ArrayList<Field>	getMVCopy()
Field	getMVnth(int index) A convenience function to return the nth value from a multi-valued attribute.
int	getMVSize() For a multi-valued attribute, this returns the number of values in the attribute.
DmcTypeFieldMV	getNew() Derived classes must return a new, empty version of themselves.
boolean	hasValue() If we have an indexed, multi-valued attribute, this method will traverse all of the slots to determine if we still have any non-null values.
Field	setMVnth(int index, Object v) For indexed, multi-valued attributes, we set the nth value as specified.

Methods inherited from class org.dmd.dms.generated.types.DmcTypeField

cloneValue, deserializeValue, formatValueAsJSON, removeBackRefsFromValue, resolveValue, resolveValue, serializeValue, typeCheck

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

removeBackReferences, resolve, resolve

Methods inherited from class org.dmd.dmc.DmcAttribute

addModsMV, addModsSV, compareTo, containsKey, deserializeIt, formatValue, formatValueAsCompactJSON, getAttributeInfo, getByKey, getID, getName, getSV, modifierFormat, serializeIt, set, setAttributeInfo, 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 ArrayList<Field> value

Constructor Detail

DmcTypeFieldMV

public DmcTypeFieldMV()

DmcTypeFieldMV

public DmcTypeFieldMV(DmcAttributeInfo ai)

Method Detail

getNew

public DmcTypeFieldMV 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<Field>

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<Field> 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<Field>

Returns:

a clone of the attribute

add

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

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 Field del(Object v)

Description copied from class: DmcAttribute

Removes a value from a multi-valued attribute.

Overrides:

del in class DmcAttribute<Field>

Parameters:

v - The value to be removed.

Returns:

the attribute value

getMV

public Iterator<Field> getMV()

Description copied from class: DmcAttribute

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

Overrides:

getMV in class DmcAttribute<Field>

Returns:

Iterator<VALUE>

getMVCopy

public ArrayList<Field> 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<Field>

Returns:

the number of values.

getMVnth

public Field getMVnth(int index)

Description copied from class: DmcAttribute

A convenience function to return the nth value from a multi-valued attribute.

Overrides:

getMVnth in class DmcAttribute<Field>

Parameters:

index - The value index.

Returns:

the value

setMVnth

public Field setMVnth(int index,
                      Object v)
               throws DmcValueException

Description copied from class: DmcAttribute

For indexed, multi-valued attributes, we set the nth value as specified. If the value at the index is to be removed, set the value to null.

Overrides:

setMVnth in class DmcAttribute<Field>

Parameters:

index - The value index.

v - The value to be set. if the value is null, that index location is nulled.

Returns:

the value

Throws:

DmcValueException

hasValue

public boolean hasValue()

Description copied from class: DmcAttribute

If we have an indexed, multi-valued attribute, this method will traverse all of the slots to determine if we still have any non-null values.

Overrides:

hasValue in class DmcAttribute<Field>

Returns:

true if there are any values an false otherwise.

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<Field>

Parameters:

v - The object we're looking for.

Returns:

true if the object is contained by the attribute.