com.sas.entities
Class BaseAttributeDescriptor

com.sas.entities.BaseAttributeDescriptor

All Implemented Interfaces:

BaseAttributeDescriptorInterface, com.sas.RemoteObjectInterface, java.io.Serializable, java.rmi.Remote

Direct Known Subclasses:

AttributeDescriptor, AttributeGroup, AttributeType

public class BaseAttributeDescriptor
implements java.io.Serializable, BaseAttributeDescriptorInterface

This class is a base class for AttributeDescriptor, AttributeGroup, and AttributeType. It contains the features that are common to all, thus providing a default implementation.

See Also:

Serialized Form

Constructor Summary

BaseAttributeDescriptor()
Constructs an instance of BaseAttributeDescriptor with no name.

BaseAttributeDescriptor(java.lang.String name)
Constructs an instance of BaseAttributeDescriptor with the given name

Method Summary

java.util.List	getAttributeCustomizerContexts() Returns a list of customizer contexts defined for this object.
java.util.Map	getAttributeCustomizers() Returns a mapping of all of the customizers defined for this object.
java.lang.String	getConfigurationXML() Return the XML which is used to configure or constrain this object.
java.lang.String	getCustomizer(java.lang.String context) Return this object's customizer.
java.lang.String	getDescription(java.util.Locale locale) Return the description of this object; this is the description which the user will see in a UI (User Interface) component.
java.util.Map	getDescriptions() Returns a mapping of all of the descriptions defined for this object.
java.lang.String	getLabel(java.util.Locale locale) Return the label of this object; this is the name which will the user will see in a UI (User Interface) component.
java.util.Map	getLabels() Returns a mapping of all of the labels defined for this object.
java.lang.String	getLargeIconURL(java.util.Locale locale) Return a URL that contains the large icon representing this object.
java.util.Map	getLargeIconURLs() Returns a mapping of all of the large icon URLs defined for this object.
java.lang.String	getName() Return the name of this object.
java.lang.String	getSmallIconURL(java.util.Locale locale) Return a URL that contains the small icon representing this object.
java.util.Map	getSmallIconURLs() Returns a mapping of all of the small icon URLs defined for this object.
void	setConfigurationXML(java.lang.String configurationXML) Assign XML which can be used to configure or constrain this object.
void	setCustomizer(java.lang.String context, java.lang.String customizer) Set the customizer for a specific context.
void	setDescription(java.util.Locale locale, java.lang.String description) Set the description of this object;this is the description which the user will see in a UI (User Interface) component.
void	setLabel(java.util.Locale locale, java.lang.String label) Set the label of this object; this is the name which will the user will see in a UI (User Interface) component.
void	setLargeIconURL(java.util.Locale locale, java.lang.String largeIconURL) Set a locale-sensitive URL that contains the large icon representing this object.
void	setName(java.lang.String name) Set the name of this object.
void	setSmallIconURL(java.util.Locale locale, java.lang.String smallIconURL) Set a locale-sensitive URL that contains the small icon representing this object.

Constructor Detail

BaseAttributeDescriptor

public BaseAttributeDescriptor()

Constructs an instance of BaseAttributeDescriptor with no name.

BaseAttributeDescriptor

public BaseAttributeDescriptor(java.lang.String name)

Constructs an instance of BaseAttributeDescriptor with the given name

Parameters:

name - name associated with the BaseAttributeDescriptor

Method Detail

getName

public java.lang.String getName()

Description copied from interface: BaseAttributeDescriptorInterface

Return the name of this object. This is an identifier and is not locale sensitive.

Specified by:

getName in interface BaseAttributeDescriptorInterface

Returns:

object name

See Also:

BaseAttributeDescriptorInterface.setName(String name)

setName

public void setName(java.lang.String name)

Description copied from interface: BaseAttributeDescriptorInterface

Set the name of this object. This is an identifier and is not locale sensitive.

Specified by:

setName in interface BaseAttributeDescriptorInterface

Parameters:

name - object name

See Also:

BaseAttributeDescriptorInterface.getName()

getLabel

public java.lang.String getLabel(java.util.Locale locale)

Description copied from interface: BaseAttributeDescriptorInterface

Return the label of this object; this is the name which will the user will see in a UI (User Interface) component. It is a locale-sensitive string. If no label is associated with the locale, then the label associated with the null locale is returned. If that does not exist, the name is returned.

Specified by:

getLabel in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale with which the label is associated. This parameter may be null.

Returns:

object label

See Also:

BaseAttributeDescriptorInterface.setLabel(Locale locale, String label)

setLabel

public void setLabel(java.util.Locale locale,
                     java.lang.String label)

Description copied from interface: BaseAttributeDescriptorInterface

Set the label of this object; this is the name which will the user will see in a UI (User Interface) component. It is a locale-sensitive string.

Specified by:

setLabel in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale with which the label is associated. This parameter may be null.

label - the visible name

See Also:

BaseAttributeDescriptorInterface.getLabel(Locale locale)

getLabels

public java.util.Map getLabels()

Description copied from interface: BaseAttributeDescriptorInterface

Returns a mapping of all of the labels defined for this object. The first item of each entry is the locale and the second item is the label.

Specified by:

getLabels in interface BaseAttributeDescriptorInterface

Returns:

label map

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Description copied from interface: BaseAttributeDescriptorInterface

Return the description of this object; this is the description which the user will see in a UI (User Interface) component. It is a locale-sensitive string. If no description is associated with the locale, then the description associated with the null locale is returned. If that does not exist, the name is returned.

Specified by:

getDescription in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale with which this description is associated. This may be null.

Returns:

object description

See Also:

BaseAttributeDescriptorInterface.setDescription(Locale locale, String description)

setDescription

public void setDescription(java.util.Locale locale,
                           java.lang.String description)

Description copied from interface: BaseAttributeDescriptorInterface

Set the description of this object;this is the description which the user will see in a UI (User Interface) component.

Specified by:

setDescription in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale with which this description is associated. This may be null.

description - description of the object

See Also:

BaseAttributeDescriptorInterface.getDescription(Locale locale)

getDescriptions

public java.util.Map getDescriptions()

Description copied from interface: BaseAttributeDescriptorInterface

Returns a mapping of all of the descriptions defined for this object. The first item of each entry is the locale and the second item is the description.

Specified by:

getDescriptions in interface BaseAttributeDescriptorInterface

Returns:

description map

getCustomizer

public java.lang.String getCustomizer(java.lang.String context)

Description copied from interface: BaseAttributeDescriptorInterface

Return this object's customizer. A customizer is a standalone editor used to customize or edit a value. It does not reside inside a UI (User Interface) element as an editor does, but defines its own window.

Specified by:

getCustomizer in interface BaseAttributeDescriptorInterface

Parameters:

context - the context in which the customizer is instantiated/used; it is a platform specification from EntityContextInterface

Returns:

object customizer

See Also:

BaseAttributeDescriptorInterface.setCustomizer(String context, String customizer), EntityContextInterface

setCustomizer

public void setCustomizer(java.lang.String context,
                          java.lang.String customizer)

Description copied from interface: BaseAttributeDescriptorInterface

Set the customizer for a specific context.

Specified by:

setCustomizer in interface BaseAttributeDescriptorInterface

Parameters:

context - the context in which the customizer is instantiated/used; it is a platform specification from EntityContextInterface

customizer - the name of the customizer

See Also:

BaseAttributeDescriptorInterface.getCustomizer(String context), EntityContextInterface

getAttributeCustomizers

public java.util.Map getAttributeCustomizers()

Description copied from interface: BaseAttributeDescriptorInterface

Returns a mapping of all of the customizers defined for this object. The first item of each entry is the context and the second item is the class name of the customizer.

Specified by:

getAttributeCustomizers in interface BaseAttributeDescriptorInterface

Returns:

customizer map

getAttributeCustomizerContexts

public java.util.List getAttributeCustomizerContexts()

Description copied from interface: BaseAttributeDescriptorInterface

Returns a list of customizer contexts defined for this object.

Specified by:

getAttributeCustomizerContexts in interface BaseAttributeDescriptorInterface

Returns:

customizer map

getConfigurationXML

public java.lang.String getConfigurationXML()

Description copied from interface: BaseAttributeDescriptorInterface

Return the XML which is used to configure or constrain this object. This XML can be used by this object's validators, editors, and customizers.

Specified by:

getConfigurationXML in interface BaseAttributeDescriptorInterface

Returns:

this object's configuration XML.

See Also:

BaseAttributeDescriptorInterface.setConfigurationXML(String configurationXML)

setConfigurationXML

public void setConfigurationXML(java.lang.String configurationXML)

Description copied from interface: BaseAttributeDescriptorInterface

Assign XML which can be used to configure or constrain this object.

Specified by:

setConfigurationXML in interface BaseAttributeDescriptorInterface

Parameters:

configurationXML - the XML configuration for this object

See Also:

BaseAttributeDescriptorInterface.getConfigurationXML()

getSmallIconURL

public java.lang.String getSmallIconURL(java.util.Locale locale)

Description copied from interface: BaseAttributeDescriptorInterface

Return a URL that contains the small icon representing this object.

Specified by:

getSmallIconURL in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale in which to express the small icon. If no small icon URL is associated with the locale, then the small icon URL associated with the null locale is returned. If that does not exist, then null is returned.

Returns:

this object's small icon.

See Also:

BaseAttributeDescriptorInterface.setSmallIconURL(Locale locale, String smallIconURL)

setSmallIconURL

public void setSmallIconURL(java.util.Locale locale,
                            java.lang.String smallIconURL)

Description copied from interface: BaseAttributeDescriptorInterface

Set a locale-sensitive URL that contains the small icon representing this object.

Specified by:

setSmallIconURL in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale in which to express the small icon. This may be null.

smallIconURL - the icon's url

See Also:

BaseAttributeDescriptorInterface.getSmallIconURL(Locale locale)

getSmallIconURLs

public java.util.Map getSmallIconURLs()

Description copied from interface: BaseAttributeDescriptorInterface

Returns a mapping of all of the small icon URLs defined for this object. The first item of each entry is the locale and the second item is the small icon URL.

Specified by:

getSmallIconURLs in interface BaseAttributeDescriptorInterface

Returns:

map of small icon URLs

getLargeIconURL

public java.lang.String getLargeIconURL(java.util.Locale locale)

Description copied from interface: BaseAttributeDescriptorInterface

Return a URL that contains the large icon representing this object.

Specified by:

getLargeIconURL in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale in which to express the icon. If no large icon URL is associated with the locale, then the large icon URL associated with the null locale is returned. If that does not exist, then null is returned.

Returns:

this object's large icon.

See Also:

BaseAttributeDescriptorInterface.setLargeIconURL(Locale locale, String largeIconURL)

setLargeIconURL

public void setLargeIconURL(java.util.Locale locale,
                            java.lang.String largeIconURL)

Description copied from interface: BaseAttributeDescriptorInterface

Set a locale-sensitive URL that contains the large icon representing this object.

Specified by:

setLargeIconURL in interface BaseAttributeDescriptorInterface

Parameters:

locale - the locale in which to express the large icon. This may be null.

largeIconURL - the icon's url

See Also:

BaseAttributeDescriptorInterface.getLargeIconURL(Locale locale)

getLargeIconURLs

public java.util.Map getLargeIconURLs()

Description copied from interface: BaseAttributeDescriptorInterface

Returns a mapping of all of the large icon URLs defined for this object. The first item of each entry is the locale and the second item is the large icon URL.

Specified by:

getLargeIconURLs in interface BaseAttributeDescriptorInterface

Returns:

map of large icon URLs