QDataSetBridge

java.lang.Object
- org.virbo.idlsupport.QDataSetBridge

Direct Known Subclasses:

APDataSet, TestGetDataSet
```
public abstract class QDataSetBridge
extends java.lang.Object
```
See http://autoplot.org/IDL and http://autoplot.org/Matlab which show how this is used in the environments.

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String filter

static java.lang.String PROP_FILTER

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`filter`
`static java.lang.String`	`PROP_FILTER`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearFillValue()` don't use fill value.
`void`	`clearMemory()` clear existing data from memory, in case the bridge object is not cleared from in IDL or Matlab memory.
`void`	`clearPreferredUnits()` clear any preference for units.
`java.lang.String`	`depend(int dim)`
`void`	`doGetDataSet()` performs the read.
`void`	`doGetDataSet(ProgressMonitor mon)` This initiates the read on a separate thread, so this does not block and should be used with caution.
`int[]`	`freeMemory()` return the total memory and free memory available to the Java process, in megabytes (1e6 bytes).
`java.lang.Exception`	`getException()` return the Exception from the last doGetDataSet call.
`java.lang.String`	`getFilter()` get the filter that is applied to the data immediately after it is loaded.
`ProgressMonitor`	`getProgressMonitor()` returns an object that can be used to monitor the progress of a download.
`int`	`getStatus()` returns 0 for last get operation successful
`java.lang.String`	`getStatusMessage()` returns "" for last operation successful, or non-empty indicating the problem.
`boolean`	`hasProperty(java.lang.String propname)`
`boolean`	`hasProperty(java.lang.String propname, int i)`
`boolean`	`hasProperty(java.lang.String name, java.lang.String propname)`
`boolean`	`hasProperty(java.lang.String name, java.lang.String propname, int i)`
`boolean`	`isQube()`
`void`	`labelsAlias(java.lang.String name, java.lang.String[] result)` get the string values of the data instead of the numbers.
`int`	`length()` return the length of the zeroth dimension of the main dataset.
`int`	`length(java.lang.String name)` return the length of the zeroth dimension of the dataset
`int[]`	`lengths()` return the lengths of the dimensions of the default dataset.
`int[]`	`lengths(int i)` return the lengths of the dimensions of the main dataset, once sliced at index i.
`int[]`	`lengths(java.lang.String name)` return the lengths of the dimensions of the specified dataset.
`int[]`	`lengths(java.lang.String name, int i)` return the lengths of the dimensions of the named dataset, once sliced at index i.
`java.lang.String`	`name()`
`java.lang.String`	`nameFor(QDataSet dep0)` return the name used to refer to the dataset.
`java.lang.String[]`	`names()`
`java.lang.String`	`plane(int iplane)`
`java.util.Map<java.lang.String,java.lang.Object>`	`properties()`
`java.util.Map<java.lang.String,java.lang.Object>`	`properties(int i)`
`java.util.Map<java.lang.String,java.lang.Object>`	`properties(java.lang.String name)` get the properties for the named dataset
`java.util.Map<java.lang.String,java.lang.Object>`	`properties(java.lang.String name, int i)` get the properties for the named dataset
`java.lang.Object`	`property(java.lang.String propname)` returns one of String, int, double, float, int[], double, float[]
`java.lang.Object`	`property(java.lang.String propname, int i)` returns one of String, int, double, float, int[], double, float[]
`java.lang.Object`	`property(java.lang.String name, java.lang.String propname)` returns one of String, int, double, float, int[], double, float[]
`java.lang.Object`	`property(java.lang.String name, java.lang.String propname, int i)` returns one of String, int, double, float, int[], double, float[]
`double`	`propertyAsDouble(java.lang.String property)`
`double`	`propertyAsDouble(java.lang.String name, java.lang.String property)`
`java.lang.String`	`propertyAsString(java.lang.String property)`
`java.lang.String`	`propertyAsString(java.lang.String name, java.lang.String property)`
`int`	`rank()` return the number of dimensions of the default dataset.
`int`	`rank(java.lang.String name)` return the number of dimensions of the specified dataset.
`void`	`reportMemory()` print the Java memory stats to stderr.
`void`	`setDebug(boolean debug)` turn on/off debug messages
`void`	`setFillDouble(double d)` set the value to return when the data is invalid, when the data is known to be stored as doubles (8-byte numbers).
`void`	`setFillValue(double d)` set the value to return when the data is invalid.
`void`	`setFillValue(float f)`
`void`	`setFilter(java.lang.String filter)` set the filter that is applied to the data immediately after it is loaded.
`void`	`setPreferredUnits(java.lang.String sunit)` set the preferred units for the data.
`java.lang.Object`	`slice(int i0)` return an 1,2,or 3-D array of doubles or floats containing the values in a slice on the zeroth dimension of the default dataset.
`void`	`slice(int i, double[] result)`
`void`	`slice(int i, double[][] result)`
`void`	`slice(int i, double[][][] result)`
`java.lang.Object`	`slice(java.lang.String name, int i)` return the i-th 1 or 2-D array of doubles or floats containing the values in the specified rank 2 or 3 dataset.
`void`	`slice(java.lang.String name, int i, double[] result)` accessor for non-qube
`void`	`slice(java.lang.String name, int i, double[][] result)` accessor for non-qube
`void`	`slice(java.lang.String name, int i, double[][][] result)`
`java.lang.Object`	`slice1(int index)` slice on the first dimension, which is useful for extracting data component by component.
`java.lang.Object`	`slice1(int index, java.lang.String name)`
`java.lang.Object`	`values()` return an 1,2,or 3-D array of doubles or floats containing the values in the default dataset.
`void`	`values(double[] result)`
`void`	`values(double[][] result)`
`void`	`values(double[][][] result)`
`void`	`values(double[][][][] result)`
`java.lang.Object`	`values(java.lang.String name)` return an 1,2,or 3-D array of doubles or floats containing the values in the specified dataset.
`void`	`values(java.lang.String name, double[] result)`
`void`	`values(java.lang.String name, double[][] result)`
`void`	`values(java.lang.String name, double[][][] result)`
`void`	`values(java.lang.String name, double[][][][] result)`
`void`	`valuesAlias(java.lang.String name, double[] result)` copy the data into a 1-D array.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - filter
```
protected java.lang.String filter
```
  - PROP_FILTER
```
public static final java.lang.String PROP_FILTER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setPreferredUnits
```
public void setPreferredUnits(java.lang.String sunit)
```
    set the preferred units for the data. The code will convert to these units when a converter is found. If a preference is indicated when it is convertible to an existing preference, the existing preference is removed. See clearPreferredUnits to remove all preferences. Example units strings (capitalization matters):
    seconds since 2010-01-01T00:00 days since 2010-01-01T00:00 Hz kHz MHz
    Parameters:
    
    sunit -
  - clearPreferredUnits
```
public void clearPreferredUnits()
```
    clear any preference for units.
  - setFillValue
```
public void setFillValue(double d)
```
    set the value to return when the data is invalid. Note in IDL, where I echoed which was being called: IDL> apds.setFillValue, 89. % setFillValue(float) IDL> apds.setFillValue, 89.d % setFillValue(double)
    
    Parameters:
    
    d -
  - setFillValue
```
public void setFillValue(float f)
```
  - setFillDouble
```
public void setFillDouble(double d)
```
    set the value to return when the data is invalid, when the data is known to be stored as doubles (8-byte numbers). Python JPype doesn't allow for operator overloading, so this should be used.
    
    Parameters:
    
    d -
  - getFilter
```
public java.lang.String getFilter()
```
    get the filter that is applied to the data immediately after it is loaded.
    
    Returns:
    
    the filter string, empty string means no filters.
  - setFilter
```
public void setFilter(java.lang.String filter)
```
    set the filter that is applied to the data immediately after it is loaded.
    
    Parameters:
    
    filter - filter string like "|histogram()" or "" for no filters.
  - setDebug
```
public void setDebug(boolean debug)
```
    turn on/off debug messages
    
    Parameters:
    
    debug -
  - clearFillValue
```
public void clearFillValue()
```
    don't use fill value.
  - doGetDataSet
```
public void doGetDataSet()
```
    performs the read. Note no progress status is available and this blocks until the read is done. doGetDataSet(mon) should be called if progress is needed. 2011-01-01: getStatus or getStatusMessage should be called afterwards to check the result of the load, this will no longer throw an exception.
  - doGetDataSet
```
public void doGetDataSet(ProgressMonitor mon)
```
    This initiates the read on a separate thread, so this does not block and should be used with caution. See getProgressMonitor for use. Note this is more advanced and is intended to support use in other software (e.g. PaPCo). Note because there is one exception that is stored, a QDataSetBridge object is only able to load one dataset at a time. Simultaneous loads should be done with multiple QDataSetBridge objects.
    
    Parameters:
    
    mon - progress monitor from getProgressMonitor()
  - getException
```
public java.lang.Exception getException()
```
    return the Exception from the last doGetDataSet call.
    
    Returns:
  - getStatus
```
public int getStatus()
```
    returns 0 for last get operation successful
    
    Returns:
  - getStatusMessage
```
public java.lang.String getStatusMessage()
```
    returns "" for last operation successful, or non-empty indicating the problem. Note getException will return the Java exception for deeper inspection.
    
    Returns:
    
    "" or the error message
  - nameFor
```
public java.lang.String nameFor(QDataSet dep0)
```
    return the name used to refer to the dataset. This may add to the list of datasets.
    
    Parameters:
    
    dep0 - the dataset
    
    Returns:
    
    the name for the dataset.
  - getProgressMonitor
```
public ProgressMonitor getProgressMonitor()
```
    returns an object that can be used to monitor the progress of a download. mon= qds->getProgressMonitor(); qds->doGetDataSet( mon ) while ( ! mon->isFinished() ) do begin print, strtrim( mon->getTaskProgress(), 2 ) + " " + strtrim( mon->getTaskSize(), 2 ) wait, 0.2 ; don't overload the thread endwhile
    
    Returns:
  - values
```
public void values(java.lang.String name,
                   double[] result)
```
  - values
```
public void values(java.lang.String name,
                   double[][] result)
```
  - values
```
public void values(java.lang.String name,
                   double[][][] result)
```
  - values
```
public void values(java.lang.String name,
                   double[][][][] result)
```
  - values
```
public void values(double[] result)
```
  - values
```
public void values(double[][] result)
```
  - values
```
public void values(double[][][] result)
```
  - values
```
public void values(double[][][][] result)
```
  - slice
```
public void slice(java.lang.String name,
                  int i,
                  double[] result)
```
    accessor for non-qube
    
    Parameters:
    
    name -
    
    i -
    
    result -
  - slice
```
public void slice(java.lang.String name,
                  int i,
                  double[][] result)
```
    accessor for non-qube
    
    Parameters:
    
    name -
    
    i -
    
    result -
  - slice
```
public void slice(java.lang.String name,
                  int i,
                  double[][][] result)
```
  - slice
```
public void slice(int i,
                  double[] result)
```
  - slice
```
public void slice(int i,
                  double[][] result)
```
  - slice
```
public void slice(int i,
                  double[][][] result)
```
  - values
```
public java.lang.Object values(java.lang.String name)
```
    return an 1,2,or 3-D array of doubles or floats containing the values in the specified dataset.
    
    Parameters:
    
    name -
    
    Returns:
  - slice
```
public java.lang.Object slice(java.lang.String name,
                              int i)
```
    return the i-th 1 or 2-D array of doubles or floats containing the values in the specified rank 2 or 3 dataset. This is to support non-qube datasets.
    
    Parameters:
    
    name -
    
    i -
    
    Returns:
  - values
```
public java.lang.Object values()
```
    return an 1,2,or 3-D array of doubles or floats containing the values in the default dataset.
    
    Returns:
  - slice
```
public java.lang.Object slice(int i0)
```
    return an 1,2,or 3-D array of doubles or floats containing the values in a slice on the zeroth dimension of the default dataset.
    
    Parameters:
    
    i0 - the index to slice on.
    
    Returns:
    
    1,2,or 3-D array of doubles or floats.
  - slice1
```
public java.lang.Object slice1(int index)
```
    slice on the first dimension, which is useful for extracting data component by component.
    
    Parameters:
    
    index -
    
    Returns:
    
    array of floats or doubles.
  - slice1
```
public java.lang.Object slice1(int index,
                               java.lang.String name)
```
  - depend
```
public java.lang.String depend(int dim)
```
  - plane
```
public java.lang.String plane(int iplane)
```
  - propertyAsString
```
public java.lang.String propertyAsString(java.lang.String property)
```
  - propertyAsDouble
```
public double propertyAsDouble(java.lang.String property)
```
  - propertyAsString
```
public java.lang.String propertyAsString(java.lang.String name,
                                         java.lang.String property)
```
  - propertyAsDouble
```
public double propertyAsDouble(java.lang.String name,
                               java.lang.String property)
```
  - valuesAlias
```
public void valuesAlias(java.lang.String name,
                        double[] result)
```
    copy the data into a 1-D array. Rank 2 and 3 dataset array are then aliased with the highest dimension the most tightly packed.
    
    Parameters:
    
    name -
    
    result -
  - labelsAlias
```
public void labelsAlias(java.lang.String name,
                        java.lang.String[] result)
```
    get the string values of the data instead of the numbers. This provides a means to decode times and nominal data such as labels data sets.
    
    Parameters:
    
    name -
    
    result -
  - lengths
```
public int[] lengths(java.lang.String name)
```
    return the lengths of the dimensions of the specified dataset.
    
    Parameters:
    
    name -
    
    Returns:
  - lengths
```
public int[] lengths()
```
    return the lengths of the dimensions of the default dataset.
    
    Returns:
  - lengths
```
public int[] lengths(java.lang.String name,
                     int i)
```
    return the lengths of the dimensions of the named dataset, once sliced at index i.
    
    Parameters:
    
    name -
    
    i - the index to slice
    
    Returns:
    
    See Also:
    
    length which returns the length of the zeroth index.
  - lengths
```
public int[] lengths(int i)
```
    return the lengths of the dimensions of the main dataset, once sliced at index i.
    
    Parameters:
    
    i - the index to slice
    
    Returns:
    
    the lengths of each dimension.
  - length
```
public int length(java.lang.String name)
```
    return the length of the zeroth dimension of the dataset
    
    Parameters:
    
    name -
    
    Returns:
    
    the length of the zeroth dimension
  - length
```
public int length()
```
    return the length of the zeroth dimension of the main dataset.
    
    Returns:
    
    the length of the zeroth dimension
  - rank
```
public int rank(java.lang.String name)
```
    return the number of dimensions of the specified dataset.
    
    Parameters:
    
    name -
    
    Returns:
  - rank
```
public int rank()
```
    return the number of dimensions of the default dataset.
    
    Returns:
  - isQube
```
public boolean isQube()
```
  - property
```
public java.lang.Object property(java.lang.String name,
                                 java.lang.String propname,
                                 int i)
```
    returns one of String, int, double, float, int[], double, float[]
    
    Parameters:
    
    name -
    
    propname -
    
    i -
    
    Returns:
    
    the property
  - hasProperty
```
public boolean hasProperty(java.lang.String name,
                           java.lang.String propname,
                           int i)
```
  - properties
```
public java.util.Map<java.lang.String,java.lang.Object> properties(java.lang.String name,
                                                                   int i)
```
    get the properties for the named dataset
    
    Parameters:
    
    name -
    
    i - the index
    
    Returns:
  - property
```
public java.lang.Object property(java.lang.String name,
                                 java.lang.String propname)
```
    returns one of String, int, double, float, int[], double, float[]
    
    Parameters:
    
    name -
    
    propname -
    
    Returns:
  - hasProperty
```
public boolean hasProperty(java.lang.String name,
                           java.lang.String propname)
```
  - properties
```
public java.util.Map<java.lang.String,java.lang.Object> properties(java.lang.String name)
```
    get the properties for the named dataset
    
    Parameters:
    
    name -
    
    Returns:
  - property
```
public java.lang.Object property(java.lang.String propname)
```
    returns one of String, int, double, float, int[], double, float[]
    
    Parameters:
    
    propname -
    
    Returns:
  - hasProperty
```
public boolean hasProperty(java.lang.String propname)
```
  - properties
```
public java.util.Map<java.lang.String,java.lang.Object> properties()
```
  - property
```
public java.lang.Object property(java.lang.String propname,
                                 int i)
```
    returns one of String, int, double, float, int[], double, float[]
    
    Parameters:
    
    propname - the property name
    
    i - the slice index
    
    Returns:
    
    the name of the qdataset, or the value.
  - hasProperty
```
public boolean hasProperty(java.lang.String propname,
                           int i)
```
  - properties
```
public java.util.Map<java.lang.String,java.lang.Object> properties(int i)
```
  - names
```
public java.lang.String[] names()
```
  - name
```
public java.lang.String name()
```
  - reportMemory
```
public void reportMemory()
```
    print the Java memory stats to stderr.
    
    See Also:
    
    clearMemory()
  - freeMemory
```
public int[] freeMemory()
```
    return the total memory and free memory available to the Java process, in megabytes (1e6 bytes).
    
    Returns:
    
    an integer array [ used, total ]
  - clearMemory
```
public void clearMemory()
```
    clear existing data from memory, in case the bridge object is not cleared from in IDL or Matlab memory.
    
    See Also:
    
    reportMemory()

Class QDataSetBridge

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

filter

PROP_FILTER

Method Detail

setPreferredUnits

clearPreferredUnits

setFillValue

setFillValue

setFillDouble

getFilter

setFilter

setDebug

clearFillValue

doGetDataSet

doGetDataSet

getException

getStatus

getStatusMessage

nameFor

getProgressMonitor

values

values

values

values

values

values

values

values

slice

slice

slice

slice

slice

slice

values

slice

values

slice

slice1

slice1

depend

plane

propertyAsString

propertyAsDouble

propertyAsString

propertyAsDouble

valuesAlias

labelsAlias

lengths

lengths

lengths

lengths

length

length

rank

rank

isQube

property

hasProperty

properties

property

hasProperty

properties

property

hasProperty

properties

property

hasProperty

properties

names

name

reportMemory

freeMemory

clearMemory