com.infoengine.object
Class IeDefinitionDescriptor

java.lang.Object
  com.infoengine.object.IeDefinitionDescriptor

All Implemented Interfaces:

DefinitionDescriptor, LocalizableMetadata, Serializable

public class IeDefinitionDescriptor

extends Object

implements LocalizableMetadata, DefinitionDescriptor, Serializable

This class holds definition descriptors for a particular definition identifier. Typically, it's used to hold descriptors for an attribute type identifier.

See Also:

Serialized Form

Field Summary

private String	abbreviatedDisplay
private static String	CLASSNAME
private String	display
private String	fullDisplay
private DefinitionIdentifier	identifier
private LocalizedValues	localizedValues
private String	longDescription
private String	shortDescription

Fields inherited from interface com.ptc.core.meta.descriptor.common.DefinitionDescriptor

IDENTIFIER

Constructor Summary

IeDefinitionDescriptor()

IeDefinitionDescriptor(IeDefinitionDescriptor descriptor)

IeDefinitionDescriptor(LocalizedValues localized_values, DefinitionIdentifier identifier)
Initializes the definition descriptor with a set of localized values and an identifier.

Method Summary

void	addProperty(String key, String value) Adds an arbitrary property to the set of definition descriptors.
String	getAbbreviatedDisplay() Gets the value of the attribute abbreviatedDisplay, if it's set in this definition descriptor.
String	getDisplay() Gets the value of the attribute display, if it's set in this definition descriptor.
String	getFullDisplay() Gets the value of the attribute fullDisplay, if it's set in this definition descriptor.
DefinitionIdentifier	getIdentifier() Gets the object for the association that plays role: identifier.
protected LocalizedValues	getLocalizedValues() Returns the set of localized values for the definition descriptor.
String	getLongDescription() Gets the value of the attribute longDescription, if it's set in this definition descriptor.
String	getProperty(String key) Gets a property by name.
String	getProperty(String key, String default_value) Gets a property.
String	getShortDescription() Gets the value of the attribute shortDescription, if it's set in this definition descriptor.
void	setAbbreviatedDisplay(String a_AbbreviatedDisplay) Sets the value of the attribute: abbreviatedDisplay.
void	setDisplay(String a_Display) Sets the value of the attribute: abbreviatedDisplay.
void	setFullDisplay(String a_FullDisplay) Sets the value of the attribute: display.
void	setIdentifier(DefinitionIdentifier identifier) Sets the identifier described by this definition
protected void	setLocalizedValues(LocalizedValues a_LocalizedValues) Sets the localized values for the definition descriptor.
void	setLongDescription(String a_LongDescription) Sets the value of the attribute: longDescription
void	setShortDescription(String a_ShortDescription) Sets the value of the attribute: shortDescription
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

private static final String CLASSNAME

localizedValues

private LocalizedValues localizedValues

identifier

private DefinitionIdentifier identifier

abbreviatedDisplay

private String abbreviatedDisplay

display

private String display

fullDisplay

private String fullDisplay

shortDescription

private String shortDescription

longDescription

private String longDescription

Constructor Detail

IeDefinitionDescriptor

public IeDefinitionDescriptor()

IeDefinitionDescriptor

public IeDefinitionDescriptor(LocalizedValues localized_values,
                              DefinitionIdentifier identifier)

Initializes the definition descriptor with a set of localized values and an identifier.

Parameters:

localized_values -

identifier -

IeDefinitionDescriptor

public IeDefinitionDescriptor(IeDefinitionDescriptor descriptor)

Parameters:

descriptor -

Method Detail

getLocalizedValues

protected LocalizedValues getLocalizedValues()

Returns the set of localized values for the definition descriptor.

Returns:

LocalizedValues

setLocalizedValues

protected void setLocalizedValues(LocalizedValues a_LocalizedValues)

Sets the localized values for the definition descriptor.

Parameters:

a_LocalizedValues -

Throws:

WTPropertyVetoException

getProperty

public String getProperty(String key)

Gets a property by name.

Specified by:

getProperty in interface DefinitionDescriptor

Parameters:

key -

Returns:

String

addProperty

public void addProperty(String key,
                        String value)

Adds an arbitrary property to the set of definition descriptors.

Parameters:

key -

value -

getProperty

public String getProperty(String key,
                          String default_value)

Gets a property.

Specified by:

getProperty in interface DefinitionDescriptor

Parameters:

key -

default_value -

Returns:

String

getIdentifier

public DefinitionIdentifier getIdentifier()

Gets the object for the association that plays role: identifier.

Specified by:

getIdentifier in interface DefinitionDescriptor

Returns:

DefinitionIdentifier

setIdentifier

public void setIdentifier(DefinitionIdentifier identifier)

Sets the identifier described by this definition

Parameters:

identifier - the identifier

getAbbreviatedDisplay

public String getAbbreviatedDisplay()

Gets the value of the attribute abbreviatedDisplay, if it's set in this definition descriptor. If it's not, then the value of abbreviatedDisplay is retrieved from the set of localized values.

Specified by:

getAbbreviatedDisplay in interface LocalizableMetadata

Returns:

String

setAbbreviatedDisplay

public void setAbbreviatedDisplay(String a_AbbreviatedDisplay)

Sets the value of the attribute: abbreviatedDisplay.

Supported API: false

Parameters:

a_AbbreviatedDisplay -

setDisplay

public void setDisplay(String a_Display)

Sets the value of the attribute: abbreviatedDisplay.

getDisplay

public String getDisplay()

Gets the value of the attribute display, if it's set in this definition descriptor. If it's not, then the value of display is retrieved from the set of localized values.

Specified by:

getDisplay in interface LocalizableMetadata

Returns:

String

setFullDisplay

public void setFullDisplay(String a_FullDisplay)

Sets the value of the attribute: display.

Parameters:

a_FullDisplay -

getFullDisplay

public String getFullDisplay()

Gets the value of the attribute fullDisplay, if it's set in this definition descriptor. If it's not, then the value of fullDisplay is retrieved from the set of localized values.

Specified by:

getFullDisplay in interface LocalizableMetadata

Returns:

String

setShortDescription

public void setShortDescription(String a_ShortDescription)

Sets the value of the attribute: shortDescription

Parameters:

a_ShortDescription -

getShortDescription

public String getShortDescription()

Gets the value of the attribute shortDescription, if it's set in this definition descriptor. If it's not, then the value of shortDescription is retrieved from the set of localized values.

Specified by:

getShortDescription in interface LocalizableMetadata

Returns:

String

setLongDescription

public void setLongDescription(String a_LongDescription)

Sets the value of the attribute: longDescription

Parameters:

a_LongDescription -

getLongDescription

public String getLongDescription()

Gets the value of the attribute longDescription, if it's set in this definition descriptor. If it's not, then the value of longDescription is retrieved from the set of localized values.

Specified by:

getLongDescription in interface LocalizableMetadata

Returns:

String

toString

public String toString()