sqlmembersource.html

来自「基于mondrian 开源框架进行OLAP多维分析」· HTML 代码 · 共 1,006 行 · 第 1/5 页

<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="SqlMemberSource(mondrian.rolap.RolapHierarchy)"><!-- --></A><H3>
SqlMemberSource</H3>
<PRE>
<B>SqlMemberSource</B>(<A HREF="../../mondrian/rolap/RolapHierarchy.html" title="class in mondrian.rolap">RolapHierarchy</A>&nbsp;hierarchy)</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<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"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getHierarchy()"><!-- --></A><H3>
getHierarchy</H3>
<PRE>
public <A HREF="../../mondrian/rolap/RolapHierarchy.html" title="class in mondrian.rolap">RolapHierarchy</A> <B>getHierarchy</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberSource.html#getHierarchy()">MemberSource</A></CODE></B></DD>
<DD>Returns the hierarchy that this source is reading for.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberSource.html#getHierarchy()">getHierarchy</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberSource.html" title="interface in mondrian.rolap">MemberSource</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setCache(mondrian.rolap.MemberCache)"><!-- --></A><H3>
setCache</H3>
<PRE>
public boolean <B>setCache</B>(<A HREF="../../mondrian/rolap/MemberCache.html" title="interface in mondrian.rolap">MemberCache</A>&nbsp;cache)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberSource.html#setCache(mondrian.rolap.MemberCache)">MemberSource</A></CODE></B></DD>
<DD>Sets the cache which this <code>MemberSource</code> will write to.

 <p>Cache-writeback is optional (for example, <A HREF="../../mondrian/rolap/SqlMemberSource.html" title="class in mondrian.rolap"><CODE>SqlMemberSource</CODE></A>
 supports it, and <A HREF="../../mondrian/rolap/ArrayMemberSource.html" title="class in mondrian.rolap"><CODE>ArrayMemberSource</CODE></A> does not), and the return
 value from this method indicates whether this object supports it.

 <p>If this method returns <code>true</code>, the <A HREF="../../mondrian/rolap/MemberSource.html#getMembers()"><CODE>MemberSource.getMembers()</CODE></A>,
 <A HREF="../../mondrian/rolap/MemberSource.html#getRootMembers()"><CODE>MemberSource.getRootMembers()</CODE></A> and <A HREF="../../mondrian/rolap/MemberSource.html#getMemberChildren(mondrian.rolap.RolapMember, java.util.List)"><CODE>MemberSource.getMemberChildren(mondrian.rolap.RolapMember, java.util.List<mondrian.rolap.RolapMember>)</CODE></A> methods must
 write to the cache, in addition to returning members as a return value.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberSource.html#setCache(mondrian.rolap.MemberCache)">setCache</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberSource.html" title="interface in mondrian.rolap">MemberSource</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cache</CODE> - The <code>MemberCache</code> which the caller would like
   this <code>MemberSource</code> to write to.
<DT><B>Returns:</B><DD>Whether this <code>MemberSource</code> supports cache-writeback.</DL>
</DD>
</DL>
<HR>

<A NAME="getMemberCount()"><!-- --></A><H3>
getMemberCount</H3>
<PRE>
public int <B>getMemberCount</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberSource.html#getMemberCount()">MemberSource</A></CODE></B></DD>
<DD>Returns an estimate of number of members in this hierarchy.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberSource.html#getMemberCount()">getMemberCount</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberSource.html" title="interface in mondrian.rolap">MemberSource</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="substitute(mondrian.rolap.RolapMember)"><!-- --></A><H3>
substitute</H3>
<PRE>
public <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A> <B>substitute</B>(<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;member)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberReader.html#substitute(mondrian.rolap.RolapMember)">MemberReader</A></CODE></B></DD>
<DD>Substitutes a given member.
 If member is null, returns null.

 <p>This method is called whenever a member is returned from the wrapped
 member reader and is to be returned to the caller. You could say that it
 translates 'to caller space'.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberReader.html#substitute(mondrian.rolap.RolapMember)">substitute</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberReader.html" title="interface in mondrian.rolap">MemberReader</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>member</CODE> - Member
<DT><B>Returns:</B><DD>Substitute member</DL>
</DD>
</DL>
<HR>

<A NAME="desubstitute(mondrian.rolap.RolapMember)"><!-- --></A><H3>
desubstitute</H3>
<PRE>
public <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A> <B>desubstitute</B>(<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;member)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberReader.html#desubstitute(mondrian.rolap.RolapMember)">MemberReader</A></CODE></B></DD>
<DD>Returns the member which was substituted.
 If member is null, returns null.

 <p>This method is called whenever the caller passes a member into a
 method and needs to be passed to a method on the wrapped member reader.
 You could say that it translates 'from caller space'.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberReader.html#desubstitute(mondrian.rolap.RolapMember)">desubstitute</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberReader.html" title="interface in mondrian.rolap">MemberReader</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>member</CODE> - Member
<DT><B>Returns:</B><DD>Internal member</DL>
</DD>
</DL>
<HR>

<A NAME="lookupMember(java.util.List, boolean)"><!-- --></A><H3>
lookupMember</H3>
<PRE>
public <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A> <B>lookupMember</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../mondrian/olap/Id.Segment.html" title="class in mondrian.olap">Id.Segment</A>&gt;&nbsp;uniqueNameParts,
                                boolean&nbsp;failIfNotFound)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberSource.html#lookupMember(java.util.List, boolean)">MemberSource</A></CODE></B></DD>
<DD>Finds a member based upon its unique name.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberSource.html#lookupMember(java.util.List, boolean)">lookupMember</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberSource.html" title="interface in mondrian.rolap">MemberSource</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLevelMemberCount(mondrian.rolap.RolapLevel)"><!-- --></A><H3>
getLevelMemberCount</H3>
<PRE>
public int <B>getLevelMemberCount</B>(<A HREF="../../mondrian/rolap/RolapLevel.html" title="class in mondrian.rolap">RolapLevel</A>&nbsp;level)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberReader.html#getLevelMemberCount(mondrian.rolap.RolapLevel)">MemberReader</A></CODE></B></DD>
<DD>Returns the number of members in this level.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberReader.html#getLevelMemberCount(mondrian.rolap.RolapLevel)">getLevelMemberCount</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberReader.html" title="interface in mondrian.rolap">MemberReader</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>level</CODE> - Level
<DT><B>Returns:</B><DD>number of members in level</DL>
</DD>
</DL>
<HR>

<A NAME="getMembers()"><!-- --></A><H3>
getMembers</H3>
<PRE>
public <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>[] <B>getMembers</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberSource.html#getMembers()">MemberSource</A></CODE></B></DD>
<DD>Returns all members of this hierarchy, sorted by ordinal.

 <p>If this object <A HREF="../../mondrian/rolap/MemberSource.html#setCache(mondrian.rolap.MemberCache)"><CODE>supports cache-writeaback</CODE></A>, also
 writes these members to the cache.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberSource.html#getMembers()">getMembers</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberSource.html" title="interface in mondrian.rolap">MemberSource</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMembersInLevel(mondrian.rolap.RolapLevel, int, int)"><!-- --></A><H3>
getMembersInLevel</H3>
<PRE>
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&gt; <B>getMembersInLevel</B>(<A HREF="../../mondrian/rolap/RolapLevel.html" title="class in mondrian.rolap">RolapLevel</A>&nbsp;level,
                                           int&nbsp;startOrdinal,
                                           int&nbsp;endOrdinal)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberReader.html#getMembersInLevel(mondrian.rolap.RolapLevel, int, int)">MemberReader</A></CODE></B></DD>
<DD>Returns all of the members in <code>level</code> whose ordinal lies
 between <code>startOrdinal</code> and <code>endOrdinal</code>.

 <p>If this object
 <A HREF="../../mondrian/rolap/MemberSource.html#setCache(mondrian.rolap.MemberCache)"><CODE>supports cache-writeback</CODE></A>, also
 writes these members to the cache.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberReader.html#getMembersInLevel(mondrian.rolap.RolapLevel, int, int)">getMembersInLevel</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberReader.html" title="interface in mondrian.rolap">MemberReader</A></CODE></DL>