ucar.unidata.data

Class DataGroup

java.lang.Object

ucar.unidata.data.DataGroup

public class DataGroup
extends java.lang.Object

A generic base class that represents a source of data.

Version:

$Revision: 1.21 $

Author:

Jeff McWhirter

Constructor Summary

Constructors

Constructor and Description
DataGroup() The bean ctor
DataGroup(DataGroup that) copy ctor
DataGroup(java.lang.String groupName) Create a new DataGroup with the specified name

Method Summary

Modifier and Type	Method and Description
static DataGroup	getDataGroup(java.lang.String groupName) Get the DataGroup of the specified name
java.lang.String	getDescription() Get the Description property.
org.w3c.dom.Element	getElement(org.w3c.dom.Document doc) Create an xml element that represents this data group
static java.util.List	getGroups() Get the list of DataGroups
java.lang.String	getName() Get the Name property.
java.util.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 java.util.List	readGroups(org.w3c.dom.Element root, java.util.Hashtable groupMap, boolean merge) Construct the groups from XML.
void	setDescription(java.lang.String value) Set the Description property.
void	setName(java.lang.String value) Set the Name property.
void	setParamSets(java.util.List l) Set the list of param sets
java.lang.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(java.lang.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(java.lang.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 java.util.List getGroups()

Get the list of DataGroups

Returns:

list of DataGroups

setName

public void setName(java.lang.String value)

Set the Name property.

Parameters:

value - The new value for Name

getName

public java.lang.String getName()

Get the Name property.

Returns:

The Name

getParamSets

public java.util.List getParamSets()

Get the parameter set

Returns:

List of parameters

setParamSets

public void setParamSets(java.util.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 org.w3c.dom.Element getElement(org.w3c.dom.Document doc)

Create an xml element that represents this data group

Parameters:

doc - doc to use

Returns:

the element

toString

public java.lang.String toString()

tostring

Overrides:

toString in class java.lang.Object

Returns:

tostring

readGroups

public static java.util.List readGroups(org.w3c.dom.Element root,
                                        java.util.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(java.lang.String value)

Set the Description property.

Parameters:

value - The new value for Description

getDescription

public java.lang.String getDescription()

Get the Description property.

Returns:

The Description