gov.noaa.pmel.tmap.las.jdom

Class LASConfig

java.lang.Object

org.jdom.Document

gov.noaa.pmel.tmap.jdom.LASDocument

gov.noaa.pmel.tmap.las.jdom.LASConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.jdom.Parent

public class LASConfig
extends gov.noaa.pmel.tmap.jdom.LASDocument

This class is the JDOM instantiation of the "las.xml" file and any entities it references (data stubs and operationsV7.xml).

Author:

Roland Schweitzer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LASConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCategories(java.util.ArrayList<gov.noaa.pmel.tmap.addxml.CategoryBean> cats) Adds the contents of a category bean from addXML to the config, creating the las_categories element if necessary.
java.lang.String	addDataset(java.lang.String id)
void	addEnsembleIDs()
void	addFDS(java.lang.String fds_base, java.lang.String fds_dir) Take F-TDS server URL and data directory and build the F-TDS URLs for each variable.
void	addGridType() Descends the dataset and variable tree and set the grid_type attribute if it is not already set.
void	addIntervalsAndPoints() Adds attributes to all variables that indicate whether or not the variable has a range or a point in the definition of each axis.
void	addRemoteVariables(java.lang.String JSESSIONID, LASUIRequest lasRequest)
void	addServerID()
long	addSrc(gov.noaa.pmel.tmap.addxml.DatasetsGridsAxesBean dgab, int src_index, org.jdom.Element dsetsE, org.jdom.Element dataset, java.util.ArrayList<org.jdom.Element> src_datasets, java.util.ArrayList<org.jdom.Element> src_grids, java.util.ArrayList<org.jdom.Element> src_axes, java.util.HashMap<java.lang.String,java.util.ArrayList<org.jdom.Element>> ds_children, Cache cache, java.lang.String src_key)
long	addXML(boolean update, Cache cache) Create or update LAS metadata directly from a netCDF or THREDDS data source.
boolean	allowsSisters()
void	convertToSeven() Converts to XML that can be validated against a schema, or returns if it detects that XML is already "Version 7".
void	convertToSeven(boolean force)
java.util.ArrayList<Option>	extractOptions(java.lang.String optionID) Helper method to recursively extract the options.
java.lang.String	getBaseServerURL() Get the base url of this LAS server (the server host, port and context path).
java.lang.String	getBaseServerURLKey()
java.util.ArrayList<Category>	getCategories(java.lang.String catid) Get the categories directly below this id.
gov.noaa.pmel.tmap.las.client.serializable.CategorySerializable[]	getCategoriesSerializable(java.lang.String[] ids)
gov.noaa.pmel.tmap.las.client.serializable.CategorySerializable[]	getCategorySerializable(java.util.ArrayList<Category> categories)
gov.noaa.pmel.tmap.las.client.serializable.CategorySerializable	getCategorySerializableWithGrids(java.lang.String catid, java.lang.String dsid)
java.util.ArrayList<DataConstraint>	getConstraints(java.lang.String dsID, java.lang.String varID) Get any applicable data constraints for a particular data set and variable.
java.util.ArrayList<DataConstraint>	getConstraints(java.lang.String ui_default, java.lang.String dsID, java.lang.String varID) Get any constraints from the named UI default.
java.util.HashMap<java.lang.String,DataConstraint>	getConstraintsHash(java.lang.String dsID, java.lang.String varID) Get any applicable data constraints for a particular data set and variable as a HashMap keyed on the constraint ID.
java.util.HashMap<java.lang.String,DataConstraint>	getConstraintsHash(java.lang.String ui_default, java.lang.String dsID, java.lang.String varID) Get any constraints from the named UI default as a HashMap keyed on the constraint ID.
java.lang.String	getDataAccessBrowserURL(java.lang.String xpath, boolean fds) Returns a URL for an LAS data set that will show something intelligible in the browser.
java.lang.String	getDataAccessBrowserURL(java.lang.String dsID, java.lang.String varID, boolean fds) Return a link for an LAS data set that will return something itelligble to the browser.
java.lang.String	getDataAccessURL(java.lang.String xpath, boolean fds) Get data access URL.
java.lang.String	getDataAccessURL(java.lang.String dsID, java.lang.String varID, boolean fds) Get data access URL.
java.lang.String	getDataObjectURL(org.jdom.Element variable) Returns the data access URL for a particular variable via the XPath of the variable (strips off the #var)
java.lang.String	getDataObjectURL(java.lang.String xpathValue) Returns the OPeNDAP ready data access URL for a particular variable via the XPath of the variable (strips off the #var)
java.util.List	getDataOjectAttributes(java.lang.String xpathValue) Return a list of attributes on the given element
Dataset	getDataset(java.lang.String dsID) Get a <dataset> element base on the data set id
java.util.HashMap<java.lang.String,java.lang.String>	getDatasetAttributes(java.lang.String varXPath) Get all of the attributes from the parent data set element.
java.util.ArrayList<Dataset>	getDatasets()
java.util.ArrayList<Dataset>	getDatasets(boolean full) Returns all the datasets as gov.noaa.pmel.tmap.las.util.Dataset objects.
java.util.ArrayList<Category>	getDatasetsAsCategories(boolean full) Returns all the datasets as gov.noaa.pmel.tmap.las.util.Dataset objects.
org.jdom.Element	getDatasetsAsElement() Return all datasets as a single "datasets" element.
java.util.ArrayList<NameValuePair>	getDatasetsAsNameValueBeans() Deprecated.
static java.lang.String	getDSIDfromXPath(java.lang.String xpath)
java.util.Map<java.lang.String,java.lang.String>	getEnsembleMembers(java.lang.String[] dsID)
java.util.List<gov.noaa.pmel.tmap.las.client.serializable.ERDDAPConstraintGroup>	getERDDAPConstraintGroups(java.lang.String dsid)
java.lang.String	getFirstVariable() Get first variable from LASConfig.
java.util.List<java.lang.String>	getFTDSTestURLs(int max) Return up to max direct and F-TDS URLs that can be tested.
java.lang.String	getFTDSURL(org.jdom.Element variable) Get the F-TDS URL for this variable
java.lang.String	getFTDSURL(java.lang.String varXPath) Get the F-TDS URL for the variable specified by the XPath
java.lang.String	getFTDSURL(java.lang.String dsID, java.lang.String varID) Get the F-TDS URL for the variable specified by the dsID and varID
java.lang.String	getFullDataObjectURL(org.jdom.Element variable) Returns the full data URL for a particular variable (as identified by the variable element) including the #var (netCDF variable name convention used by LAS)
java.lang.String	getFullDataObjectURL(java.lang.String xpathValue) Returns the full data URL for a particular variable (as identified by its XPath) including the #var (netCDF variable name convention used by LAS)
java.lang.String	getFullDataObjectURL(java.lang.String dsid, java.lang.String varid)
Dataset	getFullDataset(java.lang.String dsID)
Dataset	getFullDatasetNoGrids(java.lang.String dsID)
java.util.ArrayList<Dataset>	getFullDatasets()
java.util.ArrayList<Variable>	getFullVariables(java.lang.String dsID)
java.util.HashMap<java.lang.String,java.lang.String>	getGlobalPropertyGroupAsHashMap(java.lang.String name)
java.lang.String	getGlobalPropertyValue(java.lang.String group, java.lang.String name) Get the value of a "global" property (a property in the config that is not in any particular data set or variable).
Grid	getGrid(java.lang.String varXPath) Get the grid of a variable from its XPath
Grid	getGrid(java.lang.String dsID, java.lang.String varID) Get grid for a particular dataset and variable.
Grid	getGridById(java.lang.String ID) Get the grid object with its axes filled by the grids ID.
gov.noaa.pmel.tmap.las.client.serializable.GridSerializable	getGridSerializable(java.lang.String dsID, java.lang.String varID)
java.lang.String	getGridType(java.lang.String dsID, java.lang.String varID) Get the grid_type for the variable (regular, scattered, ...)
java.lang.String	getHi(java.lang.String type, java.lang.String varpath) Get hi value for a particular axis type for the specified variable
java.util.Map<java.lang.String,java.lang.String>	getIDMap(java.lang.String data_url)
java.lang.String	getIDs(java.lang.String data_url)
Institution	getInstitution() Get the container with all the information about the institution that installed this LAS.
java.lang.String	getLo(java.lang.String type, java.lang.String varpath) Get lo value for a particular axis type for the specified variable.
org.jdom.Element	getMergedProperties(org.jdom.Element dsE) Given a dataset element merge the properties (probably should be private) All properties should have been converted to "V7.0" style properties before this code is called.
org.jdom.Element	getMergedProperties(java.lang.String xpathValue) Deprecated.
java.util.ArrayList<Operation>	getOperations(java.lang.String view, java.lang.String xpath) Return operations based on the variable xpath.
java.util.ArrayList<Operation>	getOperations(java.lang.String view, java.lang.String[] xpath) Get all the operations that require more that one variable.
java.util.ArrayList<Operation>	getOperations(java.lang.String view, java.lang.String dsID, java.lang.String varID) Get operations for a data set and variable, either by the associated default or by the interval.
java.util.ArrayList<Operation>	getOperationsByDefault(java.lang.String view, java.lang.String ui_default) Get the operations that are include with a particular UI default
java.util.ArrayList<Operation>	getOperationsByIntervalAndGridType(java.lang.String view, java.lang.String grid_type) Get the operations based on the axes defined on an interval and the grid type.
java.util.ArrayList<NameValuePair>	getOperationsByView(java.lang.String view) Deprecated.
java.lang.String	getOptionID(java.lang.String operationID)
java.util.ArrayList<Option>	getOptions(java.lang.String optionID) Returns the options associated with this option ID
java.util.ArrayList<Option>	getOptionsByOperationID(java.lang.String operationID) Returns the options associated with this operation ID
java.lang.String	getOutputDir() Get the name of the output directory for this LAS
java.util.HashMap<java.lang.String,java.lang.String>	getPointsAndIntervals(java.lang.String varXPath)
java.util.ArrayList<NameValuePair>	getRangeForXY(java.lang.String varpath) Get xy region for a particular variable
java.lang.Boolean	getReadonly() Get the readonly attribute.
java.util.ArrayList<Region>	getRegions(java.lang.String dsID, java.lang.String varID) Get the pre-defined regions, by UI default based on the data set and variable.
java.util.ArrayList<NameValuePair>	getRegularVariables(java.lang.String dsID) Get all variables in a data set that are defined on a regular grid
java.lang.String	getServerURL() Get the URL of the product server.
java.lang.String	getService(java.lang.String opID) Get the name of the service based on the operation ID.
gov.noaa.pmel.tmap.las.ui.state.TimeSelector	getT(java.lang.String varpath) Get time selector object the specified variable
java.lang.String	getTemplate(java.lang.String id)
java.lang.String	getTemplateByXPath(java.lang.String XPath) Given the XPath to an operation return the output template that should be processed for this product
gov.noaa.pmel.tmap.las.test.LASTestOptions	getTestOptions() Read the test options from the configuration, if there are none return null.
TimeAxis	getTime(org.jdom.Element variable) Create a time axis with all the info needed for the DateWidgets
TimeAxis	getTime(java.lang.String varpath) Get time selector object the specified variable
java.util.ArrayList<Category>	getTimeSeriesDatasets()
java.lang.String	getTitle() Extracts the LAS title from the configuration
java.lang.String	getTopLevelCategoryID()
java.util.ArrayList<Tributary>	getTributaries()
java.util.ArrayList<Tributary>	getTributaries(java.lang.String attribute, java.lang.String value)
Tributary	getTributary(java.lang.String key)
org.jdom.Element	getUIDefault(java.lang.String ui_default) Get the default element based on its name
org.jdom.Element	getUIDefault(java.lang.String dsID, java.lang.String varID) Get the actual UI Default element
java.lang.String	getUIDefaultName(java.lang.String dsID, java.lang.String varID) Get the name of the UI Default associated with this variable.
org.jdom.Element	getUIMap(org.jdom.Element def, java.lang.String intype)
org.jdom.Element	getUIMenu(java.lang.String href)
java.util.ArrayList<java.lang.String>	getUIs() Extracts of list of known LAS UI Clients for this product server.
Variable	getVariable(java.lang.String dsID, java.lang.String varID) Returns a single variable from a given a dataset as a pmel.tmap.las.util.Variable object.
Variable	getVariableByXPath(java.lang.String xpath)
DataConstraint	getVariableConstraint(java.lang.String dsID, java.lang.String varID) Build a variable constraint from a particular variable
java.lang.String	getVariableIntervals(java.lang.String xpath)
java.lang.String	getVariableName(java.lang.String xpathValue) !!! does not work with V7 XML...Returns the netCDF variable name from the variable's XPath (the #var or the variable ID)
java.lang.String	getVariableName(java.lang.String dsID, java.lang.String varID)
java.lang.String	getVariablePoints(java.lang.String xpath)
java.util.HashMap	getVariableProperties(org.jdom.Element variable, java.lang.String group) Extract the properties group from a variable given its JDOM Element container as an Array List of NameValueBeans
org.jdom.Element	getVariableProperties(java.lang.String xpathValue) Extract the properties element from a variable given its XPath
java.util.HashMap	getVariableProperties(java.lang.String xpathValue, java.lang.String group) Extract the properties group from a variable given its XPath as an Array List of NameValueBeans
java.lang.String	getVariablePropertyValue(org.jdom.Element variable, java.lang.String group, java.lang.String property) Extract a property value from a variable element Array List of NameValueBeans
java.lang.String	getVariablePropertyValue(java.lang.String xpathValue, java.lang.String group, java.lang.String property) Extract a property value from a variable given its XPath as an Array List of NameValueBeans
java.util.ArrayList<Variable>	getVariables(java.lang.String dsID) Returns list of variables in given a dataset as pmel.tmap.las.util.Dataset objects.
java.util.ArrayList<NameValuePair>	getVariablesAsNameValueBeans(java.lang.String dsID) Returns list of variables give a dataset
java.lang.String	getVariableTitle(java.lang.String xpathValue) Extract the supposedly human interesting title of a variable
static java.lang.String	getVarIDfromXPath(java.lang.String xpath)
Variable	getVectorVariable(java.lang.String dsid, java.util.ArrayList<java.lang.String> varids) Get a vector variable from a data set that is made up of the components passed in as a list of variable ids.
java.util.ArrayList<View>	getViewsByDatasetAndVariable(java.lang.String dsID, java.lang.String varID)
java.util.ArrayList<View>	getViewsByDefault(java.lang.String ui_default)
java.util.ArrayList<View>	getViewsByXpath(java.lang.String[] xpaths)
boolean	hasCategories()
boolean	hasT(java.lang.String varpath) Returns true if a T axis is defined for this variable.
boolean	hasT(java.lang.String dsID, java.lang.String varID) Returns true if a T axis is defined for this variable.
boolean	hasZ(java.lang.String varpath) Returns true if a Z axis is defined for this variable.
boolean	hasZ(java.lang.String dsID, java.lang.String varID) Returns true if a Z axis is defined for this variable.
boolean	isLocal(java.lang.String id)
boolean	isRegular(java.lang.String dsID, java.lang.String varID)
java.util.ArrayList<gov.noaa.pmel.tmap.addxml.CategoryBean>	makeCategories(gov.noaa.pmel.tmap.addxml.DatasetsGridsAxesBean dgab) Makes and adds categories from a DatasetsGridsAxesBean probably from a single netCDF data source.
java.util.ArrayList<gov.noaa.pmel.tmap.addxml.CategoryBean>	makeCategoriesFromTHREDDS(java.lang.String src, boolean esg) Reads a THREDDS catalog and makes the categories to match the catalog.
void	mergeProperites() Merge all of the variable, dataset and global properties for each variable.
boolean	pruneCategories()
void	removeOldDatasets(org.joda.time.DateTime then)
void	removeRemoteVariables(java.lang.String JSESSIONID)
java.lang.String	resolveURLS(LASUIRequest lasRequest)
void	setGridType(org.jdom.Element variable) Descends the dataset and variable tree and set the grid_type attribute if it is not already set.
void	setOutputDir(java.lang.String dir) Helper method to set the output directory if need be
java.util.Vector<gov.noaa.pmel.tmap.addxml.DatasetsGridsAxesBean>	updateSrc(java.lang.String src, java.lang.String src_type, java.lang.String update_time, java.lang.String update_interval, java.util.HashMap<java.lang.String,java.lang.String> options)

Methods inherited from class gov.noaa.pmel.tmap.jdom.LASDocument

convertProperties, findProperty, findPropertyGroup, findPropertyGroup, findPropertyGroupList, findPropertyGroupList, findPropertyValue, getElementByXPath, getProperty, toCompactString, toEncodedJavaScriptSafeURLString, toEncodedURLString, toJavaScriptSafeString, toJSON, toJSON, toString, toString, write, write, write, writeElement

Methods inherited from class org.jdom.Document

addContent, addContent, addContent, addContent, clone, cloneContent, detachRootElement, equals, getBaseURI, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getDocType, getDocument, getParent, getProperty, getRootElement, hashCode, hasRootElement, indexOf, removeContent, removeContent, removeContent, removeContent, setBaseURI, setContent, setContent, setContent, setContent, setDocType, setProperty, setRootElement

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LASConfig

public LASConfig()

Method Detail

getIDMap

public java.util.Map<java.lang.String,java.lang.String> getIDMap(java.lang.String data_url)
                                                          throws org.jdom.JDOMException,
                                                                 gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getIDs

public java.lang.String getIDs(java.lang.String data_url)
                        throws org.jdom.JDOMException,
                               gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getFTDSTestURLs

public java.util.List<java.lang.String> getFTDSTestURLs(int max)

Return up to max direct and F-TDS URLs that can be tested. This just grabs them in order. Something more sophisticated could be done.

Parameters:

max -

Returns:

addFDS

public void addFDS(java.lang.String fds_base,
          java.lang.String fds_dir)
            throws gov.noaa.pmel.tmap.exception.LASException,
                   org.jdom.JDOMException,
                   java.io.IOException

Take F-TDS server URL and data directory and build the F-TDS URLs for each variable.

Parameters:

fds_base - the base URL of the F-TDS server http://server:port/thredds/dodsC

fds_dir - the directory into which the F-TDS journal files will be written

Throws:

gov.noaa.pmel.tmap.exception.LASException

JDOMExcption

IOFoundException

org.jdom.JDOMException

java.io.IOException

addGridType

public void addGridType()
                 throws gov.noaa.pmel.tmap.exception.LASException,
                        org.jdom.JDOMException

Descends the dataset and variable tree and set the grid_type attribute if it is not already set.

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

addIntervalsAndPoints

public void addIntervalsAndPoints()
                           throws gov.noaa.pmel.tmap.exception.LASException,
                                  org.jdom.JDOMException

Adds attributes to all variables that indicate whether or not the variable has a range or a point in the definition of each axis. Must be a version 7.0 style document before this method is invoked.

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

convertToSeven

public void convertToSeven(boolean force)
                    throws org.jdom.JDOMException,
                           java.io.UnsupportedEncodingException,
                           gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

java.io.UnsupportedEncodingException

gov.noaa.pmel.tmap.exception.LASException

convertToSeven

public void convertToSeven()
                    throws org.jdom.JDOMException,
                           java.io.UnsupportedEncodingException,
                           gov.noaa.pmel.tmap.exception.LASException

Converts to XML that can be validated against a schema, or returns if it detects that XML is already "Version 7".

Throws:

org.jdom.JDOMException

java.io.UnsupportedEncodingException

gov.noaa.pmel.tmap.exception.LASException

extractOptions

public java.util.ArrayList<Option> extractOptions(java.lang.String optionID)
                                           throws org.jdom.JDOMException

Helper method to recursively extract the options.

Throws:

org.jdom.JDOMException

getBaseServerURL

public java.lang.String getBaseServerURL()
                                  throws org.jdom.JDOMException

Get the base url of this LAS server (the server host, port and context path).

Returns:

base url of the LAS server family.

Throws:

org.jdom.JDOMException

getConstraints

public java.util.ArrayList<DataConstraint> getConstraints(java.lang.String dsID,
                                                 java.lang.String varID)
                                                   throws org.jdom.JDOMException

Get any applicable data constraints for a particular data set and variable.

Parameters:

dsID -

varID -

Returns:

the list of constraints

Throws:

org.jdom.JDOMException

getConstraintsHash

public java.util.HashMap<java.lang.String,DataConstraint> getConstraintsHash(java.lang.String dsID,
                                                                    java.lang.String varID)
                                                                      throws org.jdom.JDOMException

Get any applicable data constraints for a particular data set and variable as a HashMap keyed on the constraint ID.

Parameters:

dsID -

varID -

Returns:

the HashMap of constraints

Throws:

org.jdom.JDOMException

getConstraints

public java.util.ArrayList<DataConstraint> getConstraints(java.lang.String ui_default,
                                                 java.lang.String dsID,
                                                 java.lang.String varID)
                                                   throws org.jdom.JDOMException

Get any constraints from the named UI default.

Parameters:

ui_default -

Returns:

the constraints

Throws:

org.jdom.JDOMException

getConstraintsHash

public java.util.HashMap<java.lang.String,DataConstraint> getConstraintsHash(java.lang.String ui_default,
                                                                    java.lang.String dsID,
                                                                    java.lang.String varID)
                                                                      throws org.jdom.JDOMException

Get any constraints from the named UI default as a HashMap keyed on the constraint ID.

Parameters:

ui_default -

Returns:

the HashMap of constraints

Throws:

org.jdom.JDOMException

getVariableConstraint

public DataConstraint getVariableConstraint(java.lang.String dsID,
                                   java.lang.String varID)
                                     throws org.jdom.JDOMException

Build a variable constraint from a particular variable

Parameters:

dsID - the data set ID of the variable

varID - the variable id

Returns:

the data constraint for this variable

Throws:

org.jdom.JDOMException

getCategorySerializable

public gov.noaa.pmel.tmap.las.client.serializable.CategorySerializable[] getCategorySerializable(java.util.ArrayList<Category> categories)
                                                                                          throws gov.noaa.pmel.tmap.exception.LASException,
                                                                                                 org.jdom.JDOMException

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getCategories

public java.util.ArrayList<Category> getCategories(java.lang.String catid)
                                            throws org.jdom.JDOMException,
                                                   gov.noaa.pmel.tmap.exception.LASException

Get the categories directly below this id. If the id is null get the top.

Parameters:

catid -

Returns:

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDataAccessURL

public java.lang.String getDataAccessURL(java.lang.String xpath,
                                boolean fds)
                                  throws gov.noaa.pmel.tmap.exception.LASException,
                                         org.jdom.JDOMException

Get data access URL. If fds is set to true, then the FDS URL will be returned in every case. If the fds boolean is set to false, then the actual OPeNDAP URL of the remote data set will be returned where available. If no remote URL is available, the the FDS URL will be returned.

Parameters:

xpath - the XPath of the variable

fds - true if FDS URL is required

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDataAccessBrowserURL

public java.lang.String getDataAccessBrowserURL(java.lang.String xpath,
                                       boolean fds)
                                         throws gov.noaa.pmel.tmap.exception.LASException,
                                                org.jdom.JDOMException

Returns a URL for an LAS data set that will show something intelligible in the browser.

Parameters:

xpath -

fds -

Returns:

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getDataAccessURL

public java.lang.String getDataAccessURL(java.lang.String dsID,
                                java.lang.String varID,
                                boolean fds)
                                  throws gov.noaa.pmel.tmap.exception.LASException,
                                         org.jdom.JDOMException

Get data access URL. If fds is set to true, then the FDS URL will be returned in every case. If the fds boolean is set to false, then the actual OPeNDAP URL of the remote data set will be returned where available. If no remote URL is available, the the FDS URL will be returned.

Parameters:

dsID - the Dataset ID

varID - the Variable ID

fds - true if FDS URL is required

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDataAccessBrowserURL

public java.lang.String getDataAccessBrowserURL(java.lang.String dsID,
                                       java.lang.String varID,
                                       boolean fds)
                                         throws gov.noaa.pmel.tmap.exception.LASException,
                                                org.jdom.JDOMException

Return a link for an LAS data set that will return something itelligble to the browser.

Parameters:

dsID -

varID -

fds -

Returns:

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getDataObjectURL

public java.lang.String getDataObjectURL(org.jdom.Element variable)
                                  throws gov.noaa.pmel.tmap.exception.LASException,
                                         org.jdom.JDOMException

Returns the data access URL for a particular variable via the XPath of the variable (strips off the #var)

Parameters:

xpathValue - The XPath of the variable

Returns:

url The access ready URL OPeNDAP URL or filename.

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDataObjectURL

public java.lang.String getDataObjectURL(java.lang.String xpathValue)
                                  throws gov.noaa.pmel.tmap.exception.LASException,
                                         org.jdom.JDOMException

Returns the OPeNDAP ready data access URL for a particular variable via the XPath of the variable (strips off the #var)

Parameters:

xpathValue - The XPath of the variable

Returns:

url The access ready URL OPeNDAP URL or filename.

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDataOjectAttributes

public java.util.List getDataOjectAttributes(java.lang.String xpathValue)
                                      throws org.jdom.JDOMException

Return a list of attributes on the given element

Parameters:

xpathValue - The XPath to the element

Returns:

attribute The list of JDOM attributes on this element.

Throws:

org.jdom.JDOMException

addEnsembleIDs

public void addEnsembleIDs()
                    throws org.jdom.JDOMException,
                           gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDatasetAttributes

public java.util.HashMap<java.lang.String,java.lang.String> getDatasetAttributes(java.lang.String varXPath)
                                                                          throws org.jdom.JDOMException

Get all of the attributes from the parent data set element.

Parameters:

varXPath - the variable whose parent data set will be used

Returns:

the attributes

Throws:

org.jdom.JDOMException

getDatasetsAsCategories

public java.util.ArrayList<Category> getDatasetsAsCategories(boolean full)
                                                      throws org.jdom.JDOMException,
                                                             gov.noaa.pmel.tmap.exception.LASException

Returns all the datasets as gov.noaa.pmel.tmap.las.util.Dataset objects.

Returns:

ArrayList of dataset objects

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getFullDatasets

public java.util.ArrayList<Dataset> getFullDatasets()
                                             throws org.jdom.JDOMException,
                                                    gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDatasets

public java.util.ArrayList<Dataset> getDatasets()
                                         throws org.jdom.JDOMException,
                                                gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDatasets

public java.util.ArrayList<Dataset> getDatasets(boolean full)
                                         throws org.jdom.JDOMException,
                                                gov.noaa.pmel.tmap.exception.LASException

Returns all the datasets as gov.noaa.pmel.tmap.las.util.Dataset objects.

Returns:

ArrayList of dataset objects

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getDatasetsAsElement

public org.jdom.Element getDatasetsAsElement()

Return all datasets as a single "datasets" element.

getDataset

public Dataset getDataset(java.lang.String dsID)
                   throws org.jdom.JDOMException,
                          gov.noaa.pmel.tmap.exception.LASException

Get a <dataset> element base on the data set id

Parameters:

dsID - the id of the dataset

Returns:

the data set element

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getDatasetsAsNameValueBeans

public java.util.ArrayList<NameValuePair> getDatasetsAsNameValueBeans()

Deprecated.

!!!! returns datasets list This ignores categories for now. Have to fix this. Don't need this anymore

getFirstVariable

public java.lang.String getFirstVariable()

Get first variable from LASConfig.

Returns:

The XPath of the first variable in the LASConfig (the default)

getFullDataObjectURL

public java.lang.String getFullDataObjectURL(org.jdom.Element variable)
                                      throws gov.noaa.pmel.tmap.exception.LASException,
                                             org.jdom.JDOMException

Returns the full data URL for a particular variable (as identified by the variable element) including the #var (netCDF variable name convention used by LAS)

Parameters:

variable - The variable element of the variable whose data access URL is desired

Returns:

url The access URL (either a /path/path/filename#var or http://opendap_url#var).

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getFullDataObjectURL

public java.lang.String getFullDataObjectURL(java.lang.String dsid,
                                    java.lang.String varid)
                                      throws gov.noaa.pmel.tmap.exception.LASException,
                                             org.jdom.JDOMException

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getFullDataObjectURL

public java.lang.String getFullDataObjectURL(java.lang.String xpathValue)
                                      throws gov.noaa.pmel.tmap.exception.LASException,
                                             org.jdom.JDOMException

Returns the full data URL for a particular variable (as identified by its XPath) including the #var (netCDF variable name convention used by LAS)

Parameters:

xpathValue - The XPath of the variable whose data access URL is desired

Returns:

url The access URL (either a /path/path/filename#var or http://opendap_url#var).

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getGlobalPropertyValue

public java.lang.String getGlobalPropertyValue(java.lang.String group,
                                      java.lang.String name)

Get the value of a "global" property (a property in the config that is not in any particular data set or variable).

Parameters:

group - the name of the property group

name - the name of the property

Returns:

the value of specified property

getGlobalPropertyGroupAsHashMap

public java.util.HashMap<java.lang.String,java.lang.String> getGlobalPropertyGroupAsHashMap(java.lang.String name)
                                                                                     throws gov.noaa.pmel.tmap.exception.LASException

Throws:

gov.noaa.pmel.tmap.exception.LASException

getGrid

public Grid getGrid(java.lang.String varXPath)
             throws org.jdom.JDOMException,
                    gov.noaa.pmel.tmap.exception.LASException

Get the grid of a variable from its XPath

Parameters:

varXPath -

Returns:

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getGridById

public Grid getGridById(java.lang.String ID)
                 throws org.jdom.JDOMException,
                        gov.noaa.pmel.tmap.exception.LASException

Get the grid object with its axes filled by the grids ID.

Parameters:

the - ID

Returns:

the grid

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getGrid

public Grid getGrid(java.lang.String dsID,
           java.lang.String varID)
             throws org.jdom.JDOMException,
                    gov.noaa.pmel.tmap.exception.LASException

Get grid for a particular dataset and variable.

Parameters:

dsid - the id of the desired data set

varid - the id if the desired variable

Returns:

grid the Grid object with up to for Axes

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getGridType

public java.lang.String getGridType(java.lang.String dsID,
                           java.lang.String varID)
                             throws org.jdom.JDOMException

Get the grid_type for the variable (regular, scattered, ...)

Parameters:

dsID -

varID -

Throws:

org.jdom.JDOMException

getHi

public java.lang.String getHi(java.lang.String type,
                     java.lang.String varpath)
                       throws org.jdom.JDOMException

Get hi value for a particular axis type for the specified variable

Parameters:

varpath - XPath to the variable

type - which axis x,y,z or t

Throws:

org.jdom.JDOMException

getInstitution

public Institution getInstitution()
                           throws org.jdom.JDOMException

Get the container with all the information about the institution that installed this LAS.

Returns:

Institution the information about the place that installed this LAS.

Throws:

org.jdom.JDOMException

getLo

public java.lang.String getLo(java.lang.String type,
                     java.lang.String varpath)
                       throws org.jdom.JDOMException

Get lo value for a particular axis type for the specified variable. If it's the T axis you get a string with the low value, but you might want a TimeSelector instead.

Parameters:

varpath - XPath to the variable

type - which axis x,y,z or t

Throws:

org.jdom.JDOMException

getMergedProperties

public org.jdom.Element getMergedProperties(org.jdom.Element dsE)

Given a dataset element merge the properties (probably should be private) All properties should have been converted to "V7.0" style properties before this code is called.

Parameters:

dsE - The dataset element to merge

Returns:

datasetElement The same element with all of the new properites folded in to each variable.

getMergedProperties

public org.jdom.Element getMergedProperties(java.lang.String xpathValue)
                                     throws org.jdom.JDOMException

Deprecated.

!! temporarily busted for V7 XML -- Returns the merged properties for a particular (maybe this should be private) This /lasdata/datasets/DatasetTagName/variables/VariableTagName path and it should be /lasdata/datasets/dataset[@ID='DatasetID']/variables/variable[@ID='VariableID'].

Parameters:

xpathValue -

Returns:

Element The varaible element with the properties merged into it.

Throws:

org.jdom.JDOMException

getOperations

public java.util.ArrayList<Operation> getOperations(java.lang.String view,
                                           java.lang.String dsID,
                                           java.lang.String varID)
                                             throws org.jdom.JDOMException

Get operations for a data set and variable, either by the associated default or by the interval.

Throws:

org.jdom.JDOMException

getOperations

public java.util.ArrayList<Operation> getOperations(java.lang.String view,
                                           java.lang.String xpath)
                                             throws org.jdom.JDOMException

Return operations based on the variable xpath.

Parameters:

view -

xpath -

Returns:

Throws:

org.jdom.JDOMException

getDSIDfromXPath

public static java.lang.String getDSIDfromXPath(java.lang.String xpath)

getVarIDfromXPath

public static java.lang.String getVarIDfromXPath(java.lang.String xpath)

getOperations

public java.util.ArrayList<Operation> getOperations(java.lang.String view,
                                           java.lang.String[] xpath)
                                             throws gov.noaa.pmel.tmap.exception.LASException,
                                                    org.jdom.JDOMException

Get all the operations that require more that one variable.

Parameters:

view - the current UI view

xpath - the dataset/variable xpath of the selected variables

Returns:

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getOperationsByDefault

public java.util.ArrayList<Operation> getOperationsByDefault(java.lang.String view,
                                                    java.lang.String ui_default)
                                                      throws org.jdom.JDOMException

Get the operations that are include with a particular UI default

Parameters:

ui_default -

Returns:

operations JSONObject with the operations that are defined for this "default".

Throws:

org.jdom.JDOMException

getOperationsByIntervalAndGridType

public java.util.ArrayList<Operation> getOperationsByIntervalAndGridType(java.lang.String view,
                                                                java.lang.String grid_type)
                                                                  throws org.jdom.JDOMException

Get the operations based on the axes defined on an interval and the grid type.

Parameters:

view - The view to be matched to the interval specifications in the operation config

grid_type - the desired grid type

Returns:

the list of operations

Throws:

org.jdom.JDOMException

getOperationsByView

public java.util.ArrayList<NameValuePair> getOperationsByView(java.lang.String view)
                                                       throws org.jdom.JDOMException

Deprecated.

Selects operations that use interval inputs on the axes listed in the view

Parameters:

view - a string containing an ordered subset of xyzt.

Returns:

operations a list of operation elements that use this view

Throws:

org.jdom.JDOMException

getOptions

public java.util.ArrayList<Option> getOptions(java.lang.String optionID)
                                       throws org.jdom.JDOMException

Returns the options associated with this option ID

Parameters:

optionID - option ID

Returns:

options the options for this id.

Throws:

org.jdom.JDOMException

getOptionsByOperationID

public java.util.ArrayList<Option> getOptionsByOperationID(java.lang.String operationID)
                                                    throws org.jdom.JDOMException

Returns the options associated with this operation ID

Parameters:

operationID - operation ID

Returns:

options the options for this operation.

Throws:

org.jdom.JDOMException

getOptionID

public java.lang.String getOptionID(java.lang.String operationID)
                             throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

getOutputDir

public java.lang.String getOutputDir()

Get the name of the output directory for this LAS

Returns:

outputdir The path to the output directory.

getReadonly

public java.lang.Boolean getReadonly()

Get the readonly attribute. This is for SOCAT and is assumed false if attribute is not present.

Returns:

readonly attribute.

getRangeForXY

public java.util.ArrayList<NameValuePair> getRangeForXY(java.lang.String varpath)
                                                 throws org.jdom.JDOMException

Get xy region for a particular variable

Parameters:

varpath - XPath to variable

Returns:

region ArrayList of NameValueBeans with x_lo, x_hi, y_lo and y_hi

Throws:

org.jdom.JDOMException

getRegions

public java.util.ArrayList<Region> getRegions(java.lang.String dsID,
                                     java.lang.String varID)
                                       throws org.jdom.JDOMException

Get the pre-defined regions, by UI default based on the data set and variable.

Parameters:

dsID -

varID -

Returns:

Throws:

org.jdom.JDOMException

getRegularVariables

public java.util.ArrayList<NameValuePair> getRegularVariables(java.lang.String dsID)
                                                       throws org.jdom.JDOMException

Get all variables in a data set that are defined on a regular grid

Parameters:

dsID - the data set

Returns:

the list of variables

Throws:

org.jdom.JDOMException

getServerURL

public java.lang.String getServerURL()
                              throws org.jdom.JDOMException

Get the URL of the product server. This URL should be correct even if the server is being proxied through Apache.

Throws:

org.jdom.JDOMException

getService

public java.lang.String getService(java.lang.String opID)
                            throws org.jdom.JDOMException

Get the name of the service based on the operation ID.

Parameters:

opID - the ID of the operation

Returns:

service the name of the service associated with this operation

Throws:

org.jdom.JDOMException

getT

public gov.noaa.pmel.tmap.las.ui.state.TimeSelector getT(java.lang.String varpath)
                                                  throws org.jdom.JDOMException

Get time selector object the specified variable

Parameters:

varpath - XPath to the variable

Throws:

org.jdom.JDOMException

getTemplate

public java.lang.String getTemplate(java.lang.String id)
                             throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

getTemplateByXPath

public java.lang.String getTemplateByXPath(java.lang.String XPath)
                                    throws org.jdom.JDOMException

Given the XPath to an operation return the output template that should be processed for this product

Parameters:

XPath - The path to the operation element (an XPath looks like this: /lasdata/operations/operation[@ID='Plot_2D_XY_zoom']

Returns:

output_template The name of the template (which will be resolve using the class loader and the backend config information)

Throws:

org.jdom.JDOMException

getFTDSURL

public java.lang.String getFTDSURL(org.jdom.Element variable)

Get the F-TDS URL for this variable

Parameters:

variable - the variable element

Returns:

the F-TDS URL

Throws:

org.jdom.JDOMException

getFTDSURL

public java.lang.String getFTDSURL(java.lang.String varXPath)
                            throws org.jdom.JDOMException

Get the F-TDS URL for the variable specified by the XPath

Parameters:

varXPath - the XPath of the variable

Returns:

the F-TDS URL

Throws:

org.jdom.JDOMException

getFTDSURL

public java.lang.String getFTDSURL(java.lang.String dsID,
                          java.lang.String varID)
                            throws org.jdom.JDOMException

Get the F-TDS URL for the variable specified by the dsID and varID

Parameters:

dsID - of the variable

varID - of the variable

Returns:

the F-TDS URL

Throws:

org.jdom.JDOMException

getTime

public TimeAxis getTime(org.jdom.Element variable)
                 throws org.jdom.JDOMException,
                        gov.noaa.pmel.tmap.exception.LASException

Create a time axis with all the info needed for the DateWidgets

Parameters:

variable - the variable whose time axis will be built

Returns:

the time axis specification

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getTime

public TimeAxis getTime(java.lang.String varpath)
                 throws org.jdom.JDOMException,
                        gov.noaa.pmel.tmap.exception.LASException

Get time selector object the specified variable

Parameters:

varpath - XPath to the variable

Throws:

gov.noaa.pmel.tmap.exception.LASException

org.jdom.JDOMException

getTitle

public java.lang.String getTitle()
                          throws org.jdom.JDOMException

Extracts the LAS title from the configuration

Returns:

title The title of this LAS

Throws:

org.jdom.JDOMException

getUIDefaultName

public java.lang.String getUIDefaultName(java.lang.String dsID,
                                java.lang.String varID)
                                  throws org.jdom.JDOMException

Get the name of the UI Default associated with this variable.

Parameters:

dsID - the data set

varID - the variable

Returns:

the UI Default name; can be null

Throws:

org.jdom.JDOMException

getUIDefault

public org.jdom.Element getUIDefault(java.lang.String dsID,
                            java.lang.String varID)
                              throws org.jdom.JDOMException

Get the actual UI Default element

Parameters:

dsID - the data set

varID - the variable

Returns:

the default element (can be null)

Throws:

org.jdom.JDOMException

getUIDefault

public org.jdom.Element getUIDefault(java.lang.String ui_default)

Get the default element based on its name

Parameters:

ui_default - the name of the desired default

Returns:

the default element (can be null)

getUIMap

public org.jdom.Element getUIMap(org.jdom.Element def,
                        java.lang.String intype)
                          throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

getUIMenu

public org.jdom.Element getUIMenu(java.lang.String href)
                           throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

getUIs

public java.util.ArrayList<java.lang.String> getUIs()

Extracts of list of known LAS UI Clients for this product server.

Returns:

ui_url_list a list of URLs of known LAS UI Clients for this server

Throws:

org.jdom.JDOMException

getVariableByXPath

public Variable getVariableByXPath(java.lang.String xpath)
                            throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

getVariableIntervals

public java.lang.String getVariableIntervals(java.lang.String xpath)
                                      throws org.jdom.JDOMException,
                                             gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getVariableName

public java.lang.String getVariableName(java.lang.String xpathValue)
                                 throws gov.noaa.pmel.tmap.exception.LASException,
                                        org.jdom.JDOMException

!!! does not work with V7 XML...Returns the netCDF variable name from the variable's XPath (the #var or the variable ID)

Parameters:

xpathValue - The XPath of the variable

Returns:

var The netCDF variable name

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getVariableName

public java.lang.String getVariableName(java.lang.String dsID,
                               java.lang.String varID)
                                 throws org.jdom.JDOMException,
                                        gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getVariablePoints

public java.lang.String getVariablePoints(java.lang.String xpath)
                                   throws org.jdom.JDOMException,
                                          gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getVariableProperties

public java.util.HashMap getVariableProperties(org.jdom.Element variable,
                                      java.lang.String group)
                                        throws org.jdom.JDOMException

Extract the properties group from a variable given its JDOM Element container as an Array List of NameValueBeans

Parameters:

variable - Element an XML variable element

group - the name of the property group to extract

Returns:

properties The an array list of properties.

Throws:

org.jdom.JDOMException

getVariableProperties

public org.jdom.Element getVariableProperties(java.lang.String xpathValue)
                                       throws org.jdom.JDOMException

Extract the properties element from a variable given its XPath

Parameters:

xpathValue - The XPath of the variable to find.

Returns:

properties The properties element.

Throws:

org.jdom.JDOMException

getVariableProperties

public java.util.HashMap getVariableProperties(java.lang.String xpathValue,
                                      java.lang.String group)
                                        throws org.jdom.JDOMException

Extract the properties group from a variable given its XPath as an Array List of NameValueBeans

Parameters:

xpathValue - The XPath of the variable to find.

Returns:

properties The an array list of properties.

Throws:

org.jdom.JDOMException

getVariablePropertyValue

public java.lang.String getVariablePropertyValue(org.jdom.Element variable,
                                        java.lang.String group,
                                        java.lang.String property)
                                          throws org.jdom.JDOMException

Extract a property value from a variable element Array List of NameValueBeans

Parameters:

xpathValue - The XPath of the variable to find.

Returns:

value the property value

Throws:

org.jdom.JDOMException

getVariablePropertyValue

public java.lang.String getVariablePropertyValue(java.lang.String xpathValue,
                                        java.lang.String group,
                                        java.lang.String property)
                                          throws org.jdom.JDOMException

Extract a property value from a variable given its XPath as an Array List of NameValueBeans

Parameters:

xpathValue - The XPath of the variable to find.

Returns:

value the property value

Throws:

org.jdom.JDOMException

getVariables

public java.util.ArrayList<Variable> getVariables(java.lang.String dsID)
                                           throws org.jdom.JDOMException

Returns list of variables in given a dataset as pmel.tmap.las.util.Dataset objects.

Parameters:

dsID - ID of the dataset for which variables should be listed.

Returns:

variables Array list of variables

Throws:

org.jdom.JDOMException

getVariable

public Variable getVariable(java.lang.String dsID,
                   java.lang.String varID)
                     throws org.jdom.JDOMException

Returns a single variable from a given a dataset as a pmel.tmap.las.util.Variable object.

Parameters:

dsID - ID of the dataset that contains the variable

varID - ID of the variable

Returns:

variable Variable object

Throws:

org.jdom.JDOMException

getVariablesAsNameValueBeans

public java.util.ArrayList<NameValuePair> getVariablesAsNameValueBeans(java.lang.String dsID)
                                                                throws org.jdom.JDOMException

Returns list of variables give a dataset

Parameters:

dsID - ID of the dataset for which variables should be listed.

Returns:

variables Array list of variables

Throws:

org.jdom.JDOMException

getVectorVariable

public Variable getVectorVariable(java.lang.String dsid,
                         java.util.ArrayList<java.lang.String> varids)
                           throws org.jdom.JDOMException

Get a vector variable from a data set that is made up of the components passed in as a list of variable ids.

Parameters:

dsid -

varids -

Returns:

Throws:

org.jdom.JDOMException

getVariableTitle

public java.lang.String getVariableTitle(java.lang.String xpathValue)
                                  throws org.jdom.JDOMException

Extract the supposedly human interesting title of a variable

Parameters:

xpathValue - The XPath of the variable

Returns:

title The title of the variable (Not to quibble but, it's actually the name attibute)

Throws:

org.jdom.JDOMException

getViewsByXpath

public java.util.ArrayList<View> getViewsByXpath(java.lang.String[] xpaths)
                                          throws org.jdom.JDOMException,
                                                 gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getViewsByDatasetAndVariable

public java.util.ArrayList<View> getViewsByDatasetAndVariable(java.lang.String dsID,
                                                     java.lang.String varID)
                                                       throws org.jdom.JDOMException,
                                                              gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getViewsByDefault

public java.util.ArrayList<View> getViewsByDefault(java.lang.String ui_default)
                                            throws org.jdom.JDOMException

Parameters:

ui_default -

Returns:

Throws:

org.jdom.JDOMException

hasT

public boolean hasT(java.lang.String varpath)
             throws org.jdom.JDOMException

Returns true if a T axis is defined for this variable.

Parameters:

varpath - XPath of the variable to check

Returns:

hasZ boolean

Throws:

org.jdom.JDOMException

hasT

public boolean hasT(java.lang.String dsID,
           java.lang.String varID)
             throws org.jdom.JDOMException

Returns true if a T axis is defined for this variable.

Parameters:

dsID - ID of the dataset to check

varID - ID of the variable to check

Returns:

hasZ boolean

Throws:

org.jdom.JDOMException

hasZ

public boolean hasZ(java.lang.String varpath)
             throws org.jdom.JDOMException

Returns true if a Z axis is defined for this variable.

Parameters:

varpath - XPath of the variable to check

Returns:

hasZ boolean

Throws:

org.jdom.JDOMException

hasZ

public boolean hasZ(java.lang.String dsID,
           java.lang.String varID)
             throws org.jdom.JDOMException

Returns true if a Z axis is defined for this variable.

Parameters:

dsID - ID of the dataset to check

varID - ID of the variable to check

Returns:

hasZ boolean

Throws:

org.jdom.JDOMException

isRegular

public boolean isRegular(java.lang.String dsID,
                java.lang.String varID)
                  throws org.jdom.JDOMException

Throws:

org.jdom.JDOMException

mergeProperites

public void mergeProperites()

Merge all of the variable, dataset and global properties for each variable. Variable properties override dataset properties which in turn override "global" properties (those defined under the /lasdata element).

setGridType

public void setGridType(org.jdom.Element variable)
                 throws org.jdom.JDOMException

Descends the dataset and variable tree and set the grid_type attribute if it is not already set.

Throws:

org.jdom.JDOMException

setOutputDir

public void setOutputDir(java.lang.String dir)

Helper method to set the output directory if need be

Parameters:

dir - The path to the directory

getTimeSeriesDatasets

public java.util.ArrayList<Category> getTimeSeriesDatasets()
                                                    throws gov.noaa.pmel.tmap.exception.LASException

Throws:

gov.noaa.pmel.tmap.exception.LASException

hasCategories

public boolean hasCategories()

addXML

public long addXML(boolean update,
          Cache cache)
            throws java.io.IOException,
                   org.jdom.JDOMException

Create or update LAS metadata directly from a netCDF or THREDDS data source.

Parameters:

update -

cache -

Returns:

Throws:

java.io.IOException

org.jdom.JDOMException

makeCategories

public java.util.ArrayList<gov.noaa.pmel.tmap.addxml.CategoryBean> makeCategories(gov.noaa.pmel.tmap.addxml.DatasetsGridsAxesBean dgab)

Makes and adds categories from a DatasetsGridsAxesBean probably from a single netCDF data source.

Parameters:

dgab -

makeCategoriesFromTHREDDS

public java.util.ArrayList<gov.noaa.pmel.tmap.addxml.CategoryBean> makeCategoriesFromTHREDDS(java.lang.String src,
                                                                                    boolean esg)

Reads a THREDDS catalog and makes the categories to match the catalog.

Parameters:

src -

addSrc

public long addSrc(gov.noaa.pmel.tmap.addxml.DatasetsGridsAxesBean dgab,
          int src_index,
          org.jdom.Element dsetsE,
          org.jdom.Element dataset,
          java.util.ArrayList<org.jdom.Element> src_datasets,
          java.util.ArrayList<org.jdom.Element> src_grids,
          java.util.ArrayList<org.jdom.Element> src_axes,
          java.util.HashMap<java.lang.String,java.util.ArrayList<org.jdom.Element>> ds_children,
          Cache cache,
          java.lang.String src_key)
            throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

updateSrc

public java.util.Vector<gov.noaa.pmel.tmap.addxml.DatasetsGridsAxesBean> updateSrc(java.lang.String src,
                                                                          java.lang.String src_type,
                                                                          java.lang.String update_time,
                                                                          java.lang.String update_interval,
                                                                          java.util.HashMap<java.lang.String,java.lang.String> options)

addCategories

public void addCategories(java.util.ArrayList<gov.noaa.pmel.tmap.addxml.CategoryBean> cats)

Adds the contents of a category bean from addXML to the config, creating the las_categories element if necessary.

Parameters:

cat - the category bean to be added.

getTributaries

public java.util.ArrayList<Tributary> getTributaries()

getTributaries

public java.util.ArrayList<Tributary> getTributaries(java.lang.String attribute,
                                            java.lang.String value)

getTributary

public Tributary getTributary(java.lang.String key)

addServerID

public void addServerID()
                 throws java.io.UnsupportedEncodingException,
                        org.jdom.JDOMException

Throws:

java.io.UnsupportedEncodingException

org.jdom.JDOMException

allowsSisters

public boolean allowsSisters()

pruneCategories

public boolean pruneCategories()

isLocal

public boolean isLocal(java.lang.String id)
                throws java.io.UnsupportedEncodingException,
                       org.jdom.JDOMException

Throws:

java.io.UnsupportedEncodingException

org.jdom.JDOMException

getBaseServerURLKey

public java.lang.String getBaseServerURLKey()
                                     throws java.io.UnsupportedEncodingException,
                                            org.jdom.JDOMException

Throws:

java.io.UnsupportedEncodingException

org.jdom.JDOMException

getTopLevelCategoryID

public java.lang.String getTopLevelCategoryID()
                                       throws java.io.UnsupportedEncodingException,
                                              org.jdom.JDOMException

Throws:

java.io.UnsupportedEncodingException

org.jdom.JDOMException

getFullVariables

public java.util.ArrayList<Variable> getFullVariables(java.lang.String dsID)
                                               throws org.jdom.JDOMException,
                                                      gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getFullDataset

public Dataset getFullDataset(java.lang.String dsID)
                       throws org.jdom.JDOMException,
                              gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getFullDatasetNoGrids

public Dataset getFullDatasetNoGrids(java.lang.String dsID)
                              throws org.jdom.JDOMException,
                                     gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

resolveURLS

public java.lang.String resolveURLS(LASUIRequest lasRequest)
                             throws org.jdom.JDOMException,
                                    gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

removeRemoteVariables

public void removeRemoteVariables(java.lang.String JSESSIONID)

addRemoteVariables

public void addRemoteVariables(java.lang.String JSESSIONID,
                      LASUIRequest lasRequest)
                        throws org.apache.commons.httpclient.HttpException,
                               java.io.IOException,
                               org.jdom.JDOMException,
                               gov.noaa.pmel.tmap.exception.LASException

Throws:

org.apache.commons.httpclient.HttpException

java.io.IOException

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getEnsembleMembers

public java.util.Map<java.lang.String,java.lang.String> getEnsembleMembers(java.lang.String[] dsID)
                                                                    throws org.jdom.JDOMException,
                                                                           gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

getTestOptions

public gov.noaa.pmel.tmap.las.test.LASTestOptions getTestOptions()

Read the test options from the configuration, if there are none return null. Options are:

Returns:

getPointsAndIntervals

public java.util.HashMap<java.lang.String,java.lang.String> getPointsAndIntervals(java.lang.String varXPath)
                                                                           throws org.jdom.JDOMException,
                                                                                  gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

addDataset

public java.lang.String addDataset(java.lang.String id)
                            throws org.jdom.JDOMException,
                                   org.apache.commons.httpclient.HttpException,
                                   java.io.IOException,
                                   gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

org.apache.commons.httpclient.HttpException

java.io.IOException

gov.noaa.pmel.tmap.exception.LASException

getCategorySerializableWithGrids

public gov.noaa.pmel.tmap.las.client.serializable.CategorySerializable getCategorySerializableWithGrids(java.lang.String catid,
                                                                                               java.lang.String dsid)
                                                                                                 throws gov.noaa.pmel.tmap.exception.LASException

Throws:

gov.noaa.pmel.tmap.exception.LASException

getCategoriesSerializable

public gov.noaa.pmel.tmap.las.client.serializable.CategorySerializable[] getCategoriesSerializable(java.lang.String[] ids)
                                                                                            throws gov.noaa.pmel.tmap.exception.LASException

Throws:

gov.noaa.pmel.tmap.exception.LASException

getGridSerializable

public gov.noaa.pmel.tmap.las.client.serializable.GridSerializable getGridSerializable(java.lang.String dsID,
                                                                              java.lang.String varID)
                                                                                throws gov.noaa.pmel.tmap.exception.LASException

Throws:

gov.noaa.pmel.tmap.exception.LASException

getERDDAPConstraintGroups

public java.util.List<gov.noaa.pmel.tmap.las.client.serializable.ERDDAPConstraintGroup> getERDDAPConstraintGroups(java.lang.String dsid)
                                                                                                           throws org.jdom.JDOMException,
                                                                                                                  gov.noaa.pmel.tmap.exception.LASException

Throws:

org.jdom.JDOMException

gov.noaa.pmel.tmap.exception.LASException

removeOldDatasets

public void removeOldDatasets(org.joda.time.DateTime then)
                       throws java.lang.Exception

Throws:

java.lang.Exception