| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/AggregationRecord.html |
<!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 -->
<title>AggregationRecord</title>
<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="AggregationRecord";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AggregationRecord.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-all.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/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/AggregationRecord.html" target="_top">Frames</a></li>
<li><a href="AggregationRecord.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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.opensolaris.os.dtrace</div>
<h2 title="Class AggregationRecord" class="title">Class AggregationRecord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.AggregationRecord</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">AggregationRecord</span>
extends java.lang.Object
implements <a href="../../../../org/opensolaris/os/dtrace/Record.html" title="interface in org.opensolaris.os.dtrace">Record</a>, java.io.Serializable</pre>
<div class="block">A single key-value pair in a DTrace aggregation.
<p>
Immutable. Supports persistence using <code>XMLEncoder</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace"><code>Aggregation</code></a>,
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.AggregationRecord">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#AggregationRecord-org.opensolaris.os.dtrace.Tuple-org.opensolaris.os.dtrace.AggregationValue-">AggregationRecord</a></span>(<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a> tupleKey,
<a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace">AggregationValue</a> recordValue)</code>
<div class="block">Creates an aggregation record with the given key and value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#AggregationRecord-org.opensolaris.os.dtrace.Tuple-org.opensolaris.os.dtrace.AggregationValue-int-">AggregationRecord</a></span>(<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a> tupleKey,
<a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace">AggregationValue</a> recordValue,
int n)</code>
<div class="block">Creates an aggregation record with the given key, value, and
ordinal.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this aggregation record for
equality.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getOrdinal--">getOrdinal</a></span>()</code>
<div class="block">Gets the ordinal generated when this AggregationRecord was added
to its containing <a href="../../../../org/opensolaris/os/dtrace/Aggregate.html" title="class in org.opensolaris.os.dtrace"><code>Aggregate</code></a> by the native DTrace library,
from zero (first) to n-1 (last).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getTuple--">getTuple</a></span>()</code>
<div class="block">Gets the multi-element key associated with <a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getValue--"><code>getValue()</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace">AggregationValue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getValue--">getValue</a></span>()</code>
<div class="block">Gets the value associated with <a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getTuple--"><code>getTuple()</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overridden to ensure that equal records have equal hash codes.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this aggregation record useful
for logging and not intended for display.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AggregationRecord-org.opensolaris.os.dtrace.Tuple-org.opensolaris.os.dtrace.AggregationValue-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AggregationRecord</h4>
<pre>public AggregationRecord(<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a> tupleKey,
<a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace">AggregationValue</a> recordValue)</pre>
<div class="block">Creates an aggregation record with the given key and value.
Supports XML persistence.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#AggregationRecord-org.opensolaris.os.dtrace.Tuple-org.opensolaris.os.dtrace.AggregationValue-int-"><code>AggregationRecord(Tuple tupleKey, AggregationValue
recordValue, int n)</code></a></dd>
</dl>
</li>
</ul>
<a name="AggregationRecord-org.opensolaris.os.dtrace.Tuple-org.opensolaris.os.dtrace.AggregationValue-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AggregationRecord</h4>
<pre>public AggregationRecord(<a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a> tupleKey,
<a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace">AggregationValue</a> recordValue,
int n)</pre>
<div class="block">Creates an aggregation record with the given key, value, and
ordinal. Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tupleKey</code> - aggregation tuple, may be empty (see <a href="../../../../org/opensolaris/os/dtrace/Tuple.html#EMPTY"><code>Tuple.EMPTY</code></a>) to indicate that this record's value belongs to an
unkeyed aggregation declared without square brackets, for
example: <pre> <code> @a = count();</code></pre></dd>
<dd><code>recordValue</code> - aggregated value associated with the given
tuple</dd>
<dd><code>n</code> - ordinal from zero (first) to n-1 (last) within the
<a href="../../../../org/opensolaris/os/dtrace/Aggregate.html" title="class in org.opensolaris.os.dtrace"><code>Aggregate</code></a> containing this record</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the given key or value is
<code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the given ordinal is negative</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTuple--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTuple</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/Tuple.html" title="class in org.opensolaris.os.dtrace">Tuple</a> getTuple()</pre>
<div class="block">Gets the multi-element key associated with <a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getValue--"><code>getValue()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null, possibly empty tuple</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Aggregation.html#getRecord-org.opensolaris.os.dtrace.Tuple-"><code>Aggregation.getRecord(Tuple key)</code></a></dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public <a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace">AggregationValue</a> getValue()</pre>
<div class="block">Gets the value associated with <a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getTuple--"><code>getTuple()</code></a>. Values
generated by the DTrace actions <code>count()</code>, <code>sum()</code>,
<code>avg()</code>, <code>min()</code>, and <code>max()</code> are of type
<code>Long</code>. Values generated by the DTrace actions <code>quantize(</code>) and <code>lquantize()</code> are of type <a href="../../../../org/opensolaris/os/dtrace/Distribution.html" title="class in org.opensolaris.os.dtrace"><code>Distribution</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null value keyed to <a href="../../../../org/opensolaris/os/dtrace/AggregationRecord.html#getTuple--"><code>getTuple()</code></a></dd>
</dl>
</li>
</ul>
<a name="getOrdinal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrdinal</h4>
<pre>public int getOrdinal()</pre>
<div class="block">Gets the ordinal generated when this AggregationRecord was added
to its containing <a href="../../../../org/opensolaris/os/dtrace/Aggregate.html" title="class in org.opensolaris.os.dtrace"><code>Aggregate</code></a> by the native DTrace library,
from zero (first) to n-1 (last). The sequence described by an
aggregate's record ordinals reflects the setting of the <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkey"><code>aggsortkey</code></a>, <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortkeypos"><code>aggsortkeypos</code></a>, <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortpos"><code>aggsortpos</code></a>, and <a href="../../../../org/opensolaris/os/dtrace/Option.html#aggsortrev"><code>aggsortrev</code></a> DTrace options and matches the way
that the records would be ordered by <code>dtrace(1M)</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-negative ordinal from zero (first) to n-1 (last)
within the <code>Aggregate</code> containing this record</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/Aggregate.html#getOrderedRecords--"><code>Aggregate.getOrderedRecords()</code></a></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<div class="block">Compares the specified object with this aggregation record for
equality. Defines equality as having the same tuple and value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if and only if the specified object is an
<code>AggregationRecord</code> and both records have equal tuples as
defined by <a href="../../../../org/opensolaris/os/dtrace/Tuple.html#equals-java.lang.Object-"><code>Tuple.equals(Object o)</code></a> and equal values as
defined by the implementation of <a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace"><code>AggregationValue</code></a></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Overridden to ensure that equal records have equal hash codes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Gets a string representation of this aggregation record useful
for logging and not intended for display. The exact details of
the representation are unspecified and subject to change, but the
following format may be regarded as typical:
<pre><code>
class-name[property1 = value1, property2 = value2]
</code></pre></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></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="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AggregationRecord.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-all.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/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/AggregationRecord.html" target="_top">Frames</a></li>
<li><a href="AggregationRecord.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>