org.das2.qds

Interface MutablePropertyDataSet

All Superinterfaces:

QDataSet

All Known Subinterfaces:

WritableDataSet

All Known Implementing Classes:

AbstractDataSet, AbstractRank1DataSet, ArrayDataSet, AsciiDataSet, AsciiHeadersParser.BundleDescriptor, BDataSet, BufferDataSet, BundleDataSet, BundleDataSet.BundleDescriptor, ByteDataSet, CdfSparseDataSet, ClippedTableDataSet, DataSetWrapper, DDataSet, DodsVarDataSet, DodsVarDataSet.DoubleArray, DodsVarDataSet.EpochStringArray, DodsVarDataSet.FloatArray, DodsVarDataSet.Int16Array, DodsVarDataSet.Int32Array, DodsVarDataSet.NominalStringArray, DoubleDataSet, DRank0DataSet, FDataSet, FlattenWaveformDataSet, FloatDataSet, GridDataSet, IDataSet, ImageDataSet, IndexGenDataSet, Int24DataSet, IntDataSet, JoinDataSet, LDataSet, LeafTrimDataSet, LengthsDataSet, LongDataSet, NetCdfVarDataSet, NybbleDataSet, ReformDataSet, RepeatIndexDataSet, ReplicateDataSet, ReverseDataSet, RipplesDataSet, SDataSet, SegmentedBufferDataSet, ShortDataSet, Slice0DataSet, Slice1DataSet, Slice2DataSet, Slice3DataSet, SortDataSet, SparseDataSet, SpectrumTest.MySpectrogramData, SubsetDataSet, TagGenDataSet, TailBundleDataSet, TailBundleDataSet.BundleDescriptor, TimeDataSet, TransposeRank2DataSet, TransposeRankNDataSet, TrArrayDataSet, TrDDataSet, TrFDataSet, TrimDataSet, TrimStrideWrapper, TrLDataSet, TruncatedFloatDataSet, UByteDataSet, UInt24DataSet, UIntDataSet, UShortDataSet, VaxFloatDataSet, WritableDataSetWrapper, WritableJoinDataSet

public interface MutablePropertyDataSet
extends QDataSet

Some QDataSets allow their properties to be changed. Note scripts should never assume a dataset is mutable, and should call the putProperty method instead, which will make a copy if necessary. Note the terms mutable, writable, and modifiable are all used in this documentation and interchangeable.

See Also:

which allows the values to be modified as well.

Field Summary

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
boolean	isImmutable() return true if the dataset has been made immutable.
void	makeImmutable() mark the dataset as being immutable.
void	putProperty(java.lang.String name, int index, java.lang.Object value) assign the name value to the property at the slice index.
void	putProperty(java.lang.String name, java.lang.Object value) assign the name value to the property.

Methods inherited from interface org.das2.qds.QDataSet

capability, length, length, length, length, property, property, rank, slice, svalue, trim, value, value, value, value, value

Method Detail

putProperty

void putProperty(java.lang.String name,
                 java.lang.Object value)

assign the name value to the property. Note that name__i can be used as a alias for an indexed property, but when possible putProperty(name,i,value) should be used.

Parameters:

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

value - the property value.

See Also:

putProperty which properly checks mutability of the dataset, QDataSet.UNITS

putProperty

void putProperty(java.lang.String name,
                 int index,
                 java.lang.Object value)

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

Parameters:

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

index - the index of the slice.

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

makeImmutable

void makeImmutable()

mark the dataset as being immutable. Once this is called, calls to mutating properties will print warning messages for now, but will soon be an error.

isImmutable

boolean isImmutable()

return true if the dataset has been made immutable.

Returns:

true if the dataset has been made immutable.