com.softwareag.mdm.base.text
Class NomenclatureItem

java.lang.Object
  com.softwareag.mdm.base.text.NomenclatureItem

Direct Known Subclasses:

NomenclatureItemSeparator, NomenclatureItemTitle, NomenclatureItemValue

public abstract class NomenclatureItem

extends Object

A NomenclatureItem asociates a value with one or more labels.

See Also:

Nomenclature

Field Summary

static Step	_defaultLabel
static Step	_value

Method Summary

boolean	equals(Object x)
String	getDefaultLabel() Returns first label.
String	getLabel(int index) Returns the label at the specified position (from 0 to the number of labels - 1).
Object	getValue() Returns the value of this item.
boolean	isDefaultItem() Returns true if this item has the role of being selected as a default option when associated instance is undefined.
boolean	isSeparatorItem() Deprecated. This notion of separator implies some problems regarding XML Schema concept of enumeration. Returns true if this item has the role of separator for displaying items.
boolean	isTitleItem() Deprecated. The notion of title implies some problems regarding XML Schema concept of enumeration. Returns true if this item has the role of 'title' for displaying items.
boolean	isValueItem() Returns true if this item has the role of holding an actual value.
void	setDefaultItem(boolean isDefaultItem) If the argument sspecified is true, then this item has the role of being selected as a default option when associated instance is undefined.
void	setDefaultLabel(String aString) Sets first label.
void	setLabel(int index, String aString) Replaces the label at the specified position in all labels with the specified string.
void	setValue(Object aValue) Replaces the value with the specified object.
String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_value

public static final Step _value

_defaultLabel

public static final Step _defaultLabel

Method Detail

equals

public boolean equals(Object x)

getDefaultLabel

public String getDefaultLabel()

Returns first label.

getLabel

public String getLabel(int index)

Returns the label at the specified position (from 0 to the number of labels - 1).

getValue

public Object getValue()

Returns the value of this item.

isDefaultItem

public boolean isDefaultItem()

Returns true if this item has the role of being selected as a default option when associated instance is undefined.

isSeparatorItem

public boolean isSeparatorItem()

Deprecated. This notion of separator implies some problems regarding XML Schema concept of enumeration. Returns true if this item has the role of separator for displaying items.

See Also:

NomenclatureItemSeparator

isTitleItem

public boolean isTitleItem()

Deprecated. The notion of title implies some problems regarding XML Schema concept of enumeration. Returns true if this item has the role of 'title' for displaying items.

See Also:

NomenclatureItemTitle

isValueItem

public boolean isValueItem()

Returns true if this item has the role of holding an actual value.

See Also:

NomenclatureItemValue

setDefaultItem

public void setDefaultItem(boolean isDefaultItem)

If the argument sspecified is true, then this item has the role of being selected as a default option when associated instance is undefined.

setDefaultLabel

public void setDefaultLabel(String aString)

Sets first label.

setLabel

public void setLabel(int index,
                     String aString)

Replaces the label at the specified position in all labels with the specified string.

setValue

public void setValue(Object aValue)

Replaces the value with the specified object.

toString

public String toString()