org.das2.catalog.DasNode

A single node from the das2 federated catalog, which may, or may not, be fully realized from source data.

getRoot

Return the highest node reachable by this catalog node.

Returns:

the highest node reachable by this catalog node, which may just be itself.

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isDir

isDir( ) → boolean

Can this catalog node have the sub-nodes?

Returns:

true if this node can have child nodes, not that it necessarily contains any.

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isInfo

isInfo( ) → boolean

Is this object an information node.

Returns:

true if this node in the catalog provides a description of a mission, spacecraft, instrument, person or any other item category

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isLoaded

isLoaded( ) → boolean

Does this node have a full definition

Returns:

True if this node successfully passed the second construction stage.

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isRoot

isRoot( ) → boolean

Is this object a detached root of a catalog tree. Note that the build in root URLs are always detached roots because there is no higher node to find. A detached source or info node can still be a root node without also being a directory.

Returns:

true if no higher node is reachable from this one.

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isSrc

isSrc( ) → boolean

Can this catalog node provide data

Returns:

true if this node describes one or more data sources

[search for examples] [view on GitHub] [view on old javadoc] [view source]

load

load( ProgressMonitor mon ) → void

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.

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

name

name( ) → String

get the node name

Returns:

The human readable name of the node, not it's path ID

[search for examples] [view on GitHub] [view on old javadoc] [view source]

path

path( ) → String

get the node path

Returns:

The catalog path to this node. For root nodes this is null

[search for examples] [view on GitHub] [view on old javadoc] [view source]

prop

prop( String sFragment, Object oDefault ) → org.das2.catalog.DasProp

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.

[search for examples] [view on GitHub] [view on old javadoc] [view source]

prop

prop( String sFragment ) → org.das2.catalog.DasProp

Get a property of a node

Parameters

sFragment - a String

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.

[search for examples] [view on GitHub] [view on old javadoc] [view source]

toString

toString( ) → String

A summary of the node

Returns:

A short string describing the node, not an info dump of the contents

[search for examples] [view on GitHub] [view on old javadoc] [view source]

type

type( ) → String

Get the node type.

Returns:

A string representing the node type

[search for examples] [view on GitHub] [view on old javadoc] [view source]