ucar.unidata.data
Class DataGroup

java.lang.Object
  extended by ucar.unidata.data.DataGroup

public class DataGroup
extends Object

A generic base class that represents a source of data.

Version:
$Revision: 1.21 $
Author:
Jeff McWhirter

Constructor Summary
DataGroup()
          The bean ctor
DataGroup(DataGroup that)
          copy ctor
DataGroup(String groupName)
          Create a new DataGroup with the specified name
 
Method Summary
static DataGroup getDataGroup(String groupName)
          Get the DataGroup of the specified name
 String getDescription()
          Get the Description property.
 Element getElement(Document doc)
          Create an xml element that represents this data group
static List getGroups()
          Get the list of DataGroups
 String getName()
          Get the Name property.
 List getParamSets()
          Get the parameter set
static void init(XmlResourceCollection xrc)
          Initialize from XML.
static void init(XmlResourceCollection xrc, boolean andClear)
          Initialize from XML.
static List readGroups(Element root, Hashtable groupMap, boolean merge)
          Construct the groups from XML.
 void setDescription(String value)
          Set the Description property.
 void setName(String value)
          Set the Name property.
 void setParamSets(List l)
          Set the list of param sets
 String toString()
          tostring
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataGroup

public DataGroup()
The bean ctor


DataGroup

public DataGroup(String groupName)
Create a new DataGroup with the specified name

Parameters:
groupName - name of group

DataGroup

public DataGroup(DataGroup that)
copy ctor

Parameters:
that - that
Method Detail

getDataGroup

public static DataGroup getDataGroup(String groupName)
Get the DataGroup of the specified name

Parameters:
groupName - name of group
Returns:
DataGroup for that name (or null if it does not exist).

getGroups

public static List getGroups()
Get the list of DataGroups

Returns:
list of DataGroups

setName

public void setName(String value)
Set the Name property.

Parameters:
value - The new value for Name

getName

public String getName()
Get the Name property.

Returns:
The Name

getParamSets

public List getParamSets()
Get the parameter set

Returns:
List of parameters

setParamSets

public void setParamSets(List l)
Set the list of param sets

Parameters:
l - list

init

public static void init(XmlResourceCollection xrc)
Initialize from XML.

Parameters:
xrc - resource collection

init

public static void init(XmlResourceCollection xrc,
                        boolean andClear)
Initialize from XML.

Parameters:
xrc - resource collection
andClear - If true then clear any current state and reinitialize

getElement

public Element getElement(Document doc)
Create an xml element that represents this data group

Parameters:
doc - doc to use
Returns:
the element

toString

public String toString()
tostring

Overrides:
toString in class Object
Returns:
tostring

readGroups

public static List readGroups(Element root,
                              Hashtable groupMap,
                              boolean merge)
Construct the groups from XML.

Parameters:
root - root XML element.
groupMap - group
merge - Try to merge the new DataGroups into the ones defined in groupMap
Returns:
List of groups

setDescription

public void setDescription(String value)
Set the Description property.

Parameters:
value - The new value for Description

getDescription

public String getDescription()
Get the Description property.

Returns:
The Description