restrictedmemberreader.html

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

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes all children <code>parentMember</code> to <code>children</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/RestrictedMemberReader.html#getMemberChildren(mondrian.rolap.RolapMember, java.util.List, mondrian.rolap.sql.MemberChildrenConstraint)">getMemberChildren</A></B>(<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;parentMember,
                  <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,
                  <A HREF="../../mondrian/rolap/sql/MemberChildrenConstraint.html" title="interface in mondrian.rolap.sql">MemberChildrenConstraint</A>&nbsp;constraint)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Populates a list of the children of a Member, optionally applying a
 constraint.</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/RestrictedMemberReader.html#getMemberParent(mondrian.rolap.RolapMember)">getMemberParent</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;&nbsp;</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/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;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/RestrictedMemberReader.html#getMembersInLevel(mondrian.rolap.RolapLevel, int, int)">getMembersInLevel</A></B>(<A HREF="../../mondrian/rolap/RolapLevel.html" title="class in mondrian.rolap">RolapLevel</A>&nbsp;level,
                  int&nbsp;startOrdinal,
                  int&nbsp;endOrdinal)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all of the members in <code>level</code> whose ordinal lies
 between <code>startOrdinal</code> and <code>endOrdinal</code>.</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/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;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/RestrictedMemberReader.html#getMembersInLevel(mondrian.rolap.RolapLevel, int, int, mondrian.rolap.sql.TupleConstraint)">getMembersInLevel</A></B>(<A HREF="../../mondrian/rolap/RolapLevel.html" title="class in mondrian.rolap">RolapLevel</A>&nbsp;level,
                  int&nbsp;startOrdinal,
                  int&nbsp;endOrdinal,
                  <A HREF="../../mondrian/rolap/sql/TupleConstraint.html" title="interface in mondrian.rolap.sql">TupleConstraint</A>&nbsp;constraint)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the members in the given Level, optionally between a range
 of ordinals and applying a constraint.</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/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;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../mondrian/rolap/RestrictedMemberReader.html#getRootMembers()">getRootMembers</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all members of this hierarchy which do not have a parent,
 sorted by ordinal.</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/RestrictedMemberReader.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>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_mondrian.rolap.DelegatingMemberReader"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class mondrian.rolap.<A HREF="../../mondrian/rolap/DelegatingMemberReader.html" title="class in mondrian.rolap">DelegatingMemberReader</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html#compare(mondrian.rolap.RolapMember, mondrian.rolap.RolapMember, boolean)">compare</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#desubstitute(mondrian.rolap.RolapMember)">desubstitute</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getHierarchy()">getHierarchy</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getLevelMemberCount(mondrian.rolap.RolapLevel)">getLevelMemberCount</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getMemberBuilder()">getMemberBuilder</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getMemberCount()">getMemberCount</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getMemberRange(mondrian.rolap.RolapLevel, mondrian.rolap.RolapMember, mondrian.rolap.RolapMember, java.util.List)">getMemberRange</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getMembers()">getMembers</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#lookupMember(java.util.List, boolean)">lookupMember</A>, <A HREF="../../mondrian/rolap/DelegatingMemberReader.html#substitute(mondrian.rolap.RolapMember)">substitute</A></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"><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="RestrictedMemberReader(mondrian.rolap.MemberReader, mondrian.olap.Role)"><!-- --></A><H3>
RestrictedMemberReader</H3>
<PRE>
<B>RestrictedMemberReader</B>(<A HREF="../../mondrian/rolap/MemberReader.html" title="interface in mondrian.rolap">MemberReader</A>&nbsp;memberReader,
                       <A HREF="../../mondrian/olap/Role.html" title="interface in mondrian.olap">Role</A>&nbsp;role)</PRE>
<DL>
<DD>Creates a <code>RestrictedMemberReader</code>.

 <p>There's no filtering to be done unless
 either the role has restrictions on this hierarchy,
 or the hierarchy is ragged; there's a pre-condition to this effect.</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>memberReader</CODE> - Underlying (presumably unrestricted) member reader<DD><CODE>role</CODE> - Role whose access profile to obey. The role must have
   restrictions on this hierarchy<DT><B>Pre-condition:</B></DT>
  <DD>role.getAccessDetails(memberReader.getHierarchy()) != null ||
   memberReader.getHierarchy().isRagged()</DD>
</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="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><DT><B>Overrides:</B><DD><CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html#setCache(mondrian.rolap.MemberCache)">setCache</A></CODE> in class <CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html" title="class in mondrian.rolap">DelegatingMemberReader</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="getLeadMember(mondrian.rolap.RolapMember, int)"><!-- --></A><H3>
getLeadMember</H3>
<PRE>
public <A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A> <B>getLeadMember</B>(<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;member,
                                 int&nbsp;n)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberReader.html#getLeadMember(mondrian.rolap.RolapMember, int)">MemberReader</A></CODE></B></DD>
<DD>Returns the member <code>n</code> after <code>member</code> in the same
 level (or before, if <code>n</code> is negative).
 Returns <A HREF="../../mondrian/olap/Hierarchy.html#getNullMember()"><CODE>Hierarchy.getNullMember()</CODE></A> if we run off the beginning or
 end of the level.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberReader.html#getLeadMember(mondrian.rolap.RolapMember, int)">getLeadMember</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberReader.html" title="interface in mondrian.rolap">MemberReader</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getLeadMember(mondrian.rolap.RolapMember, int)">getLeadMember</A></CODE> in class <CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html" title="class in mondrian.rolap">DelegatingMemberReader</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMemberChildren(mondrian.rolap.RolapMember, java.util.List)"><!-- --></A><H3>
getMemberChildren</H3>
<PRE>
public void <B>getMemberChildren</B>(<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;parentMember,
                              <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)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberSource.html#getMemberChildren(mondrian.rolap.RolapMember, java.util.List)">MemberSource</A></CODE></B></DD>
<DD>Writes all children <code>parentMember</code> to <code>children</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/MemberSource.html#getMemberChildren(mondrian.rolap.RolapMember, java.util.List)">getMemberChildren</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberSource.html" title="interface in mondrian.rolap">MemberSource</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getMemberChildren(mondrian.rolap.RolapMember, java.util.List)">getMemberChildren</A></CODE> in class <CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html" title="class in mondrian.rolap">DelegatingMemberReader</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMemberChildren(mondrian.rolap.RolapMember, java.util.List, mondrian.rolap.sql.MemberChildrenConstraint)"><!-- --></A><H3>
getMemberChildren</H3>
<PRE>
public void <B>getMemberChildren</B>(<A HREF="../../mondrian/rolap/RolapMember.html" title="class in mondrian.rolap">RolapMember</A>&nbsp;parentMember,
                              <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,
                              <A HREF="../../mondrian/rolap/sql/MemberChildrenConstraint.html" title="interface in mondrian.rolap.sql">MemberChildrenConstraint</A>&nbsp;constraint)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../mondrian/rolap/MemberReader.html#getMemberChildren(mondrian.rolap.RolapMember, java.util.List, mondrian.rolap.sql.MemberChildrenConstraint)">MemberReader</A></CODE></B></DD>
<DD>Populates a list of the children of a Member, optionally applying a
 constraint.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../mondrian/rolap/MemberReader.html#getMemberChildren(mondrian.rolap.RolapMember, java.util.List, mondrian.rolap.sql.MemberChildrenConstraint)">getMemberChildren</A></CODE> in interface <CODE><A HREF="../../mondrian/rolap/MemberReader.html" title="interface in mondrian.rolap">MemberReader</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html#getMemberChildren(mondrian.rolap.RolapMember, java.util.List, mondrian.rolap.sql.MemberChildrenConstraint)">getMemberChildren</A></CODE> in class <CODE><A HREF="../../mondrian/rolap/DelegatingMemberReader.html" title="class in mondrian.rolap">DelegatingMemberReader</A></CODE></DL>
</DD>
<DD><DL>