org.das2.qds

Class DataSetAnnotations

java.lang.Object

org.das2.qds.DataSetAnnotations

public class DataSetAnnotations
extends java.lang.Object

Place to experiment with runtime notes about datasets in this single-instance lookup table. This uses weak references so that datasets will be garbage collected.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANNOTATION_BOUNDS the bounding cube of the dataset, see SemanticOps.getBounds.
static java.lang.String	ANNOTATION_CADENCE the cadence for the dataset.
static java.lang.String	ANNOTATION_INVALID_COUNT number of invalid entries.
static java.lang.String	ANNOTATION_QUBE qube for the dataset.
static java.lang.String	ANNOTATION_ZERO_COUNT number of entries containing the value zero.
static java.lang.Integer	VALUE_0 the value 0 to avoid the if statement in valueOf
static java.lang.Integer	VALUE_1 the value 1 to avoid the if statement in valueOf

Constructor Summary

Constructors

Constructor and Description
DataSetAnnotations()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAnnotation(QDataSet ds, java.lang.String annotation) return either null or the value for the annotation.
static DataSetAnnotations	getInstance() access the single instance
void	peek() print the map of annotations to stderr.
void	putAnnotation(QDataSet ds, java.lang.String annotation, java.lang.Object value) add the annotation.
void	reset() reset the internal state.

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_0

public static final java.lang.Integer VALUE_0

the value 0 to avoid the if statement in valueOf

VALUE_1

public static final java.lang.Integer VALUE_1

the value 1 to avoid the if statement in valueOf

ANNOTATION_INVALID_COUNT

public static final java.lang.String ANNOTATION_INVALID_COUNT

number of invalid entries. If zero, the data is all valid, within valid min to valid max and not fill.

See Also:

Constant Field Values

ANNOTATION_ZERO_COUNT

public static final java.lang.String ANNOTATION_ZERO_COUNT

number of entries containing the value zero. If zero, then the data is all non-zero or fill. This is used with ANNOTATION_INVALID_COUNT in the where function.

See Also:

Constant Field Values

ANNOTATION_BOUNDS

public static final java.lang.String ANNOTATION_BOUNDS

the bounding cube of the dataset, see SemanticOps.getBounds.

See Also:

Constant Field Values

ANNOTATION_CADENCE

public static final java.lang.String ANNOTATION_CADENCE

the cadence for the dataset.

See Also:

Constant Field Values

ANNOTATION_QUBE

public static final java.lang.String ANNOTATION_QUBE

qube for the dataset.

See Also:

Constant Field Values

Constructor Detail

DataSetAnnotations

public DataSetAnnotations()

Method Detail

getInstance

public static DataSetAnnotations getInstance()

access the single instance

Returns:

the single instance

getAnnotation

public java.lang.Object getAnnotation(QDataSet ds,
                                      java.lang.String annotation)

return either null or the value for the annotation. Note some Java compilers (Java6?) will not allow code such as: 0==DataSetAnnotations.getInstance().getAnnotation(...) so instead use Integer.valueOf(0)==DataSetAnnotations.getInstance().getAnnotation(...)

Parameters:

ds - the dataset.

annotation - the annotation name, such as ANNOTATION_INVALID_COUNT.

Returns:

null or the annotation value.

putAnnotation

public void putAnnotation(QDataSet ds,
                          java.lang.String annotation,
                          java.lang.Object value)

add the annotation.

Parameters:

ds - the dataset to annotate

annotation - the annotation name, such as ANNOTATION_INVALID_COUNT.

value - the value.

peek

public void peek()

print the map of annotations to stderr.

reset

public void reset()

reset the internal state.