gov.noaa.pmel.tmap.las.jdom

Class LASDapperBackendRequest

java.lang.Object

org.jdom.Document

gov.noaa.pmel.tmap.jdom.LASDocument

gov.noaa.pmel.tmap.las.jdom.LASBackendRequest

gov.noaa.pmel.tmap.las.jdom.LASDapperBackendRequest

All Implemented Interfaces:

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

public class LASDapperBackendRequest
extends LASBackendRequest

A subclass of LASBackendRequest, specific to Dapper requests.

Author:

Bob Simons (bob.simons@noaa.gov)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LASDapperBackendRequest()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAxisConstraint(java.lang.String axis) This generates the axis' constraint arrayList.
java.util.ArrayList<java.lang.String>	getAxisConstraintArrayList(java.lang.String axis) This generates the axis' constraint arrayList.
java.util.ArrayList	getConstraintsByType(java.lang.String type) Returns an array list of gov.noaa.pmel.tmap.las.util.Constraint objects of the specified type (e.g., "variable", "text").
java.lang.String	getOpendapConstraint() This returns the "variable" constraints (from getConstraintsByType("variable")) as an opendap constraint string, e.g., "&genus=Macrocystis&species=integrifolia".
java.lang.String	getRequiredDatabaseProperty(java.lang.String propertyName) This returns a required databaseProperty.
static java.lang.String	required(java.lang.String s, java.lang.String id) This throws an LASException("Required value wasn't specified: " + id) if s is null or "".

Methods inherited from class gov.noaa.pmel.tmap.las.jdom.LASBackendRequest

getAnalysisAxes, getAxisAsConstraint, getAxisAsDRDSConstraint, getCancelFile, getChainedData, getChainedDataFile, getChainedDataURL, getConstraint, getConstraintRHS, getConstraints, getConstraintsAsSymbols, getConstraintString, getDataAsSymbols, getDataAttribute, getDatabaseProperty, getDatabaseTime, getDatabaseTime, getDatabaseTimeAsDouble, getDatabaseXhi, getDatabaseXlo, getDataCount, getDataSymbols, getDataSymbols, getDRDSVariableConstraintString, getFerretSymbols, getJSESSIONID, getKey, getMissingConstraint, getProductTimeout, getProgressTimeout, getPropertyGroup, getPropertyValuesCommaSeparated, getRegionAsConstraint, getRegionsAsSymbols, getRemoteURL, getResult, getResultAsFile, getResultAsFileByType, getResultCount, getResultFileName, getResultID, getResultMimeType, getResultType, getResultURL, getService, getServiceAction, getSymbols, getSymbols, getThi, getThi, getThi, getThi, getTlo, getTlo, getTlo, getTlo, getVariables, getVariablesAsString, getVariablesAsStringWithIFNULL, getXhi, getXlo, getYhi, getYlo, getZhi, getZlo, hasVariable, isCanceled, isCancelRequest, isRemote, isTrajectory, mapResultToURL, removeProperty, removePropertyExcludedGroups, removePropertyGroup, runRemote, setCancel, setLocalFileNames

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

LASDapperBackendRequest

public LASDapperBackendRequest()

Method Detail

required

public static java.lang.String required(java.lang.String s,
                        java.lang.String id)
                                 throws gov.noaa.pmel.tmap.exception.LASException

This throws an LASException("Required value wasn't specified: " + id) if s is null or "". [This method could be in LASBackendRequest.]

Parameters:

s - a string which may be null or ""

id - e.g., "database_access property 'url'"

Returns:

s (for convenience)

Throws:

LASException("Required - value wasn't specified: " + id) if s is null or "".

gov.noaa.pmel.tmap.exception.LASException

getRequiredDatabaseProperty

public java.lang.String getRequiredDatabaseProperty(java.lang.String propertyName)
                                             throws gov.noaa.pmel.tmap.exception.LASException

This returns a required databaseProperty. [This method could be part of TemplateTool.]

Parameters:

propertyName -

Returns:

the reqested databaseProperty.

Throws:

gov.noaa.pmel.tmap.exception.LASException - if the property isn't found or is "".

getAxisConstraint

public java.lang.String getAxisConstraint(java.lang.String axis)
                                   throws gov.noaa.pmel.tmap.exception.LASException

This generates the axis' constraint arrayList.

Parameters:

axis - "y", "z", or "t" (not "x")

Returns:

the constraint for the axis, with the ampersand prefix (or "" if none).

Throws:

gov.noaa.pmel.tmap.exception.LASException - if trouble

getAxisConstraintArrayList

public java.util.ArrayList<java.lang.String> getAxisConstraintArrayList(java.lang.String axis)
                                                                 throws gov.noaa.pmel.tmap.exception.LASException

This generates the axis' constraint arrayList.

Parameters:

axis - "x", "y", "z", or "t"

Returns:

the constraints for the axis. For "x", there may be 0, 1, or 2 constraints. For the others, there may be 0 or 1 constraints. Each constraint includes the ampersand prefix.

Throws:

gov.noaa.pmel.tmap.exception.LASException - if trouble

getConstraintsByType

public java.util.ArrayList getConstraintsByType(java.lang.String type)

Returns an array list of gov.noaa.pmel.tmap.las.util.Constraint objects of the specified type (e.g., "variable", "text").

 <constraint type="variable">
   <lhs>genus</lhs>
   <op>eq</op>
   <rhs>Macrocystis</rhs>
 </constraint>
 

Returns:

constraints an ArrayList of gov.noaa.pmel.tmap.las.util.Constraint objects

getOpendapConstraint

public java.lang.String getOpendapConstraint()

This returns the "variable" constraints (from getConstraintsByType("variable")) as an opendap constraint string, e.g., "&genus=Macrocystis&species=integrifolia".

Returns:

the "variable" constraints (from getConstraintsByType("variable")) as an opendap constraint string. Returns "" if no variable constraints. There is no checking of the validity of the constraints.

Throws:

java.lang.Exception - if trouble, e.g., unknown op