org.das2.qds.util

Class OdlParser

java.lang.Object

org.das2.qds.util.OdlParser

public class OdlParser
extends java.lang.Object

Tool for parsing ODL found at the top of .STS files.

Constructor Summary

Constructors

Constructor and Description
OdlParser()

Method Summary

Modifier and Type	Method and Description
static int[]	getColumns(JSONObject record, int startColumn, java.lang.String name) Return the records of the object with the name, with nested object names delimited with a period (POSN is a vector, POSN.X is the component).
static QDataSet	getDataSet(JSONObject record, QDataSet ds, java.lang.String name) return the data with the given name
static int	getFieldCount(JSONObject record)
static java.lang.String	getFormat(JSONObject record) return the format, though it doesn't appear to work.
static java.lang.String[]	getNames(JSONObject record, java.lang.String name, boolean includeComposite, java.util.List<java.lang.String> result) return a list of names which can be requested.
static java.lang.String	readOdl(java.io.BufferedReader r, JSONObject record) read the ODL off the top of the file, returning the ODL in a string and leaving the InputStream pointed at the line following the ODL.
static QDataSet	readStream(java.io.BufferedReader r, JSONObject record, ProgressMonitor monitor) read the stream based on the spec in record.

Methods inherited from class java.lang.Object

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

Constructor Detail

OdlParser

public OdlParser()

Method Detail

readOdl

public static java.lang.String readOdl(java.io.BufferedReader r,
                                       JSONObject record)
                                throws java.io.IOException,
                                       JSONException

read the ODL off the top of the file, returning the ODL in a string and leaving the InputStream pointed at the line following the ODL.

Parameters:

r - reader for the file which starts with ODL. The reader will be left pointing at the first non-ODL line.

record -

Returns:

the ODL header.

Throws:

java.io.IOException

JSONException - never

readStream

public static QDataSet readStream(java.io.BufferedReader r,
                                  JSONObject record,
                                  ProgressMonitor monitor)
                           throws java.io.IOException

read the stream based on the spec in record.

Parameters:

r - the reader, pointed after the ODL header.

record -

monitor -

Returns:

Throws:

java.io.IOException

getFieldCount

public static int getFieldCount(JSONObject record)

getFormat

public static java.lang.String getFormat(JSONObject record)

return the format, though it doesn't appear to work.

Parameters:

record -

Returns:

getNames

public static java.lang.String[] getNames(JSONObject record,
                                          java.lang.String name,
                                          boolean includeComposite,
                                          java.util.List<java.lang.String> result)

return a list of names which can be requested.

Parameters:

record - the node, typically then entire STS record.

name - the name of the node, "" for the root.

includeComposite - include the single-column names, for example BGSM as well as BGSM.X.

result - null or the name of a list to collect the names.

Returns:

getColumns

public static int[] getColumns(JSONObject record,
                               int startColumn,
                               java.lang.String name)

Return the records of the object with the name, with nested object names delimited with a period (POSN is a vector, POSN.X is the component). This will return a two-element int array indicating the position: [start,endExclusive] for vectors, [col,col] for scalars or a vector component, or [-1,-1] when the name is not found. Zero is the first column.

Parameters:

record - the JSON describing the file, or subset of the rows when startColumn is non-zero.

startColumn - starting column for the JSON.

name - of the object (POSN.X for example).

Returns:

[start,endExclusive] for vectors, [col,col] for scalars or a vector component, or [-1,-1] when the name is not found.

getDataSet

public static QDataSet getDataSet(JSONObject record,
                                  QDataSet ds,
                                  java.lang.String name)

return the data with the given name

Parameters:

record -

ds -

name -

Returns: