hydroScalingAPI.io
Class MetaLocation

java.lang.Object
  hydroScalingAPI.io.MetaLocation

All Implemented Interfaces:

java.lang.Comparable

public class MetaLocation
extends java.lang.Object
implements java.lang.Comparable

Manages the Gauge-type data object

Author:

Ricardo Mantilla

Constructor Summary

MetaLocation(DB_Register register)
Creates a new instance of MetaLocation

Method Summary

int	compareTo(java.lang.Object obj) The comparison criteria
java.util.Vector[]	getImagesList() Returns and array of Vector.
java.lang.String	getInformation() Provides additional information associated with the location
visad.RealTuple	getPositionTuple() Returns an RealTuple
java.lang.Object	getProperty(java.lang.String key) Returns the desired property.
visad.Tuple	getTextTuple() Returns an Tuple
boolean	hasImages() True if it has associated images
java.lang.String	toString() A String describing the Location

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaLocation

public MetaLocation(DB_Register register)

Creates a new instance of MetaLocation

Parameters:

register - Takes in a registry created by the LocationReader

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String key)

Returns the desired property. Available properties are:

[type]

[site name]

[stream name]

[county]

[state]

[data source]

[latitude (deg:min:sec)]

[longitude (deg:min:sec)]

[altitude ASL (m)]

[images]

[information]

Note: the brackets must be included.

Parameters:

key - The desired property

Returns:

An object that contains the information requested

toString

public java.lang.String toString()

A String describing the Location

Overrides:

toString in class java.lang.Object

Returns:

A String describing the location

compareTo

public int compareTo(java.lang.Object obj)

The comparison criteria

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - The object to compare to

Returns:

A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

getInformation

public java.lang.String getInformation()

Provides additional information associated with the location

Returns:

A String with information describing the location

hasImages

public boolean hasImages()

True if it has associated images

Returns:

A boolean indication whether there are images associated with the location

getImagesList

public java.util.Vector[] getImagesList()

Returns and array of Vector. Each Vector in the array has two elements. The first element is the path or URL to the image and the second element is a description of the image.

Returns:

An array of Vectors with information describing the image

getPositionTuple

public visad.RealTuple getPositionTuple()
                                 throws visad.VisADException,
                                        java.rmi.RemoteException

Returns an RealTuple

Returns:

A visad Data type

Throws:

visad.VisADException - Captures VisAD Exceptions

java.rmi.RemoteException - Captures Remote Exceptions

getTextTuple

public visad.Tuple getTextTuple()
                         throws visad.VisADException,
                                java.rmi.RemoteException

Returns an Tuple

Returns:

Returns a visad Data object indicating a location and text associated to it

Throws:

visad.VisADException - Captures Visad Exceptions

java.rmi.RemoteException - Captures Remote Exceptions