123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:42 CEST 2014 -->
- <title>KeyedValues (JFreeChart Class Library (version 1.0.19-fx))</title>
- <meta name="date" content="2014-07-31">
- <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="KeyedValues (JFreeChart Class Library (version 1.0.19-fx))";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/KeyedValues.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../org/jfree/data/KeyedValues2D.html" title="interface in org.jfree.data"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?org/jfree/data/KeyedValues.html" target="_top">Frames</a></li>
- <li><a href="KeyedValues.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.jfree.data</div>
- <h2 title="Interface KeyedValues" class="title">Interface KeyedValues</h2>
- </div>
- <div class="contentContainer">
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Superinterfaces:</dt>
- <dd><a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a></dd>
- </dl>
- <dl>
- <dt>All Known Subinterfaces:</dt>
- <dd><a href="../../../org/jfree/data/general/KeyedValuesDataset.html" title="interface in org.jfree.data.general">KeyedValuesDataset</a>, <a href="../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a></dd>
- </dl>
- <dl>
- <dt>All Known Implementing Classes:</dt>
- <dd><a href="../../../org/jfree/data/category/CategoryToPieDataset.html" title="class in org.jfree.data.category">CategoryToPieDataset</a>, <a href="../../../org/jfree/data/DefaultKeyedValues.html" title="class in org.jfree.data">DefaultKeyedValues</a>, <a href="../../../org/jfree/data/general/DefaultKeyedValuesDataset.html" title="class in org.jfree.data.general">DefaultKeyedValuesDataset</a>, <a href="../../../org/jfree/data/general/DefaultPieDataset.html" title="class in org.jfree.data.general">DefaultPieDataset</a>, <a href="../../../org/jfree/data/jdbc/JDBCPieDataset.html" title="class in org.jfree.data.jdbc">JDBCPieDataset</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public interface <a href="../../../src-html/org/jfree/data/KeyedValues.html#line.56">KeyedValues</a>
- extends <a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a></pre>
- <div class="block">An ordered list of (key, value) items where the keys are unique and
- non-<code>null</code>.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data"><code>Values</code></a>,
- <a href="../../../org/jfree/data/DefaultKeyedValues.html" title="class in org.jfree.data"><code>DefaultKeyedValues</code></a></dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues.html#getIndex-java.lang.Comparable-">getIndex</a></span>(java.lang.Comparable key)</code>
- <div class="block">Returns the index for a given key.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>java.lang.Comparable</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues.html#getKey-int-">getKey</a></span>(int index)</code>
- <div class="block">Returns the key associated with the item at a given position.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>java.util.List</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues.html#getKeys--">getKeys</a></span>()</code>
- <div class="block">Returns the keys for the values in the collection.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>java.lang.Number</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues.html#getValue-java.lang.Comparable-">getValue</a></span>(java.lang.Comparable key)</code>
- <div class="block">Returns the value for a given key.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.org.jfree.data.Values">
- <!-- -->
- </a>
- <h3>Methods inherited from interface org.jfree.data.<a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a></h3>
- <code><a href="../../../org/jfree/data/Values.html#getItemCount--">getItemCount</a>, <a href="../../../org/jfree/data/Values.html#getValue-int-">getValue</a></code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getKey-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getKey</h4>
- <pre>java.lang.Comparable <a href="../../../src-html/org/jfree/data/KeyedValues.html#line.71">getKey</a>(int index)</pre>
- <div class="block">Returns the key associated with the item at a given position. Note
- that some implementations allow re-ordering of the data items, so the
- result may be transient.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>index</code> - the item index (in the range <code>0</code> to
- <code>getItemCount() - 1</code>).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The key (never <code>null</code>).</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>index</code> is not in the
- specified range.</dd>
- </dl>
- </li>
- </ul>
- <a name="getIndex-java.lang.Comparable-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getIndex</h4>
- <pre>int <a href="../../../src-html/org/jfree/data/KeyedValues.html#line.83">getIndex</a>(java.lang.Comparable key)</pre>
- <div class="block">Returns the index for a given key.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The index, or <code>-1</code> if the key is unrecognised.</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code>java.lang.IllegalArgumentException</code> - if <code>key</code> is
- <code>null</code>.</dd>
- </dl>
- </li>
- </ul>
- <a name="getKeys--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getKeys</h4>
- <pre>java.util.List <a href="../../../src-html/org/jfree/data/KeyedValues.html#line.93">getKeys</a>()</pre>
- <div class="block">Returns the keys for the values in the collection. Note that you can
- access the values in this collection by key or by index. For this
- reason, the key order is important - this method should return the keys
- in order. The returned list may be unmodifiable.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The keys (never <code>null</code>).</dd>
- </dl>
- </li>
- </ul>
- <a name="getValue-java.lang.Comparable-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>getValue</h4>
- <pre>java.lang.Number <a href="../../../src-html/org/jfree/data/KeyedValues.html#line.104">getValue</a>(java.lang.Comparable key)</pre>
- <div class="block">Returns the value for a given key.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>key</code> - the key.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The value (possibly <code>null</code>).</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="../../../org/jfree/data/UnknownKeyException.html" title="class in org.jfree.data">UnknownKeyException</a></code> - if the key is not recognised.</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/KeyedValues.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../org/jfree/data/KeyedValues2D.html" title="interface in org.jfree.data"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?org/jfree/data/KeyedValues.html" target="_top">Frames</a></li>
- <li><a href="KeyedValues.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|