oracle.AWXML
Class Parameter

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Parameter

public class Parameter

extends BaseObject

A configuration setting used in an argument to an Aggregation or an Allocation.

Parameter objects can be grouped in a ConfigurationParameters object and used as the AggregationArgument for an Aggregation, or they can be grouped in an AllocationArgument for an Allocation.

Parameter objects specify keyword-value pairs.

Parameter keywords for aggregation are:

   DIVIDEBYZERO           
   DECIMALOVERFLOW           
   NASKIP
   WEIGHTBY 

Parameter keywords for allocation are:

      DIM_VSET
      FLOOR
      CEILING
      MIN
      MAX
      NAHANDLE
      ADD
      ASSIGN
      PROTECTLIST
      NORMALIZE
      READWRITE
      WRITE
      WEIGHTBY
      MULITPLY
      WNAFILL
   

For complete descriptions of these parameters, see "RELATION (for aggregation)" and "RELATION (for allocation)" in the OLAP DML Reference.

See Also:

AggregationDefinition, AllocationDefinition

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

Parameter(BaseObject input)
Creates a new Parameter for the specified ConfigurationParameters or AllocationArgument.

Method Summary

java.lang.String	getKeyWord() Returns the parameter keyword.
java.lang.String	getValue() Returns the value of the parameter.
void	setKeyWord(java.lang.String input) Sets the parameter keyword to the specified String.
void	setValue(java.lang.String input) Sets the value of the parameter to the specified String.
java.lang.String	WriteToXML() Returns the Parameter as an XML string.

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

Parameter

public Parameter(BaseObject input)

Creates a new Parameter for the specified ConfigurationParameters or AllocationArgument.

Parameters:

input - The ConfigurationParameters or AllocationArgument that owns the Parameter.

Method Detail

WriteToXML

public java.lang.String WriteToXML()

Returns the Parameter as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the Parameter.

setKeyWord

public void setKeyWord(java.lang.String input)

Sets the parameter keyword to the specified String.

Parameters:

input - The name of the keyword.

getKeyWord

public java.lang.String getKeyWord()

Returns the parameter keyword.

Returns:

The name of the keyword.

setValue

public void setValue(java.lang.String input)

Sets the value of the parameter to the specified String.

Parameters:

input - The text value of the parameter.

getValue

public java.lang.String getValue()

Returns the value of the parameter.

Returns:

The text value of the parameter.