public class

TaskParameterMetadataImpl

extends AbstractConfigurationElement
implements TaskParameterMetadata

java.lang.Object
↳	com.microstrategy.utils.config.AbstractConfigurationElement
	↳	com.microstrategy.web.tasks.config.TaskParameterMetadataImpl

Class Overview

THIS CLASS IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE CLASS IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.

Summary

Constants
String	NODE_PARAMETER

[Expand]

Inherited Constants

From class com.microstrategy.utils.config.AbstractConfigurationElement

Public Constructors
	TaskParameterMetadataImpl() Constructs a TaskParameterMetadataImpl object.
	TaskParameterMetadataImpl(String name) Constructs a TaskParameterMetadataImpl object.

Public Methods
String[]	getArrayValue(RequestKeys requestKeys) Returns an array of string values by parsing the parameter value.
String[]	getArrayValue(RequestKeys requestKeys, String delim) Returns an array of string values by parsing the parameter value and using the specified delimiter.
boolean	getBooleanValue(RequestKeys requestKeys) Returns the boolean value of a parameter.
String	getDefaultValue() Get the default value associated with this parameter.
Object	getDefaultValueObject() Get the default generic object associated with this parameter.
String	getDescription() Returns the textual description of this Task parameter.
int	getIntValue(RequestKeys requestKeys) Returns the integer value of a parameter.
long	getLongValue(RequestKeys requestKeys) Returns the long value of a parameter.
String	getName() Returns the name of this Task parameter.
PostedFile	getPostedFile(TaskRequestContext context) Returns data file uploaded by user via a "multipart/form-data" request form.
String	getType() Returns the data type of this Task parameter.
String	getValidator() Returns the data type validator of this Task parameter.
String	getValue(RequestKeys requestKeys) Returns the value of a parameter, given the supplied input parameters.
Enumeration	getValueObject(RequestKeys requestKeys) Returns the enumeration of value objects of a parameter, given the supplied input parameters.
boolean	isHidden()
boolean	isRequired() Whether this Task parameter is required, and must be supplied in all Task invocations.
void	setDefaultValue(Object defValue) Specifies a default value for this parameter.
void	setDefaultValue(String defValue) This method is deprecated. Use `setDefaultValue(Object)` instead
void	setDescription(String desc) Sets the description for a task parameter.
void	setHidden(boolean isHidden) Sets whether this parameter is private or not.
void	setName(String name)
void	setRequired(boolean required) Sets whether this parameter is required or not.
void	setType(String type)
void	setValidator(String validator)

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.

[Expand]

Inherited Methods

From class com.microstrategy.utils.config.AbstractConfigurationElement

void	addFileSource(String filePath, String appPath, long lastLoaded) Adds a reference to a file from a config-source.
void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
void	cleanUpDeletedElements() This method when called will delete all the child elements that are marked as deleted.
Object	clone()
void	delete(Object key)
AbstractConfigurationElement	deltas(AbstractConfigurationElement other) Returns a partial instance of this object that contains the attributes and elements required to make this object equals to the `other` paramter.
final AbstractConfigurationElement	deltas() Returns the `deltas` between the `original()` and `this` objects.
boolean	equalAtts(AbstractConfigurationElement other) Returns `true` if the list of active attributes of the given AbstractConfigurationElement is equal to this list of active attributes of this AbstractConfigurationElement.
boolean	equalElements(AbstractConfigurationElement other) Returns `true` if the list of all child elements of the given AbstractConfigurationElement is equal to this list of all child-elements of this AbstractConfigurationElement.
boolean	equalNodeValues(AbstractConfigurationElement other) Returns `true` if the node value of both configuration elements is the same.
boolean	equals(Object object)
boolean	equalsIncludingDeletedElements(Object object)
void	exportAttributesToXML(Element element, ConfigurationSource source) Appends the list of attributes of this `ConfigurationElement` into the given node.
void	exportElementsToXML(Element element, ConfigurationSource source) Appends the list of child-elements of this `ConfigurationElement` into the given node.
void	exportNodeValueToXML(Element element, ConfigurationSource source) Appends the node value associated with the given source key into the given node.
final ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
boolean	getBoolAttribute(String name) Helper method, returns the value of the given attribute as boolean (true/false).
Object	getChildKey(Node node) Returns the key that uniquely identifies the child element associated with the given `Node`.
String	getConfigSrc() Returns the value of the config-src attribute.
String	getDTDFileName() Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; `null` by default.
ConfigurationElement	getElement(Object key, boolean includeDeleted)
ConfigurationElement	getElement(Object key) Returns the `ConfigurationElement` instance associated with the given nodeName.
final HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
FileLoader	getFileLoader() Returns the file loader instance used by this ConfigurationElement to load files from the file system.
int	getIntAttribute(String name, int defaultValue) Helper method, returns the value of the given attribute as integer.
int	getIntAttribute(String name) Helper method, returns the value of the given attribute as integer.
Object	getKey() Default implementation for `getKey()`.
abstract 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.
int	getLineNumber() Returns the line number (if known) of the element in the XML file.
AbstractConfigurationElement.FilteredList	getList(String nodeName) Returns an `ImplicitList` with all the elements associated with the given `nodeName`.
Object	getNextKey() Returns an object that can be used as key for a list of child-elements that doesn't have a key by itself.
String	getNodeName() Returns the node-name for this element.
String	getNodeValue() Returns the node value for this element.
String	getNodeValue(ConfigurationSource source) Returns the node value for this element in the given sourceKey.
AbstractConfigurationElement	getOrCreateElement(String nodeName, Object key) Returns the current child instance; if null but the child is registered, it creates a new instance for it.
AbstractConfigurationElement	getParent() Gets the parent for this configuration element.
int	getPosition() Returns the expected position of this element.
AbstractConfigurationElement	getPrototype() Returns the current prototype of this instance.
Class	getRegisteredClass(String nodeName) Returns the `Class` associated with the given `nodeName`.
String	getSelfInitPath() Returns the path to the file where this configuration element was originally loaded from.
ConfigurationSource	getSource(String key) Gets the `ElementSource` for the given key.
String	getStrAttribute(String name) Helper method, returns the value of the given attribute as a string.
boolean	getUseDefault() Returns the use-default value.
ParserParameters	getXMLParserParameters(String fileName) Returns an instance of `ParserParameters` used by the XML parser.
SerializerParameters	getXMLSerializerParameters() Returns an instance of `SerializerParameters` used by the XML serializer in the `toXML()` By default it returns `null`.
boolean	hasRegisteredClass(String nodeName) Returns `true` is there is a child registered for the given `nodeName`.
int	hashCode()
int	hashCodeAtts() Returns the hashcode for attributes.
int	hashCodeElements() Returns the hashcode for attributes.
int	hashCodeNodeValues() Returns the hashcode for attributes.
void	initAttributesFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of attributes from given `Node`
void	initDefaultAttributes() This method can be overridden to set default values for attributes.
void	initElementFromXML(Node child, String sourceKey, CustomizationInfo c) Initializes a single child-element from the given `Node`
void	initElementsFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initFromFile(String filePath, CustomizationInfo c) Initializes this configuration element by loading the contents of the given `filePath` using the corresponding `CustomizationInfo`.
void	initFromResource(String resourceName) Initializes this configuration element by loading the contents a resource that exists in the class path.
void	initFromXML(Node root, String sourceKey, CustomizationInfo c) Initialize the attributes and child elements from the values in the given `Node`
void	initFromXML(Node root) Initialize the attributes and child elements from the values in the given `Node`
void	initNodeValueFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initPrototype(String protoName) Inits the prototype object of this element.
boolean	isActive()
boolean	isCustomized()
boolean	isDeleted() Returns `true` is this element has been mark as deleted.
boolean	isDirty() Returns `true` is this element or one of its children has been modified programatically after being loaded.
boolean	isInSource(String sourceKey) Returns `true` if the element already contains an `ElementSource` for the given key.
boolean	isKeyAttribute(String name) Returns `true` is the name is that of the key attribute.
void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationElement` with its content.
void	mergeChanges(String srcKey) Removes deltas and applies them to the given source.
AbstractConfigurationElement	newChildInstance(String nodeName, Class childClass) Creates a new instance of a child element for the given class.
ConfigurationSource	newSource(String srcKey, CustomizationInfo c) Create a new `ElementSource` and adds to the list of sources of this element.
final AbstractConfigurationElement	original() Returns a new instance of this object, populated only with the out of the box values of Microstrategy Web, that is, only default values or those that came from the load method.
ConfigurationElement	populate(ConfigurationElement other) This method takes another configuration element and populates this element with the other's attributes and child-elements.
void	printAttributes(StringBuffer outString) Appends the list of attributes of this `ConfigurationElement` into the given `StringBuffer`.
void	printElements(StringBuffer outString) Appends the list of child-elements of this `ConfigurationElement` into the given `StringBuffer`.
void	printNodeValue(StringBuffer outString) Appends the node value into the given `StringBuffer`.
void	refreshLists()
void	registerClass(String nodeName, Class c) Registers a child class for the child with the given `nodeName`.
void	registerElement(String nodeName, Class c) Register a child of this `ConfigurationElement`.
void	registerElement(String nodeName, Class c, boolean canBeNull) Register a child of this `ConfigurationElement`.
void	registerElementList(String nodeName, Class c) Register a list of this `ConfigurationElement`.
void	reload() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	reloadPrototype() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	removeAttribute(String name) Completely remove the value for the given attribute.
void	removeDefaults(CustomizationInfo c) This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.
void	replaceList(AbstractConfigurationElement.FilteredList list)
void	restore(Object key)
void	save(CustomizationInfo c) Saves deltas for this `ConfigurationElement` into the given CustomizationInfo.
void	save() Saves this `ConfigurationElement` back into the files where it was loaded from.
void	saveChangesAs(String fileName) Saves all in-memory changes to the given file.
final void	saveConfig(String filePath) This method is deprecated. To save in a different location, set a custom FileLoader and use the save() method.
void	saveFlatXML(String fileName) Saves the current element structure, in XML format, into the given file.
void	saveNode(Node node, String fileLocation) Saves an XML node into a file in the given location.
void	saveSource(ConfigurationSource source) Saves only the contents associated with the given source.
void	setAttribute(String name, Object value) Sets the value for the given attribute.
void	setBoolAttribute(String name, boolean value) Helper method, sets the value of the given attribute from a boolean.
void	setChildOriginals()
void	setConfigSrc(String path) Sets the config-src attribute.
void	setCustomized(boolean value) set if this element is a customized element or not.
void	setElement(Object key, ConfigurationElement child) Allows users to add or replace an element.
void	setFileLoader(FileLoader fl) Sets the `FileLoader` instance to be used to load files.
void	setIntAttribute(String name, int value) Helper method, sets the value of the given attribute from an integer.
void	setKey(Element element) Default implementation for `setKey()`.
void	setLineNumber(int lineNumber) Sets the line number of the element in the XML file.
void	setNodeName(String name) Sets the name of the node associated with this configuration element.
void	setNodeValue(String value) Returns the node value for this element.
void	setPosition(int position) Sets the expected position of this element.
void	setPrototype(AbstractConfigurationElement prototype) Sets the prototype object for this instance.
void	setSelfInitPath(String value)
void	setStrAttribute(String name, String value) Helper method, sets the value of the given attribute as a string.
void	setUseDefault(boolean useDefault) The definition of a ConfigurationElement can come come from different sources, for example, the definition can come from an external file (by specifying a `getConfigSrc()` value), or it can be modified through a Customization.
void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
String	toString() Generates the String representation of this `ConfigurationElement`.
Element	toXML(Document doc, String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
synchronized Element	toXML(Document doc) Generates the DOM representation of this `ConfigurationElement`.
synchronized Element	toXML() Generates the DOM representation of this `ConfigurationElement`.
Element	toXML(String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
boolean	useNodeValue() Controls whether this element will use the node value as a property.
boolean	useValidation() Returns whether the XML content should be validated using a DTD.

From class java.lang.Object

From interface com.microstrategy.utils.config.ConfigurationElement

abstract ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
abstract HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
abstract ConfigurationElement	getElement(Object nodeName) Returns the `ConfigurationElement` instance associated with the given nodeName.
abstract HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
abstract Object	getKey() This method is used to uniquely identify this ConfigurationElement within a list.
abstract String	getNodeName() Returns the node-name for this element.
abstract String	getStrAttribute(String name)
abstract void	initFromXML(Node root) Initializes the object with information from an XML Node.
abstract void	reload() Triggers the re-initialization of the element and its children if the configuration files have changed.
abstract Element	toXML(Document doc) Utility method to get the object's XML representation.

From interface com.microstrategy.utils.config.ConfigurationFile

abstract void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
abstract void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
abstract void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationFile` with its content.
abstract void	reload() Reloads the content of this `ConfigurationFile` if the underlying configuration file has changed.
abstract void	save() Saves this `ConfigurationFile` back into the files where it was loaded from.
abstract void	save(CustomizationInfo c) Saves the differences between the shipped ("out of the box") definition of this `ConfigurationFile` and its currents values into the corresponding `CustomizationInfo`.
abstract void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
abstract boolean	useValidation() Returns whether the XML content should be validated using a DTD.

From interface com.microstrategy.web.tasks.TaskParameterMetadata

abstract String[]	getArrayValue(RequestKeys requestKeys) Returns an array of string values by parsing the parameter value.
abstract String[]	getArrayValue(RequestKeys requestKeys, String delim) Returns an array of string values by parsing the parameter value and using the specified delimiter.
abstract boolean	getBooleanValue(RequestKeys requestKeys) Returns the boolean value of a parameter.
abstract String	getDefaultValue() Get the default value associated with this parameter.
abstract Object	getDefaultValueObject() Get the default generic object associated with this parameter.
abstract String	getDescription() Returns the textual description of this Task parameter.
abstract int	getIntValue(RequestKeys requestKeys) Returns the integer value of a parameter.
abstract long	getLongValue(RequestKeys requestKeys) Returns the long value of a parameter.
abstract String	getName() Returns the name of this Task parameter.
abstract PostedFile	getPostedFile(TaskRequestContext context) Returns data file uploaded by user via a "multipart/form-data" request form.
abstract String	getType() Returns the data type of this Task parameter.
abstract String	getValidator() Returns the data type validator of this Task parameter.
abstract String	getValue(RequestKeys requestKeys) Returns the value of a parameter, given the supplied input parameters.
abstract Enumeration	getValueObject(RequestKeys requestKeys) Returns the enumeration of value objects of a parameter, given the supplied input parameters.
abstract boolean	isHidden()
abstract boolean	isRequired() Whether this Task parameter is required, and must be supplied in all Task invocations.

Constants

public static final String NODE_PARAMETER

Constant Value: "parameter"

Public Constructors

public TaskParameterMetadataImpl ()

Constructs a TaskParameterMetadataImpl object.

public TaskParameterMetadataImpl (String name)

Constructs a TaskParameterMetadataImpl object.

Parameters

name	The name of the task parameter.

Public Methods

public String[] getArrayValue (RequestKeys requestKeys)

Returns an array of string values by parsing the parameter value. It assumes that array elements are separated (delimited) by commas.

Returns

An array of Strings (without delimiters included).

public String[] getArrayValue (RequestKeys requestKeys, String delim)

Returns an array of string values by parsing the parameter value and using the specified delimiter.

Parameters

requestKeys	A `RequestKeys` object that contains the input parameters.
delim	The String delimiter used to separate array elements.

Returns

An array of Strings (without delimiters included).

public boolean getBooleanValue (RequestKeys requestKeys)

Returns the boolean value of a parameter. If not specified, a parameter's default value may be used.

Parameters

requestKeys	A `RequestKeys` object that contains the input parameters.

Returns

A boolean value for the parameter.

Throws

TaskRequestMalformedException

public String getDefaultValue ()

Get the default value associated with this parameter.

Returns

The default value, or null, if no default value is specified.

public Object getDefaultValueObject ()

Get the default generic object associated with this parameter.

Returns

The default value object, or null, if no default value is specified.

public String getDescription ()

Returns the textual description of this Task parameter.

Returns

The textual description of this Task parameter.

public int getIntValue (RequestKeys requestKeys)

Returns the integer value of a parameter. If not specified, a parameter's default value may be used.

Parameters

requestKeys	A `RequestKeys` object that contains the input parameters.

Returns

An integer value for the parameter.

Throws

TaskRequestMalformedException

public long getLongValue (RequestKeys requestKeys)

Returns the long value of a parameter. If not specified, a parameter's default value may be used.

Parameters

requestKeys	A `RequestKeys` object that contains the input parameters.

Returns

A long (integer) value for the parameter.

Throws

TaskRequestMalformedException

public String getName ()

Returns the name of this Task parameter.

Returns

The name of this Task parameter.

public PostedFile getPostedFile (TaskRequestContext context)

Returns data file uploaded by user via a "multipart/form-data" request form. Note that PostedFile is always returned even if the user uploaded nothing - getLength() should be checked for non-zero to indicate existence of data.

Returns

the data uploaded with "multipart/form-data".

public String getType ()

Returns the data type of this Task parameter.

Returns

The data type of this Task parameter.

public String getValidator ()

Returns the data type validator of this Task parameter.

Returns

The the data type validator of this Task parameter.

public String getValue (RequestKeys requestKeys)

Returns the value of a parameter, given the supplied input parameters. If the parameter has been explicitly specified in the input parameters, it is returned. If not, and the default value is non-null, then that is returned. Otherwise, null is returned.

Parameters

requestKeys	A `RequestKeys` object that contains the input parameters.

Returns

The computed value of the parameter for a specific request.

public Enumeration getValueObject (RequestKeys requestKeys)

Returns the enumeration of value objects of a parameter, given the supplied input parameters. If the parameter has been explicitly specified in the input parameters, it is returned. If not, and the default value is non-null, then that is returned. Otherwise, null is returned.

Parameters

requestKeys	A `RequestKeys` object that contains the input parameters.

Returns

The computed value of the parameter for a specific request.

public boolean isHidden ()

public boolean isRequired ()

Whether this Task parameter is required, and must be supplied in all Task invocations.

Returns

True, if this parameter is required; otherwise, false.

public void setDefaultValue (Object defValue)

Specifies a default value for this parameter.

Parameters

defValue	The value to use if none is supplied.

public void setDefaultValue (String defValue)

This method is deprecated.
Use setDefaultValue(Object) instead

Specifies a default value for this parameter.

Parameters

defValue	The value to use if none is supplied.

public void setDescription (String desc)

Sets the description for a task parameter.

Parameters

desc	The description to associate with this task parameter.

public void setHidden (boolean isHidden)

Sets whether this parameter is private or not.

public void setName (String name)

public void setRequired (boolean required)

Sets whether this parameter is required or not.

Parameters

required	Whether this parameter is required or not.

public void setType (String type)

public void setValidator (String validator)

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.

Classes

TaskParameterMetadataImpl

Class Overview

Summary

Constants

public static final String NODE_PARAMETER

Public Constructors

public TaskParameterMetadataImpl ()

public TaskParameterMetadataImpl (String name)

Parameters

Public Methods

public String[] getArrayValue (RequestKeys requestKeys)

Returns

public String[] getArrayValue (RequestKeys requestKeys, String delim)

Parameters

Returns

public boolean getBooleanValue (RequestKeys requestKeys)

Parameters

Returns

Throws

public String getDefaultValue ()

Returns

public Object getDefaultValueObject ()

Returns

public String getDescription ()

Returns

public int getIntValue (RequestKeys requestKeys)

Parameters

Returns

Throws

public long getLongValue (RequestKeys requestKeys)

Parameters

Returns

Throws

public String getName ()

Returns

public PostedFile getPostedFile (TaskRequestContext context)

Returns

public String getType ()

Returns

public String getValidator ()

Returns

public String getValue (RequestKeys requestKeys)

Parameters

Returns

public Enumeration getValueObject (RequestKeys requestKeys)

Parameters

Returns

public boolean isHidden ()

public boolean isRequired ()

Returns

public void setDefaultValue (Object defValue)

Parameters

public void setDefaultValue (String defValue)

Parameters

public void setDescription (String desc)

Parameters

public void setHidden (boolean isHidden)

public void setName (String name)

public void setRequired (boolean required)

Parameters

public void setType (String type)

public void setValidator (String validator)

Protected Methods

protected String getKeyAttribute ()