keytogroupmap.html

jfreechart1。0。2的api。

<DD>Creates a new map with a default group named 'Default Group'.
<P>
</DL>
<HR>

<A NAME="KeyToGroupMap(java.lang.Comparable)"><!-- --></A><H3>
KeyToGroupMap</H3>
<PRE>
public <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.91"><B>KeyToGroupMap</B></A>(java.lang.Comparable&nbsp;defaultGroup)</PRE>
<DL>
<DD>Creates a new map with the specified default group.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>defaultGroup</CODE> - the default group (<code>null</code> not permitted).</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="getGroupCount()"><!-- --></A><H3>
getGroupCount</H3>
<PRE>
public int <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.105"><B>getGroupCount</B></A>()</PRE>
<DL>
<DD>Returns the number of groups in the map.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The number of groups in the map.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroups()"><!-- --></A><H3>
getGroups</H3>
<PRE>
public java.util.List <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.116"><B>getGroups</B></A>()</PRE>
<DL>
<DD>Returns a list of the groups (always including the default group) in the 
 map.  The returned list is independent of the map, so altering the list 
 will have no effect.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The groups (never <code>null</code>).</DL>
</DD>
</DL>
<HR>

<A NAME="getGroupIndex(java.lang.Comparable)"><!-- --></A><H3>
getGroupIndex</H3>
<PRE>
public int <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.137"><B>getGroupIndex</B></A>(java.lang.Comparable&nbsp;group)</PRE>
<DL>
<DD>Returns the index for the group.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group.
<DT><B>Returns:</B><DD>The group index (or -1 if the group is not represented within 
         the map).</DL>
</DD>
</DL>
<HR>

<A NAME="getGroup(java.lang.Comparable)"><!-- --></A><H3>
getGroup</H3>
<PRE>
public java.lang.Comparable <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.158"><B>getGroup</B></A>(java.lang.Comparable&nbsp;key)</PRE>
<DL>
<DD>Returns the group that a key is mapped to.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key (<code>null</code> not permitted).
<DT><B>Returns:</B><DD>The group (never <code>null</code>, returns the default group if
         there is no mapping for the specified key).</DL>
</DD>
</DL>
<HR>

<A NAME="mapKeyToGroup(java.lang.Comparable, java.lang.Comparable)"><!-- --></A><H3>
mapKeyToGroup</H3>
<PRE>
public void <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.177"><B>mapKeyToGroup</B></A>(java.lang.Comparable&nbsp;key,
                          java.lang.Comparable&nbsp;group)</PRE>
<DL>
<DD>Maps a key to a group.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key (<code>null</code> not permitted).<DD><CODE>group</CODE> - the group (<code>null</code> permitted, clears any 
               existing mapping).</DL>
</DD>
</DL>
<HR>

<A NAME="getKeyCount(java.lang.Comparable)"><!-- --></A><H3>
getKeyCount</H3>
<PRE>
public int <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.212"><B>getKeyCount</B></A>(java.lang.Comparable&nbsp;group)</PRE>
<DL>
<DD>Returns the number of keys mapped to the specified group.  This method 
 won't always return an accurate result for the default group, since 
 explicit mappings are not required for this group.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group (<code>null</code> not permitted).
<DT><B>Returns:</B><DD>The key count.</DL>
</DD>
</DL>
<HR>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.234"><B>equals</B></A>(java.lang.Object&nbsp;obj)</PRE>
<DL>
<DD>Tests the map for equality against an arbitrary object.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to test against (<code>null</code> permitted).
<DT><B>Returns:</B><DD>A boolean.</DL>
</DD>
</DL>
<HR>

<A NAME="clone()"><!-- --></A><H3>
clone</H3>
<PRE>
public java.lang.Object <A HREF="../../../src-html/org/jfree/data/KeyToGroupMap.html#line.259"><B>clone</B></A>()
                       throws java.lang.CloneNotSupportedException</PRE>
<DL>
<DD>Returns a clone of the map.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>clone</CODE> in interface <CODE>org.jfree.util.PublicCloneable</CODE><DT><B>Overrides:</B><DD><CODE>clone</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A clone.
<DT><B>Throws:</B>
<DD><CODE>java.lang.CloneNotSupportedException</CODE> - if there is a problem cloning the
                                     map.</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="class-use/KeyToGroupMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-files/index-1.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>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/jfree/data/KeyedValues2D.html" title="interface in org.jfree.data"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/jfree/data/Range.html" title="class in org.jfree.data"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/jfree/data/KeyToGroupMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="KeyToGroupMap.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;FIELD&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;FIELD&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>

</BODY>
</HTML>