resultset.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

</DL>
<HR>

<A NAME="getFirst(int)"><!-- --></A><H3>
getFirst</H3>
<PRE>
public abstract <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A>&gt; <B>getFirst</B>(int&nbsp;maxAmount)</PRE>
<DL>
<DD>Returns the first elements from this result set.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>maxAmount</CODE> - the number of elements to return.
<DT><B>Returns:</B><DD>the last 'maxAmount' elements of this result set.</DL>
</DD>
</DL>
<HR>

<A NAME="getLast(int)"><!-- --></A><H3>
getLast</H3>
<PRE>
public abstract <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A>&gt; <B>getLast</B>(int&nbsp;maxAmount)</PRE>
<DL>
<DD>Returns the last elements from this result set.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>maxAmount</CODE> - the number of elements to return.
<DT><B>Returns:</B><DD>the last 'maxAmount' elements of this result set.</DL>
</DD>
</DL>
<HR>

<A NAME="get(int)"><!-- --></A><H3>
get</H3>
<PRE>
public abstract <A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A> <B>get</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the element denoted by the index.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - Index of the element to be returned
<DT><B>Returns:</B><DD>the Element at 'index'.</DL>
</DD>
</DL>
<HR>

<A NAME="get(int, int)"><!-- --></A><H3>
get</H3>
<PRE>
public abstract <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A>&gt; <B>get</B>(int&nbsp;fromIndex,
                            int&nbsp;maxAmount)</PRE>
<DL>
<DD>Returns a list of results, starting with the result that's at the
 specified index. If the difference between the startIndex and the index
 of the last element in the entire resultset is smaller than the size
 supplied in the 'amount' parameter, the length of the returned list will
 be smaller than the 'amount' paramater. If the supplied index is equal
 to, or larger than the size of the result set, an empty List is returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fromIndex</CODE> - The index of the first element to be returned.<DD><CODE>maxAmount</CODE> - The maximum number of elements to return.
<DT><B>Returns:</B><DD>A list of elements starting with (inclusive) the element
         referenced by 'fromIndex'. An empty List if startIndex is equal
         to or bigger than the size of this entire result set.</DL>
</DD>
</DL>
<HR>

<A NAME="getUID(int)"><!-- --></A><H3>
getUID</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getUID</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the UID of the object at the specified index in this result set.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - The index of the UID to be returned.
<DT><B>Returns:</B><DD>UID of the object on the specified index.</DL>
</DD>
</DL>
<HR>

<A NAME="indexOf(java.lang.String)"><!-- --></A><H3>
indexOf</H3>
<PRE>
public abstract int <B>indexOf</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;uid)</PRE>
<DL>
<DD>Returns the index in the full resultset of the element identified by the
 UID in te supplied argument.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uid</CODE> - The UID of the element to search for
<DT><B>Returns:</B><DD>The index of the element.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang">NullPointerException</A></CODE> - if there is no result in the result set that matches the UID.</DL>
</DD>
</DL>
<HR>

<A NAME="indexOf(org.jivesoftware.openfire.resultsetmanager.Result)"><!-- --></A><A NAME="indexOf(E)"><!-- --></A><H3>
indexOf</H3>
<PRE>
public int <B>indexOf</B>(<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A>&nbsp;element)</PRE>
<DL>
<DD>Returns the index in the full resultset of the supplied argument.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - The element to search for
<DT><B>Returns:</B><DD>The index of the element.</DL>
</DD>
</DL>
<HR>

<A NAME="iterator()"><!-- --></A><H3>
iterator</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A>&gt; <B>iterator</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A> extends <A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/Result.html" title="interface in org.jivesoftware.openfire.resultsetmanager">Result</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#iterator()" title="class or interface in java.util">iterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A> extends <A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/Result.html" title="interface in org.jivesoftware.openfire.resultsetmanager">Result</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/AbstractCollection.html#iterator()" title="class or interface in java.util">iterator</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/AbstractCollection.html" title="class or interface in java.util">AbstractCollection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A> extends <A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/Result.html" title="interface in org.jivesoftware.openfire.resultsetmanager">Result</A>&gt;</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="applyRSMDirectives(org.dom4j.Element)"><!-- --></A><H3>
applyRSMDirectives</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A>&gt; <B>applyRSMDirectives</B>(org.dom4j.Element&nbsp;rsmElement)</PRE>
<DL>
<DD>Applies the 'result set management' directives to this result set, and
 returns a list of Results that matches the directives. Note that the
 orignal set is untouched. Instead, a new List is returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rsmElement</CODE> - The XML element that contains the 'result set management'
            directives.
<DT><B>Returns:</B><DD>a list of Results that matches the directives.</DL>
</DD>
</DL>
<HR>

<A NAME="generateSetElementFromResults(java.util.List)"><!-- --></A><H3>
generateSetElementFromResults</H3>
<PRE>
public org.dom4j.Element <B>generateSetElementFromResults</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html" title="type parameter in ResultSet">E</A>&gt;&nbsp;returnedResults)</PRE>
<DL>
<DD>Generates a Result Set Management 'set' element that describes the parto
 of the result set that was generated. You typically would use the List
 that was returned by <A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSet.html#applyRSMDirectives(org.dom4j.Element)"><CODE>applyRSMDirectives(Element)</CODE></A> as an argument
 to this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>returnedResults</CODE> - The subset of Results that is returned by the current query.
<DT><B>Returns:</B><DD>An Element named 'set' that can be included in the result IQ
         stanza, which returns the subset of results.</DL>
</DD>
</DL>
<HR>

<A NAME="isValidRSMRequest(org.dom4j.Element)"><!-- --></A><H3>
isValidRSMRequest</H3>
<PRE>
public static boolean <B>isValidRSMRequest</B>(org.dom4j.Element&nbsp;rsmElement)</PRE>
<DL>
<DD>Checks if the Element that has been passed as an argument is a valid
 Result Set Management element, in a request context.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rsmElement</CODE> - The Element to check.
<DT><B>Returns:</B><DD>''true'' if this is a valid RSM query representation, ''false''
         otherwise.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<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"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/Result.html" title="interface in org.jivesoftware.openfire.resultsetmanager"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/resultsetmanager/ResultSetImpl.html" title="class in org.jivesoftware.openfire.resultsetmanager"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/resultsetmanager/ResultSet.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ResultSet.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>