Package com.microstrategy.web.config
Class ExportPlaintextDelimiter
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.web.config.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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
AbstractConfigurationElement.FilteredList
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATT_DESC
static java.lang.String
ATT_DESC_ID
static java.lang.String
ATT_KEY
static java.lang.String
NODE_EXPORT_PLAINTEXT_DELIMITER
-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT
-
-
Constructor Summary
Constructors Constructor Description ExportPlaintextDelimiter()
Default no-arg constructor.ExportPlaintextDelimiter(org.w3c.dom.Node root)
Class constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the descriptor that the application should use to display the delimiter if the desc-id attribute is missing.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.protected java.lang.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 thegetKey
andsetKey
methods.java.lang.String
getMessage(Messages messages)
java.lang.String
getValue()
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.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.void
setKey(java.lang.String key)
Sets the key for this paper size, a unique identifier used by MicroStrategy Web to identify the delimiter.void
setValue(java.lang.String value)
Set the delimiter value (i.e.protected boolean
useNodeValue()
Controls whether this element will use the node value as a property.-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useValidation
-
-
-
-
Field Detail
-
NODE_EXPORT_PLAINTEXT_DELIMITER
public static final java.lang.String NODE_EXPORT_PLAINTEXT_DELIMITER
- See Also:
- Constant Field Values
-
ATT_KEY
public static final java.lang.String ATT_KEY
- See Also:
- Constant Field Values
-
ATT_DESC
public static final java.lang.String ATT_DESC
- See Also:
- Constant Field Values
-
ATT_DESC_ID
public static final java.lang.String ATT_DESC_ID
- See Also:
- Constant Field Values
-
-
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 thegetKey
andsetKey
methods.- Specified by:
getKeyAttribute
in classAbstractConfigurationElement
-
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:
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.<a att="1">This is the node value</a>
- Overrides:
useNodeValue
in classAbstractConfigurationElement
- Returns:
false
by default. Override this method if you want to associate the node value with some property.
-
-