public class

ActualParametersImpl

extends AbstractStyleCatalogList
implements ActualParameters
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.utils.config.AbstractElementList
       ↳ com.microstrategy.web.transform.AbstractStyleCatalogList
         ↳ com.microstrategy.web.transform.ActualParametersImpl

Class Overview

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

Summary

Constants
String NODE_ACTUAL_PARAMETERS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ActualParametersImpl()
Public Methods
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(String name)
Retrieves the actual parameter with the given name.
Enumeration getActualParameters(FormalParameter formalParam)
This method is 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).
Enumeration getActualParameters(String name)
This method is 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).
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(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.
Protected Methods
Class getListClass()
Returns the Class items beloging to this list will be instance of.
String getListNodeName()
Returns the name of the node representing children of this list.
[Expand]
Inherited Methods
From class com.microstrategy.web.transform.AbstractStyleCatalogList
From class com.microstrategy.utils.config.AbstractElementList
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
From interface com.microstrategy.web.transform.ActualParameters

Constants

protected static final String NODE_ACTUAL_PARAMETERS

Constant Value: "ActualParameters"

Public Constructors

public ActualParametersImpl ()

Public Methods

public ActualParameter getActualParameter (int index)

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

Parameters
index of the object in collection.
Returns
Throws
IndexOutOfBoundsException

public ActualParameter getActualParameter (FormalParameter formalParam)

Retrieves the actual parameter associated with the given formal parameter.

Parameters
formalParam the FormalParameter associated with the actual parameter.
Returns
Throws
IllegalArgumentException

public ActualParameter getActualParameter (String name)

Retrieves the actual parameter with the given name.

Parameters
name the name of the actual parameter.
Returns
Throws
IllegalArgumentException

public Enumeration getActualParameters (FormalParameter formalParam)

This method is 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.

Parameters
formalParam a FormalParameter
Returns
  • an enumeration over the ActualParameter objects matching the specified FormalParameter.
Throws
IllegalArgumentException

public Enumeration getActualParameters (String name)

This method is 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.

Parameters
name the actual parameter name
Returns
  • an enumeration over the ActualParameter objects with the specified name
Throws
IllegalArgumentException

public int getNumMismatchedParams ()

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

Returns
  • number of mismatched parameters in the collection.

public boolean hasActualParameter (FormalParameter formalParameter)

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

Parameters
formalParameter The FormalParameter who's actual you are looking for.
Returns
  • True if an actual value exists for this formal parameter; false, otherwise.

public ActualParameter newActualParameter (FormalParameter formalParam)

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

Parameters
formalParam the FormalParameter object the caller wants to associate the actual parameter with.
Returns
Throws
IllegalArgumentException

public ActualParameter newActualParameter (String name)

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

Parameters
name the name of the new ActualParameter object.
Returns
  • the ActualParameter object created.
Throws
IllegalArgumentException

public void remove (FormalParameter formalParam)

Removes the ActualParameter object associated with the given formal parameter.

Parameters
formalParam the FormalParameter associated with the actual parameter.
Throws
IllegalArgumentException

Protected Methods

protected Class getListClass ()

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

protected String getListNodeName ()

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