Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2.0.4)

B14351-04

oracle.AWXML
Class ConfigurationParameters

java.lang.Object
  extended byoracle.AWXML.BaseObject
      extended byoracle.AWXML.AggregationArgument
          extended byoracle.AWXML.ConfigurationParameters

public class ConfigurationParameters
extends AggregationArgument

An object that contains one or more parameters that affect an aggregation operation. Each parameter is represented by a Parameter object. A Parameter for an aggregation operation has a keyword and a value.

ConfigurationParameters is a concrete subclass of the abstract AggregationArgument. An AggregationArgument is owned by an Aggregation. The Aggregation also owns an AggregationOperator, which specifies the type of aggregation operation, such as an average or a sum operation.

See Also:
Aggregation, Parameter

Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
ConfigurationParameters(BaseObject input)
          Creates a new ConfigurationParameters object for the specified AggregationArgument.
 
Method Summary
 void addParameter(Parameter input)
          Adds the specified Parameter to the ConfigurationParameters.
 Parameter createParameter()
          Creates a new Parameter and adds it to the ConfigurationParameters.
 java.util.Vector getParameters()
          Gets a list of the Parameter objects that are owned by the ConfigurationParameters.
 void removeParameter(Parameter input)
          Removes the specified Parameter from the ConfigurationParameters.
 java.lang.String WriteToXML()
          Gets an XML representation of the ConfigurationParameters.
 
Methods inherited from class oracle.AWXML.BaseObject
Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfigurationParameters

public ConfigurationParameters(BaseObject input)
Creates a new ConfigurationParameters object for the specified AggregationArgument. An application should create a ConfigurationParameters by using the createConfigurationParameters method of the Aggregation.

Parameters:
input - The AggregationArgument to own the new ConfigurationParameters.
Method Detail

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the ConfigurationParameters.

Overrides:
WriteToXML in class AggregationArgument
Returns:
An XML String that represents the ConfigurationParameters.

addParameter

public void addParameter(Parameter input)
Adds the specified Parameter to the ConfigurationParameters.

Parameters:
input - The Parameter to add.

removeParameter

public void removeParameter(Parameter input)
Removes the specified Parameter from the ConfigurationParameters.

Parameters:
input - The Parameter to remove.

getParameters

public java.util.Vector getParameters()
Gets a list of the Parameter objects that are owned by the ConfigurationParameters.

Returns:
A Vector of the Parameter objects that are owned by the ConfigurationParameters.

createParameter

public Parameter createParameter()
Creates a new Parameter and adds it to the ConfigurationParameters.

Returns:
The new Parameter for the ConfigurationParameters.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2.0.4)

B14351-04

Copyright © 2003, 2007 Oracle. All rights reserved.