org.das2.qds.util

Class AsciiHeadersParser.BundleDescriptor

java.lang.Object

org.das2.qds.AbstractDataSet

org.das2.qds.util.AsciiHeadersParser.BundleDescriptor

All Implemented Interfaces:

MutablePropertyDataSet, QDataSet

Enclosing class:

AsciiHeadersParser

public static class AsciiHeadersParser.BundleDescriptor
extends AbstractDataSet

Field Summary

Fields inherited from class org.das2.qds.AbstractDataSet

properties

Fields inherited from interface org.das2.qds.QDataSet

AVERAGE_TYPE, BIN_MAX, BIN_MAX_NAME, BIN_MIN, BIN_MIN_NAME, BIN_MINUS, BIN_MINUS_NAME, BIN_PLUS, BIN_PLUS_NAME, BINS_0, BINS_1, BUNDLE_0, BUNDLE_1, BUNDLE_2, BUNDLE_3, CACHE_TAG, CADENCE, CONTEXT_0, CONTEXT_1, COORDINATE_FRAME, DEFAULT_FILL_VALUE, DELTA_MINUS, DELTA_MINUS_NAME, DELTA_PLUS, DELTA_PLUS_NAME, 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, LIMIT_HUGE_DATASET, 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_AVERAGE_TYPE_GEOMETRIC, VALUE_AVERAGE_TYPE_LINEAR, VALUE_AVERAGE_TYPE_MOD24, VALUE_AVERAGE_TYPE_MOD360, VALUE_AVERAGE_TYPE_MODPI, VALUE_AVERAGE_TYPE_MODTAU, VALUE_AVERAGE_TYPE_NONE, VALUE_BINS_MIN_MAX, VALUE_BINS_MIN_MAX_INCLUSIVE, 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_RENDER_TYPE_TRIANGLE_MESH, VALUE_SCALE_TYPE_LINEAR, VALUE_SCALE_TYPE_LOG, VERSION, WEIGHTS

Method Summary

Modifier and Type	Method and Description
protected void	addDataSet(java.lang.String name, int i, int[] qube) add the named dataset with the dimensions.
protected void	addDataSet(java.lang.String name, int i, int[] qube, java.lang.String[] names, java.lang.String[] labels) add the named dataset with the dimensions.
int	indexOf(java.lang.String name)
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 ic) accessor for properties attached to the dataset's first index.
void	putProperty(java.lang.String name, int ic, java.lang.Object v) assign the name value to the property at the slice index.
int	rank() returns the rank of the dataset, which is the number of indeces used to access data.
QDataSet	trim(int start, int end) special code because of START_INDEX property.
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, slice, svalue, toString, value, value, value, value

Methods inherited from class java.lang.Object

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

Method Detail

indexOf

public int indexOf(java.lang.String name)

addDataSet

protected void addDataSet(java.lang.String name,
                          int i,
                          int[] qube)

add the named dataset with the dimensions. Note qube doesn't include the first dimension, and this may be null for rank 1 datasets.

Parameters:

name - name of the dataset

i - index of the dataset. These must be contiguous.

qube - the dimensions or null for rank 1 data, e.g. vector= [3]

addDataSet

protected void addDataSet(java.lang.String name,
                          int i,
                          int[] qube,
                          java.lang.String[] names,
                          java.lang.String[] labels)

add the named dataset with the dimensions. Note qube doesn't include the first dimension, and this may be null for rank 1 datasets.

Parameters:

name - name of the dataset

i - index of the dataset. These must be contiguous.

qube - the dimensions or null for rank 1 data, e.g. vector= [3]

names - the names for each column. See QDataSet NAME property. This implies Vector.

labels - the labels for each column. See QDataSet LABEL property.

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 ic)

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"

ic - the index

Returns:

the value

See Also:

QDataSet.DEPEND_0, QDataSet.UNITS

putProperty

public void putProperty(java.lang.String name,
                        int ic,
                        java.lang.Object v)

Description copied from interface: MutablePropertyDataSet

assign the name value to the property at the slice index.

Specified by:

putProperty in interface MutablePropertyDataSet

Overrides:

putProperty in class AbstractDataSet

Parameters:

name - property name like "UNITS" (Use QDataSet.UNITS)

ic - the index of the slice.

v - the property value.

See Also:

Ops.putProperty(org.das2.qds.QDataSet, java.lang.String, java.lang.Object), QDataSet.UNITS, QDataSet.property(java.lang.String, int)

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.

trim

public QDataSet trim(int start,
                     int end)

special code because of START_INDEX property. Must trim at DataSet boundaries.

Specified by:

trim in interface QDataSet

Overrides:

trim in class AbstractDataSet

Parameters:

start -

end -

Returns: