public class

ExportPlaintextDelimiter

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.config.ExportPlaintextDelimiter

Class Overview

Defines a single valid export plaintext delimiter.
Plaintext delimiters are shown on the Export Options page as well as the export preferences page.

Summary

Constants
String ATT_DESC
String ATT_DESC_ID
String ATT_KEY
String NODE_EXPORT_PLAINTEXT_DELIMITER
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ExportPlaintextDelimiter()
Default no-arg constructor.
ExportPlaintextDelimiter(Node root)
Class constructor.
Public Methods
String getDescription()
Returns the descriptor that the application should use to display the delimiter if the desc-id attribute is missing.
String getDescriptorID()
Returns the descriptor id, that is Resource Bundle item id that the application should use to display the delimiter descriptor in the language of the user's locale.
String getMessage(Messages messages)
String getValue()
void setDescription(String description)
Sets the descriptor that the application should use to display the delimiter if the desc-id attribute is missing.
void setDescriptorID(String descriptorID)
Set the descriptor id, that is Resource Bundle item id that the application should use to display the delimiter descriptor in the language of the user's locale.
void setKey(String key)
Sets the key for this paper size, a unique identifier used by MicroStrategy Web to identify the delimiter.
void setValue(String value)
Set the delimiter value (i.e.
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
boolean useNodeValue()
Controls whether this element will use the node value as a property.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_DESC

Constant Value: "desc"

public static final String ATT_DESC_ID

Constant Value: "desc-id"

public static final String ATT_KEY

Constant Value: "key"

public static final String NODE_EXPORT_PLAINTEXT_DELIMITER

Constant Value: "export-plaintext-delimiter"

Public Constructors

public ExportPlaintextDelimiter ()

Default no-arg constructor.

public ExportPlaintextDelimiter (Node root)

Class constructor. Initializes a Export Delimiter instance based on the information included on the XML Node

Parameters
root Node instance representing the paper size information.

Public Methods

public String getDescription ()

Returns the descriptor that the application should use to display the delimiter if the desc-id attribute is missing.

public String getDescriptorID ()

Returns the descriptor id, that is Resource Bundle item id that the application should use to display the delimiter descriptor in the language of the user's locale.

public String getMessage (Messages messages)

Parameters
messages the messages l10n object.
Returns
  • the delimiter's localized descriptor, or the description if the descriptionId is empty.

public String getValue ()

Returns
  • the delimiter value (i.e. ',' for the comma)

public void setDescription (String description)

Sets the descriptor that the application should use to display the delimiter if the desc-id attribute is missing.

public void setDescriptorID (String descriptorID)

Set the descriptor id, that is Resource Bundle item id that the application should use to display the delimiter descriptor in the language of the user's locale.

public void setKey (String key)

Sets the key for this paper size, a unique identifier used by MicroStrategy Web to identify the delimiter.

public void setValue (String value)

Set the delimiter value (i.e. ',' for the comma)

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

protected boolean useNodeValue ()

Controls whether this element will use the node value as a property. For example, nodes defined as:


  <a att="1">This is the node value</a>
 
can expose a property which will return the node's value (This is the node vale). When this is the case, though, the element can't have any sub elements. They're mutually exclusive.

Returns
  • false by default. Override this method if you want to associate the node value with some property.