cachememberreader.html

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

<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/CacheMemberReader.html#putChildren(mondrian.rolap.RolapMember, mondrian.rolap.sql.MemberChildrenConstraint, java.util.List)">putChildren</A></B>(<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;member,
            <A HREF="../../mondrian/rolap/sql/MemberChildrenConstraint.html" title="interface in mondrian.rolap.sql">MemberChildrenConstraint</A>&nbsp;constraint,
            <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;&nbsp;children)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers that the children of <code>member</code> are
 <code>children</code> (a list of <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap"><CODE>RolapMember</CODE></A>s).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/CacheMemberReader.html#putMember(java.lang.Object, mondrian.rolap.RolapMember)">putMember</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key,
          <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap"><CODE>RolapMember</CODE></A> with a given key and returns the
 previous member if any.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/CacheMemberReader.html#removeMember(java.lang.Object)">removeMember</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap"><CODE>RolapMember</CODE></A> with a given key from the cache.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/CacheMemberReader.html#removeMemberAndDescendants(java.lang.Object)">removeMemberAndDescendants</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the designated <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap"><CODE>RolapMember</CODE></A> and all its descendants.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/CacheMemberReader.html#setCache(mondrian.rolap.MemberCache)">setCache</A></B>(<A HREF="../../mondrian/rolap/MemberCache.html" title="interface in mondrian.rolap">MemberCache</A>&nbsp;cache)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the cache which this <code>MemberSource</code> will write to.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/CacheMemberReader.html#substitute(mondrian.rolap.RolapMember)">substitute</A></B>(<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;member)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Substitutes a given member.</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"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="CacheMemberReader(mondrian.rolap.MemberSource)"><!-- --></A><H3>
CacheMemberReader</H3>
<PRE>
<B>CacheMemberReader</B>(<A HREF="../../mondrian/rolap/MemberSource.html" title="interface in mondrian.rolap">MemberSource</A>&nbsp;source)</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="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="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