Edit D:\app\Administrator\product\11.2.0\dbhome_1\olap\api\doc\oracle\olapi\data\source\Parameter.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
Parameter (Oracle OLAP Java API Reference)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="Parameter (Oracle OLAP Java API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Oracle&reg; OLAP Java API Reference 11g Release 2 (11.2) E10794-01 Beta Draft
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../../oracle/olapi/data/source/NumberSource.html" title="class in oracle.olapi.data.source">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../../oracle/olapi/data/source/ParameterVisitor.html" title="class in oracle.olapi.data.source">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../index.html?oracle/olapi/data/source/Parameter.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="Parameter.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

oracle.olapi.data.source
 
Class Parameter</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">oracle.olapi.data.source.Parameter
</PRE>
<DL>
<DT>Direct Known Subclasses: <DD><A HREF="../../../../oracle/olapi/data/source/BooleanParameter.html" title="class in oracle.olapi.data.source">BooleanParameter</A>, <A HREF="../../../../oracle/olapi/data/source/DateParameter.html" title="class in oracle.olapi.data.source">DateParameter</A>, <A HREF="../../../../oracle/olapi/data/source/NumberParameter.html" title="class in oracle.olapi.data.source">NumberParameter</A>, <A HREF="../../../../oracle/olapi/data/source/StringParameter.html" title="class in oracle.olapi.data.source">StringParameter</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class Parameter<DT>extends java.lang.Object</DL>
</PRE>

An object that specifies a value that you use in creating a query.
 After creating the query, you can change the value of the
 <CODE>Parameter</CODE> and thereby change the selection of dimension
 or measure elements that the query represents.

The <CODE>createSource</CODE> method of a <CODE>Parameter</CODE> creates a
 parameterized <CODE>Source</CODE>.
 You then use the parameterized <CODE>Source</CODE> as a parameter to a method
 that selects one or more elements of another <CODE>Source</CODE> and
 produces a derived <CODE>Source</CODE>.
 You can create a <CODE>Cursor</CODE> for the <CODE>Source</CODE> to retrieve 
 the results of the query.

You can change the selection of elements that the derived
 <CODE>Source</CODE> represents with the <CODE>setValue</CODE> method
 of a concrete subclass of <CODE>Parameter</CODE>.
 The <CODE>Cursor</CODE> for the query <CODE>Source</CODE> then has the values
 of the new selection.
 You do not need to create a new <CODE>Cursor</CODE>.
 You can instead just get the values for the new selection from the existing
 <CODE>Cursor</CODE>.

<HR>

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>abstract &nbsp;java.lang.Object</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Parameter.html#acceptVisitor(oracle.olapi.data.source.ParameterVisitor, java.lang.Object)">acceptVisitor</A>(<A HREF="../../../../oracle/olapi/data/source/ParameterVisitor.html" title="class in oracle.olapi.data.source">ParameterVisitor</A>&nbsp;visitor,
 java.lang.Object&nbsp;context)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calls the appropriate method of the specified
 <CODE>ParameterVisitor</CODE> and passes that method the
 <CODE>Parameter</CODE> and the specified context
 <CODE>Object</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A></CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Parameter.html#createSource()">createSource</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <CODE>Source</CODE> of the appropriate data type that 
 contains the value specified for the <CODE>Parameter</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A></CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Parameter.html#getDataProvider()">getDataProvider</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <CODE>DataProvider</CODE> for this <CODE>Parameter</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Parameter.html#getID()">getID</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a <CODE>String</CODE> that uniquely identifies this
 <CODE>Parameter</CODE> during this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>abstract &nbsp;java.lang.Object</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Parameter.html#getValueObject()">getValueObject</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets an <CODE>Object</CODE> that contains the value for this
 <CODE>Parameter</CODE>.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Methods inherited from class java.lang.Object</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="acceptVisitor(oracle.olapi.data.source.ParameterVisitor, java.lang.Object)"></A><H3>
acceptVisitor</H3>
<PRE>
public abstract java.lang.Object acceptVisitor(<A HREF="../../../../oracle/olapi/data/source/ParameterVisitor.html" title="class in oracle.olapi.data.source">ParameterVisitor</A>&nbsp;visitor,
 java.lang.Object&nbsp;context)</PRE>
<DL>
<DD>Calls the appropriate method of the specified
 <CODE>ParameterVisitor</CODE> and passes that method the
 <CODE>Parameter</CODE> and the specified context
 <CODE>Object</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>visitor</CODE> - An instance a class derived from the
 <CODE>ParameterVisitor</CODE> class.<DD><CODE>context</CODE> - An <CODE>Object</CODE>.
<DT>Returns:<DD>The <CODE>Object</CODE> returned by the appropriate method of
 the specified <CODE>ParameterVisitor</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="getDataProvider()"></A><H3>
getDataProvider</H3>
<PRE>
public final <A HREF="../../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A> getDataProvider()</PRE>
<DL>
<DD>Gets the <CODE>DataProvider</CODE> for this <CODE>Parameter</CODE>.

<DD><DL>

<DT>Returns:<DD>The <CODE>DataProvider</CODE> for this <CODE>Parameter</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="getID()"></A><H3>
getID</H3>
<PRE>
public final java.lang.String getID()</PRE>
<DL>
<DD>Gets a <CODE>String</CODE> that uniquely identifies this
 <CODE>Parameter</CODE> during this connection.

<DD><DL>

<DT>Returns:<DD>A <CODE>String</CODE> that uniquely identifies this
 <CODE>Parameter</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="getValueObject()"></A><H3>
getValueObject</H3>
<PRE>
public abstract java.lang.Object getValueObject()</PRE>
<DL>
<DD>Gets an <CODE>Object</CODE> that contains the value for this
 <CODE>Parameter</CODE>.

<DD><DL>

<DT>Returns:<DD>An <CODE>Object</CODE> that contains the value for this
 <CODE>Parameter</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="createSource()"></A><H3>
createSource</H3>
<PRE>
public <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> createSource()</PRE>
<DL>
<DD>Creates a <CODE>Source</CODE> of the appropriate data type that 
 contains the value specified for the <CODE>Parameter</CODE>.
 The concrete subclasses of <CODE>Parameter</CODE> have constructors that
 take an initial value.
 An application can specify a different value by calling the 
 <CODE>setValue</CODE> of the subclass.

<DD><DL>

<DT>Returns:<DD>The <CODE>Source</CODE> associated with the <CODE>Parameter</CODE>.</DL>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
<center>Copyright &copy; 2002, 2009, Oracle. All rights reserved.</center>
</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de