Package com.microstrategy.web.config

Class ExportPlaintextDelimiter

  • All Implemented Interfaces:
    ConfigurationElement, ConfigurationFile, java.lang.Cloneable
    public class ExportPlaintextDelimiter
extends AbstractConfigurationElement
    Defines a single valid export plaintext delimiter.
    Plaintext delimiters are shown on the Export Options page as well as the export preferences page.
    Since:
    MicroStrategy Web 9.0.0

    • Constructor Detail

      • ExportPlaintextDelimiter

        public ExportPlaintextDelimiter()
        Default no-arg constructor.

      • ExportPlaintextDelimiter

        public ExportPlaintextDelimiter​(org.w3c.dom.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.

    • Method Detail

      • getKeyAttribute

        protected java.lang.String getKeyAttribute()
        Description copied from class: AbstractConfigurationElement
        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.
        Specified by:
        getKeyAttribute in class AbstractConfigurationElement

      • getMessage

        public java.lang.String getMessage​(Messages messages)
        Parameters:
        messages - the messages l10n object.
        Returns:
        the delimiter's localized descriptor, or the description if the descriptionId is empty.

      • setKey

        public void setKey​(java.lang.String key)
        Sets the key for this paper size, a unique identifier used by MicroStrategy Web to identify the delimiter.

      • getDescriptorID

        public java.lang.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.

      • setDescriptorID

        public void setDescriptorID​(java.lang.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.

      • getDescription

        public java.lang.String getDescription()
        Returns the descriptor that the application should use to display the delimiter if the desc-id attribute is missing.

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the descriptor that the application should use to display the delimiter if the desc-id attribute is missing.

      • getValue

        public java.lang.String getValue()
        Returns:
        the delimiter value (i.e. ',' for the comma)

      • setValue

        public void setValue​(java.lang.String value)
        Set the delimiter value (i.e. ',' for the comma)

      • useNodeValue

        protected boolean useNodeValue()
        Description copied from class: AbstractConfigurationElement
        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.
        Overrides:
        useNodeValue in class AbstractConfigurationElement
        Returns:
        false by default. Override this method if you want to associate the node value with some property.