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

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

<HTML>
<HEAD>

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

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="ValueCursor (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/cursor/StructureUpdatedException.html" title="class in oracle.olapi.data.cursor">PREV CLASS</A>&nbsp;
&nbsp;NEXT CLASS</TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../index.html?oracle/olapi/data/cursor/ValueCursor.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="ValueCursor.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.cursor
 
Interface ValueCursor</H2>
<DL>
<DT>All Superinterfaces: <DD><A HREF="../../../../oracle/olapi/data/cursor/Cursor.html" title="interface in oracle.olapi.data.cursor">Cursor</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface ValueCursor<DT>extends <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html" title="interface in oracle.olapi.data.cursor">Cursor</A></DL>
</PRE>

A <code>Cursor</code> that has a value at its current position.
 A value can be any of the OLAP API data types or a <code>Source</code>.
 
 The value at the current position of a <code>ValueCursor</code> can also
 be <code>null</code>, in which case the <code>hasCurrentValue</code> method
 returns <code>false</code>.
 An example of a <code>ValueCursor</code> with an element whose value
 is <code>null</code> is the <code>Cursor</code> for a <code>Source</code> that
 was returned by the <code>getVoidSource</code> method of a
 <code>DataProvider</code>.
 Such a <code>Source</code> has one element whose value is <code>null</code>.
 In contrast, a <code>Source</code> returned by the
 <code>getEmptySource</code> method of a <code>DataProvider</code> has
 no elements, so it has no values, not even a <code>null</code> value.
 You cannot create a <code>ValueCursor</code> for an empty <code>Source</code>
 because the result set has no elements.

A <code>ValueCursor</code> can have a single value or many values.
 For a <code>ValueCursor</code> that is a descendent of a
 <code>CompoundCursor</code>, the number of values it has, and therefore
 the number of positions, is specified by the set of values of the slower-varying
 outputs of the <code>CompoundCursor</code>.
 For example, a measure that has three dimensions might have a single value
 for any one set of its selected dimension values.
 If an application creates a query based on the measure and each dimension is an
 output in the query, then the base <code>ValueCursor</code> for the query has a
 single value (and only one position) for each set of values of the outputs.

<HR>

<A NAME="field_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Field Summary</TH>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_oracle.olapi.data.cursor.Cursor"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Fields inherited from interface oracle.olapi.data.cursor.<A HREF="../../../../oracle/olapi/data/cursor/Cursor.html" title="interface in oracle.olapi.data.cursor">Cursor</A></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#FETCH_SIZE_NOT_SPECIFIED">FETCH_SIZE_NOT_SPECIFIED</A></CODE></TD>
</TR>
</TABLE>
&nbsp;

<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>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#getCurrentBoolean()">getCurrentBoolean</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>boolean</code> value at the current position
 in the <code>ValueCursor</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.util.Date</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#getCurrentDate()">getCurrentDate</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>Date</code> value at the current position
 in the <code>ValueCursor</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#getCurrentDouble()">getCurrentDouble</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>double</code> value at the current position
 in the <code>ValueCursor</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;float</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#getCurrentFloat()">getCurrentFloat</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>float</code> value at the current position
 in the <code>ValueCursor</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;int</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#getCurrentInteger()">getCurrentInteger</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>int</code> value at the current position
 in the <code>ValueCursor</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;short</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#getCurrentShort()">getCurrentShort</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>short</code> value at the current position
 in the <code>ValueCursor</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../../oracle/olapi/data/cursor/SourceIdentifier.html" title="interface in oracle.olapi.data.cursor">SourceIdentifier</A></CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#getCurrentSource()">getCurrentSource</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>SourceIdentifier</code> for the
 <code>ValueCursor</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/cursor/ValueCursor.html#getCurrentString()">getCurrentString</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <code>String</code> value at the current position
 in the <code>ValueCursor</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.Object</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#getCurrentValue()">getCurrentValue</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the value at the current position of the <code>ValueCursor</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/ValueCursor.html#hasCurrentValue()">hasCurrentValue</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether the <code>ValueCursor</code> has a value at its
 current position.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_oracle.olapi.data.cursor.Cursor"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Methods inherited from interface oracle.olapi.data.cursor.<A HREF="../../../../oracle/olapi/data/cursor/Cursor.html" title="interface in oracle.olapi.data.cursor">Cursor</A></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#getExtent()">getExtent</A>, <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#getFetchSize()">getFetchSize</A>, <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#getParentEnd()">getParentEnd</A>, <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#getParentStart()">getParentStart</A>, <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#getPosition()">getPosition</A>, <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#getSource()">getSource</A>, <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#next()">next</A>, <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#setFetchSize(int)">setFetchSize</A>, <A HREF="../../../../oracle/olapi/data/cursor/Cursor.html#setPosition(long)">setPosition</A></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="hasCurrentValue()"></A><H3>
hasCurrentValue</H3>
<PRE>
boolean hasCurrentValue()</PRE>
<DL>
<DD>Indicates whether the <code>ValueCursor</code> has a value at its
 current position.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD><code>true</code> if the <code>ValueCursor</code> has a value
 at its current position and
 <code>false</code> if it does not.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentValue()"></A><H3>
getCurrentValue</H3>
<PRE>
java.lang.Object getCurrentValue()</PRE>
<DL>
<DD>Gets the value at the current position of the <code>ValueCursor</code>.
 The value can be a <code>Source</code> or any of the
 specific data types such as <code>boolean</code>, <code>integer</code>, or
 <code>String</code>.
 This method is less efficient than the more specific methods, but
 <code>getCurrentValue</code> can return any value.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The value at the current position.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentBoolean()"></A><H3>
getCurrentBoolean</H3>
<PRE>
boolean getCurrentBoolean()</PRE>
<DL>
<DD>Gets the <code>boolean</code> value at the current position
 in the <code>ValueCursor</code>.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The <code>boolean</code> value at the current position.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentString()"></A><H3>
getCurrentString</H3>
<PRE>
java.lang.String getCurrentString()</PRE>
<DL>
<DD>Gets the <code>String</code> value at the current position
 in the <code>ValueCursor</code>.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The <code>String</code> value at the current position.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentShort()"></A><H3>
getCurrentShort</H3>
<PRE>
short getCurrentShort()</PRE>
<DL>
<DD>Gets the <code>short</code> value at the current position
 in the <code>ValueCursor</code>.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The <code>short</code> value at the current position.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentInteger()"></A><H3>
getCurrentInteger</H3>
<PRE>
int getCurrentInteger()</PRE>
<DL>
<DD>Gets the <code>int</code> value at the current position
 in the <code>ValueCursor</code>.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The <code>int</code> value at the current position.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentFloat()"></A><H3>
getCurrentFloat</H3>
<PRE>
float getCurrentFloat()</PRE>
<DL>
<DD>Gets the <code>float</code> value at the current position
 in the <code>ValueCursor</code>.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The <code>float</code> value at the current position.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentDouble()"></A><H3>
getCurrentDouble</H3>
<PRE>
double getCurrentDouble()</PRE>
<DL>
<DD>Gets the <code>double</code> value at the current position
 in the <code>ValueCursor</code>.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The <code>double</code> value at the current position.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentDate()"></A><H3>
getCurrentDate</H3>
<PRE>
java.util.Date getCurrentDate()</PRE>
<DL>
<DD>Gets the <code>Date</code> value at the current position
 in the <code>ValueCursor</code>.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The <code>Date</code> value at the current position.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentSource()"></A><H3>
getCurrentSource</H3>
<PRE>
<A HREF="../../../../oracle/olapi/data/cursor/SourceIdentifier.html" title="interface in oracle.olapi.data.cursor">SourceIdentifier</A> getCurrentSource()</PRE>
<DL>
<DD>Gets the <code>SourceIdentifier</code> for the
 <code>ValueCursor</code>.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>The <code>SourceIdentifier</code> for the <code>ValueCursor</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