fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * CDDL HEADER START
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * The contents of this file are subject to the terms of the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Common Development and Distribution License (the "License").
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * You may not use this file except in compliance with the License.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * See the License for the specific language governing permissions
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * and limitations under the License.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * When distributing Covered Code, include this CDDL HEADER in each
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * If applicable, add the following below this CDDL HEADER, with the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * fields enclosed by brackets "[]" replaced with your own identifying
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * information: Portions Copyright [yyyy] [name of copyright owner]
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * CDDL HEADER END
e77b06d21580f630e0a7c437495ab283d3672828tomee * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Use is subject to license terms.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * ident "%Z%%M% %I% %E% SMI"
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * A single key-value pair in a DTrace aggregation.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Immutable. Supports persistence using {@link java.beans.XMLEncoder}.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @see Aggregation
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @author Tom Erickson
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomeepublic final class AggregationRecord implements Record, Serializable {
e77b06d21580f630e0a7c437495ab283d3672828tomee static final long serialVersionUID = -4367614268579702616L;
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee BeanInfo info = Introspector.getBeanInfo(AggregationRecord.class);
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Need to prevent DefaultPersistenceDelegate from using
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * overridden equals() method, resulting in a
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * StackOverFlowError. Revert to PersistenceDelegate
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * implementation. See
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * 477019&tstart=135
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee protected boolean
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee d.setValue("persistenceDelegate", persistenceDelegate);
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
e77b06d21580f630e0a7c437495ab283d3672828tomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Creates an aggregation record with the given key and value.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Supports XML persistence.
e77b06d21580f630e0a7c437495ab283d3672828tomee * @see #AggregationRecord(Tuple tupleKey, AggregationValue
e77b06d21580f630e0a7c437495ab283d3672828tomee * recordValue, int n)
e77b06d21580f630e0a7c437495ab283d3672828tomee AggregationRecord(Tuple tupleKey, AggregationValue recordValue)
e77b06d21580f630e0a7c437495ab283d3672828tomee // Called by native code, but public to support backwardly
e77b06d21580f630e0a7c437495ab283d3672828tomee // compatible XML encoding.
e77b06d21580f630e0a7c437495ab283d3672828tomee * Creates an aggregation record with the given key, value, and
e77b06d21580f630e0a7c437495ab283d3672828tomee * ordinal. Supports XML persistence.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param tupleKey aggregation tuple, may be empty (see {@link
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Tuple#EMPTY}) to indicate that this record's value belongs to an
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * unkeyed aggregation declared without square brackets, for
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * example: <pre> {@code @a = count();}</pre>
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param recordValue aggregated value associated with the given
e77b06d21580f630e0a7c437495ab283d3672828tomee * @param n ordinal from zero (first) to n-1 (last) within the
e77b06d21580f630e0a7c437495ab283d3672828tomee * {@link Aggregate} containing this record
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @throws NullPointerException if the given key or value is
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * {@code null}
e77b06d21580f630e0a7c437495ab283d3672828tomee * @throws IllegalArgumentException if the given ordinal is negative
e77b06d21580f630e0a7c437495ab283d3672828tomee AggregationRecord(Tuple tupleKey, AggregationValue recordValue, int n)
91cfa10a8e55050a5103c4b2e83b0bf8d783a7cbtomee private final void
e77b06d21580f630e0a7c437495ab283d3672828tomee throw new IllegalArgumentException("ordinal is negative");
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the multi-element key associated with {@link
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * #getValue()}.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return non-null, possibly empty tuple
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @see Aggregation#getRecord(Tuple key)
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the value associated with {@link #getTuple()}. Values
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * generated by the DTrace actions {@code count()}, {@code sum()},
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * {@code avg()}, {@code min()}, and {@code max()} are of type
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * {@link Long}. Values generated by the DTrace actions {@code
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * quantize(}) and {@code lquantize()} are of type {@link
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Distribution}.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return non-null value keyed to {@link #getTuple()}
e77b06d21580f630e0a7c437495ab283d3672828tomee * Gets the ordinal generated when this AggregationRecord was added
e77b06d21580f630e0a7c437495ab283d3672828tomee * to its containing {@link Aggregate} by the native DTrace library,
e77b06d21580f630e0a7c437495ab283d3672828tomee * from zero (first) to n-1 (last). The sequence described by an
e77b06d21580f630e0a7c437495ab283d3672828tomee * aggregate's record ordinals reflects the setting of the {@link
e77b06d21580f630e0a7c437495ab283d3672828tomee * Option#aggsortkey aggsortkey}, {@link Option#aggsortkeypos
e77b06d21580f630e0a7c437495ab283d3672828tomee * aggsortkeypos}, {@link Option#aggsortpos aggsortpos}, and {@link
e77b06d21580f630e0a7c437495ab283d3672828tomee * Option#aggsortrev aggsortrev} DTrace options and matches the way
e77b06d21580f630e0a7c437495ab283d3672828tomee * that the records would be ordered by {@code dtrace(1M)}.
e77b06d21580f630e0a7c437495ab283d3672828tomee * @return non-negative ordinal from zero (first) to n-1 (last)
e77b06d21580f630e0a7c437495ab283d3672828tomee * within the {@code Aggregate} containing this record
e77b06d21580f630e0a7c437495ab283d3672828tomee * @see Aggregate#getOrderedRecords()
e77b06d21580f630e0a7c437495ab283d3672828tomee * Package level access; called by Aggregate
e77b06d21580f630e0a7c437495ab283d3672828tomee if (n < 0) {
e77b06d21580f630e0a7c437495ab283d3672828tomee throw new IllegalArgumentException("ordinal is negative");
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Compares the specified object with this aggregation record for
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * equality. Defines equality as having the same tuple and value.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return {@code true} if and only if the specified object is an
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * {@code AggregationRecord} and both records have equal tuples as
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * defined by {@link Tuple#equals(Object o)} and equal values as
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * defined by the implementation of {@link AggregationValue}
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee public boolean
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee if (o instanceof AggregationRecord) {
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee return false;
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Overridden to ensure that equal records have equal hash codes.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee private void
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee // Check class invariants
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee } catch (Exception e) {
4ae67516a1d5dc4a5dbc761762bad5b596647388tomee InvalidObjectException x = new InvalidObjectException(
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets a string representation of this aggregation record useful
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * for logging and not intended for display. The exact details of
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * the representation are unspecified and subject to change, but the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * following format may be regarded as typical:
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * <pre><code>
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * class-name[property1 = value1, property2 = value2]
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * </code></pre>