org.das2.catalog.impl

Class HttpGetSrcNode

java.lang.Object

org.das2.catalog.impl.AbstractNode

org.das2.catalog.impl.AbstractSrcNode

org.das2.catalog.impl.HttpGetSrcNode

All Implemented Interfaces:

DasNode, DasSrcNode

public class HttpGetSrcNode
extends AbstractSrcNode

Engine for turning parameter settings into HTTP GET URLs

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Fields inherited from class org.das2.catalog.impl.AbstractNode

lLocs, parent, sName

Constructor Summary

Constructors

Constructor and Description
HttpGetSrcNode(DasDirNode parent, java.lang.String name, java.util.List<java.lang.String> locations)

Method Summary

Modifier and Type	Method and Description
protected void	initFromJson(JSONObject jo)
boolean	isLoaded() Does this node have a full definition
void	load(ProgressMonitor mon) Phase 2 construction for the node.
DasProp	prop(java.lang.String sFragment) Get a property of a node
DasProp	prop(java.lang.String sFragment, java.lang.Object oDefault) Get a property of the node, or the default Similar to sub-page references for web-pages, property values are retrieved by providing a fragment path.
QDataSet	query(java.util.Map<java.lang.String,java.lang.String> dQuery) Given a parameter query string, get the access information.
boolean	queryVerify(java.util.Map<java.lang.String,java.lang.String> dQuery) Determine if the given list of query parameters are valid
java.lang.String	type() Get the node type.

Methods inherited from class org.das2.catalog.impl.AbstractSrcNode

isDir, isInfo, isSrc

Methods inherited from class org.das2.catalog.impl.AbstractNode

getRoot, isRoot, name, path, prettyPrintLoc, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.das2.catalog.DasNode

getRoot, isRoot, name, path, toString

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

HttpGetSrcNode

public HttpGetSrcNode(DasDirNode parent,
                      java.lang.String name,
                      java.util.List<java.lang.String> locations)

Method Detail

type

public java.lang.String type()

Description copied from interface: DasNode

Get the node type.

Returns:

A string representing the node type

isLoaded

public boolean isLoaded()

Description copied from interface: DasNode

Does this node have a full definition

Returns:

True if this node successfully passed the second construction stage.

initFromJson

protected void initFromJson(JSONObject jo)
                     throws JSONException,
                            java.text.ParseException

Throws:

JSONException

java.text.ParseException

prop

public DasProp prop(java.lang.String sFragment,
                    java.lang.Object oDefault)

Description copied from interface: DasNode

Get a property of the node, or the default Similar to sub-page references for web-pages, property values are retrieved by providing a fragment path. Fragment paths are standardized using the '/' as the sub-item separator. By combining node paths with fragment paths every single property value within the global catalog system has a unique URI. For example: :tag:das2.org,2012:site:/uiowa/voyager/1/pws#interface/coords/time/max/value ^ ^ ^ ^ ^ | | | | | | | | +- path +- fragment | | +- date | +- authority +-- scheme The purpose of this function is to retrieve properties from within a node given a fragment string.

Parameters:

sFragment - The fragment path, for example "tech_contact/0/email"

oDefault - The default object to return if nothing exists at the fragment location. The object will be wrapped as a DasProp, so it must be null or one of the accepted object types defined for constructing DasProp objects.

Returns:

A DasProp. If load has not been called for this node, the return will always be the default.

prop

public DasProp prop(java.lang.String sFragment)

Description copied from interface: DasNode

Get a property of a node

Returns:

The property at the given fragment location or null DasProp if the given path does not lead to a property. If load() has not been called for this node the return will always be null.

load

public void load(ProgressMonitor mon)
          throws DasResolveException

Description copied from interface: DasNode

Phase 2 construction for the node. DasNode objects exist to represent remote catalog data. Since one catalog node can point to others, it is possible to create a stub node that knows how to load itself, but is not actually loaded yet. This function can be used to trigger full catalog node resolution. This will trigger a re-load if the node is already loaded.

Parameters:

mon - A human amusement device incase network operations are taking a while.

Throws:

DasResolveException

query

public QDataSet query(java.util.Map<java.lang.String,java.lang.String> dQuery)

Description copied from interface: DasSrcNode

Given a parameter query string, get the access information. In an ideal world this would just return the dataset itself. But that is the point of the org.autoplot.DataSource interface and it's on the fly factory discovery.

Returns:

queryVerify

public boolean queryVerify(java.util.Map<java.lang.String,java.lang.String> dQuery)

Description copied from interface: DasSrcNode

Determine if the given list of query parameters are valid

Returns:

True if this set of parameters is valid, false otherwise