Package com.microstrategy.web.transform

Class ActualParametersImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractElementList

com.microstrategy.web.transform.AbstractStyleCatalogList

com.microstrategy.web.transform.ActualParametersImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, ActualParameters, java.lang.Cloneable

public class ActualParametersImpl
extends AbstractStyleCatalogList
implements ActualParameters

ActualParametersImpl implements Actualparameters interface, which is a collection of ActualParameterImpl objects.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	NODE_ACTUAL_PARAMETERS

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
ActualParametersImpl()

Method Summary

Modifier and Type	Method	Description
ActualParameter	getActualParameter(int index)	Retrieves a specific actual parameter at a given index in the collection.
ActualParameter	getActualParameter(FormalParameter formalParam)	Retrieves the actual parameter associated with the given formal parameter.
ActualParameter	getActualParameter(java.lang.String name)	Retrieves the actual parameter with the given name.
java.util.Enumeration	getActualParameters(FormalParameter formalParam)	Deprecated. The name of the actual parameter is now used as the key therefore this enumeration will return at most one value, the same as getActualParameter(String).
java.util.Enumeration	getActualParameters(java.lang.String name)	Deprecated. The name of the actual parameter is now used as the key therefore this enumeration will return at most one value, the same as getActualParameter(String).
protected java.lang.Class	getListClass()	Returns the Class items beloging to this list will be instance of.
protected java.lang.String	getListNodeName()	Returns the name of the node representing children of this list.
int	getNumMismatchedParams()	Returns the number of actual parameters, whose name doesn't match a formal parameter.
boolean	hasActualParameter(FormalParameter formalParameter)	Determines whether an actual parameter exists for a given formal parameter.
ActualParameter	newActualParameter(FormalParameter formalParam)	Creates a new ActualParameter object associated with the given formal parameter.
ActualParameter	newActualParameter(java.lang.String name)	Creates a new ActualParameter object with the given name, and it adds it to the collection.
void	remove(FormalParameter formalParam)	Removes the ActualParameter object associated with the given formal parameter.

Methods inherited from class com.microstrategy.web.transform.AbstractStyleCatalogList

clearCaches, getCount, getStyleCatalog, newItem, reload, remove, remove

Methods inherited from class com.microstrategy.utils.config.AbstractElementList

clear, containsKey, get, get, getKeyAttribute, getList, isEmpty, put, put, size

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, 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, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.ActualParameters

clear, getCount, remove, remove

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_ACTUAL_PARAMETERS

protected static final java.lang.String NODE_ACTUAL_PARAMETERS

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

ActualParametersImpl

public ActualParametersImpl()

Since:

MicroStrategy Web 9.0.0

Method Detail

hasActualParameter

public boolean hasActualParameter(FormalParameter formalParameter)

Description copied from interface: ActualParameters

Determines whether an actual parameter exists for a given formal parameter.

Specified by:

hasActualParameter in interface ActualParameters

Parameters:

formalParameter - The FormalParameter who's actual you are looking for.

Returns:

True if an actual value exists for this formal parameter; false, otherwise.

getActualParameter

public ActualParameter getActualParameter(int index)
                                   throws java.lang.IndexOutOfBoundsException

Description copied from interface: ActualParameters

Retrieves a specific actual parameter at a given index in the collection.

Specified by:

getActualParameter in interface ActualParameters

Parameters:

index - of the object in collection.

Returns:

the ActualParameter object in the collection with the given index.

Throws:

java.lang.IndexOutOfBoundsException - thrown if the index is invalid.

getActualParameter

public ActualParameter getActualParameter(java.lang.String name)
                                   throws java.lang.IllegalArgumentException

Description copied from interface: ActualParameters

Retrieves the actual parameter with the given name.

Specified by:

getActualParameter in interface ActualParameters

Parameters:

name - the name of the actual parameter.

Returns:

the ActualParameter object with the given name.

Throws:

java.lang.IllegalArgumentException - thrown if no actual parameter has the given name.

getActualParameter

public ActualParameter getActualParameter(FormalParameter formalParam)
                                   throws java.lang.IllegalArgumentException

Description copied from interface: ActualParameters

Retrieves the actual parameter associated with the given formal parameter.

Specified by:

getActualParameter in interface ActualParameters

Parameters:

formalParam - the FormalParameter associated with the actual parameter.

Returns:

the ActualParameter object associated with the given formal parameter.

Throws:

java.lang.IllegalArgumentException - thrown if no actual parameter is associated with the given formal parameter object.

getNumMismatchedParams

public int getNumMismatchedParams()

Description copied from interface: ActualParameters

Returns the number of actual parameters, whose name doesn't match a formal parameter.

Specified by:

getNumMismatchedParams in interface ActualParameters

Returns:

number of mismatched parameters in the collection.

remove

public void remove(FormalParameter formalParam)
            throws java.lang.IllegalArgumentException

Description copied from interface: ActualParameters

Removes the ActualParameter object associated with the given formal parameter.

Specified by:

remove in interface ActualParameters

Parameters:

formalParam - the FormalParameter associated with the actual parameter.

Throws:

java.lang.IllegalArgumentException - thrown if no actual parameter is associated with the given formal parameter object.

newActualParameter

public ActualParameter newActualParameter(java.lang.String name)
                                   throws java.lang.IllegalArgumentException

Description copied from interface: ActualParameters

Creates a new ActualParameter object with the given name, and it adds it to the collection.

Specified by:

newActualParameter in interface ActualParameters

Parameters:

name - the name of the new ActualParameter object.

Returns:

the ActualParameter object created.

Throws:

java.lang.IllegalArgumentException - thrown if the name is null.

newActualParameter

public ActualParameter newActualParameter(FormalParameter formalParam)
                                   throws java.lang.IllegalArgumentException

Description copied from interface: ActualParameters

Creates a new ActualParameter object associated with the given formal parameter.

Specified by:

newActualParameter in interface ActualParameters

Parameters:

formalParam - the FormalParameter object the caller wants to associate the actual parameter with.

Returns:

the ActualParameter object created.

Throws:

java.lang.IllegalArgumentException

getActualParameters

public java.util.Enumeration getActualParameters(java.lang.String name)
                                          throws java.lang.IllegalArgumentException

Deprecated.

The name of the actual parameter is now used as the key therefore this enumeration will return at most one value, the same as getActualParameter(String).

Returns an enumeration with the list of actual parameters associated with the given name.

Specified by:

getActualParameters in interface ActualParameters

Parameters:

name - the actual parameter name

Returns:

an enumeration over the ActualParameter objects with the specified name

Throws:

java.lang.IllegalArgumentException - thrown if the name does not exist

Since:

MicroStrategy Web 8.0.0

getActualParameters

public java.util.Enumeration getActualParameters(FormalParameter formalParam)
                                          throws java.lang.IllegalArgumentException

Deprecated.

The name of the actual parameter is now used as the key therefore this enumeration will return at most one value, the same as getActualParameter(String).

Returns an enumeration with the list of actual parameters associated with the given FormalParameter.

Specified by:

getActualParameters in interface ActualParameters

Parameters:

formalParam - a FormalParameter

Returns:

an enumeration over the ActualParameter objects matching the specified FormalParameter.

Throws:

java.lang.IllegalArgumentException - if there is no such an ActualParameter matching the specified FormalParameter.

Since:

MicroStrategy Web 8.0.0

getListClass

protected java.lang.Class getListClass()

Description copied from class: AbstractElementList

Returns the Class items beloging to this list will be instance of.

Specified by:

getListClass in class AbstractElementList

Since:

MicroStrategy Web 9.0.0

getListNodeName

protected java.lang.String getListNodeName()

Description copied from class: AbstractElementList

Returns the name of the node representing children of this list.

Specified by:

getListNodeName in class AbstractElementList

Since:

MicroStrategy Web 9.0.0