org.das2.qds

Class BundleDataSet.BundleDescriptor

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.BundleDataSet.BundleDescriptor

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet

Enclosing class:

BundleDataSet

public class BundleDataSet.BundleDescriptor
extends AbstractDataSet

special dataset describing the bundled datasets in a BundleDataSet.

Field Summary

Fields inherited from class org.das2.qds.AbstractDataSet

properties

Fields inherited from interface org.das2.qds.QDataSet

BIN_MAX, BIN_MIN, BIN_MINUS, BIN_PLUS, BINS_0, BINS_1, BUNDLE_0, BUNDLE_1, BUNDLE_2, BUNDLE_3, CACHE_TAG, CADENCE, CONTEXT_0, COORDINATE_FRAME, DEFAULT_FILL_VALUE, DELTA_MINUS, DELTA_PLUS, DEPEND_0, DEPEND_1, DEPEND_2, DEPEND_3, DEPENDNAME_0, DEPENDNAME_1, DESCRIPTION, ELEMENT_DIMENSIONS, ELEMENT_LABEL, ELEMENT_NAME, FILL_VALUE, FORMAT, JOIN_0, LABEL, MAX_HIGH_RANK, MAX_PLANE_COUNT, MAX_RANK, MAX_UNIT_BUNDLE_COUNT, METADATA, METADATA_MODEL, MIN_WAVEFORM_LENGTH, MONOTONIC, NAME, NOTES, PLANE_0, QUBE, RENDER_TYPE, SCALE_TYPE, SOURCE, START_INDEX, TITLE, TYPICAL_MAX, TYPICAL_MIN, UNITS, USER_PROPERTIES, VALID_MAX, VALID_MIN, VALUE_BINS_MIN_MAX, VALUE_COORDINATE_FRAME_COMPLEX_NUMBER, VALUE_METADATA_MODEL_ISTP, VALUE_METADATA_MODEL_SPASE, VALUE_RENDER_TYPE_COMPOSITE_IMAGE, VALUE_RENDER_TYPE_DIGITAL, VALUE_RENDER_TYPE_EVENTS_BAR, VALUE_RENDER_TYPE_NNSPECTROGRAM, VALUE_RENDER_TYPE_SERIES, VALUE_SCALE_TYPE_LINEAR, VALUE_SCALE_TYPE_LOG, VERSION, WEIGHTS

Constructor Summary

Constructors

Constructor and Description
BundleDescriptor()

Method Summary

Modifier and Type	Method and Description
int	length() return the length of the first dimension
int	length(int i) return the length of the second dimension, for the ith element of the first dimension.
java.lang.Object	property(java.lang.String name, int i) accessor for properties attached to the dataset's first index.
int	rank() returns the rank of the dataset, which is the number of indeces used to access data.
java.lang.String	toString() return a human-readable string representation of this QDataSet.
double	value(int i0, int i1) rank 2 accessor.

Methods inherited from class org.das2.qds.AbstractDataSet

capability, checkImmutable, isImmutable, length, length, makeImmutable, property, putProperty, putProperty, slice, trim, value, value, value, value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BundleDescriptor

public BundleDescriptor()

Method Detail

rank

public int rank()

Description copied from interface: QDataSet

returns the rank of the dataset, which is the number of indeces used to access data. Only rank 0, 1, 2, 3, and 4 datasets are supported in the interface. When a dataset's rank is 5 or greater, it should implement the HighRankDataSet interface which affords a slice operation to reduce rank.

Specified by:

rank in interface QDataSet

Specified by:

rank in class AbstractDataSet

Returns:

the rank, or number of indeces used to access data.

length

public int length()

Description copied from interface: QDataSet

return the length of the first dimension

Specified by:

length in interface QDataSet

Overrides:

length in class AbstractDataSet

Returns:

the length of the first dimension

length

public int length(int i)

Description copied from interface: QDataSet

return the length of the second dimension, for the ith element of the first dimension. Note if there are zero elements in the first dimension, but this is a QUBE, then this should not throw an IndexOutOfBoundsException.

Specified by:

length in interface QDataSet

Overrides:

length in class AbstractDataSet

Parameters:

i - the index

Returns:

the length of the second dimension at index i.

property

public java.lang.Object property(java.lang.String name,
                                 int i)

Description copied from interface: QDataSet

accessor for properties attached to the dataset's first index. These properties override (or shadow) properties attached to the dataset, and often implementations will simply return the result of the no-index accessor. Note: properties of higher dimension are accessible only by slicing.

Specified by:

property in interface QDataSet

Overrides:

property in class AbstractDataSet

Parameters:

name - property name, such as "DEPEND_0" or "UNITS"

i - the index

Returns:

the value

See Also:

QDataSet.DEPEND_0, QDataSet.UNITS

value

public double value(int i0,
                    int i1)

Description copied from interface: QDataSet

rank 2 accessor.

Specified by:

value in interface QDataSet

Overrides:

value in class AbstractDataSet

Parameters:

i0 - the index

i1 - the index

Returns:

the value, see the property UNITS to interpret this.

toString

public java.lang.String toString()

Description copied from class: AbstractDataSet

return a human-readable string representation of this QDataSet.

Overrides:

toString in class AbstractDataSet

Returns:

a human-readable string representation of this QDataSet.

See Also:

DataSetUtil.toString(org.das2.qds.QDataSet)