edu.wisc.ssec.mcidasv.chooser

Class ServerInfo

java.lang.Object

edu.wisc.ssec.mcidasv.chooser.ServerInfo

public class ServerInfo
extends java.lang.Object

ServerInfo objects have methods for accessing the contents of servers.xml.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_ACTIVE attributes
static java.lang.String	ATTR_NAME
static java.lang.String	ATTR_NAMES
static java.lang.String	ATTR_PROJ
static java.lang.String	ATTR_TYPE
static java.lang.String	ATTR_USER
private java.lang.String[]	defTypes
private java.util.List	groups
private ucar.unidata.idv.IntegratedDataViewer	myIdv
private static java.lang.String	proj
private java.util.List	serverDescriptors
private org.w3c.dom.Document	serversDocument
private org.w3c.dom.Element	serversRoot
private ucar.unidata.xml.XmlResourceCollection	serversXRC
static java.lang.String	TAG_GROUP
static java.lang.String	TAG_SERVER tags
static java.lang.String	TAG_SERVERS
private java.util.List	typeList
private static java.lang.String	user

Constructor Summary

Constructors

Constructor and Description
ServerInfo(ucar.unidata.idv.IntegratedDataViewer idv, ucar.unidata.xml.XmlResourceCollection servers) Creates a new ServerInfo object.

Method Summary

Modifier and Type	Method and Description
void	addServers(ucar.unidata.idv.IntegratedDataViewer idv, java.util.List serverList) Adds serverList to servers.xml.
void	clear(ucar.unidata.xml.XmlResourceCollection serversXRC) Clear servers.xml.
java.util.List	getAddeServers(java.lang.String type, boolean all, boolean includeDuplicates) Get list of AddeServers that match type.
java.util.List	getGroups(java.lang.String type) Get all group names for a given data type.
java.lang.String	getProj() Return project number, default="0"
java.util.List	getServerNames(java.lang.String type, boolean all, boolean includeDuplicates) Get list of server names that match type.
java.util.List	getServers(java.lang.String type, boolean all, boolean includeDuplicates) Get list of ServerDescriptors that match the given type.
private void	getServersFromXml(ucar.unidata.xml.XmlResourceCollection servers) Read and parse servers.xml.
java.util.List	getServerTypes() Get the different "types" supported by the server.
java.lang.String	getUser() Return userId, default="idv".
private boolean	init() Read servers.xml and initialize all lists.
void	setUserProj(java.lang.String user, java.lang.String proj) Change the user id and project number for this instance.
java.util.List	updateAddeServers(java.lang.String type, boolean all, boolean includeDuplicates) Re-reads servers.xml and re-initialize all lists.

Methods inherited from class java.lang.Object

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

Field Detail

myIdv

private ucar.unidata.idv.IntegratedDataViewer myIdv

TAG_SERVER

public static final java.lang.String TAG_SERVER

tags

See Also:

Constant Field Values

TAG_SERVERS

public static final java.lang.String TAG_SERVERS

See Also:

Constant Field Values

TAG_GROUP

public static final java.lang.String TAG_GROUP

See Also:

Constant Field Values

ATTR_ACTIVE

public static final java.lang.String ATTR_ACTIVE

attributes

See Also:

Constant Field Values

ATTR_NAME

public static final java.lang.String ATTR_NAME

See Also:

Constant Field Values

ATTR_NAMES

public static final java.lang.String ATTR_NAMES

See Also:

Constant Field Values

ATTR_USER

public static final java.lang.String ATTR_USER

See Also:

Constant Field Values

ATTR_PROJ

public static final java.lang.String ATTR_PROJ

See Also:

Constant Field Values

ATTR_TYPE

public static final java.lang.String ATTR_TYPE

See Also:

Constant Field Values

serversXRC

private ucar.unidata.xml.XmlResourceCollection serversXRC

serversDocument

private org.w3c.dom.Document serversDocument

serversRoot

private org.w3c.dom.Element serversRoot

user

private static java.lang.String user

proj

private static java.lang.String proj

typeList

private java.util.List typeList

groups

private java.util.List groups

serverDescriptors

private java.util.List serverDescriptors

defTypes

private java.lang.String[] defTypes

Constructor Detail

ServerInfo

public ServerInfo(ucar.unidata.idv.IntegratedDataViewer idv,
                  ucar.unidata.xml.XmlResourceCollection servers)

Creates a new ServerInfo object.

Parameters:

idv - Reference to the main application object.

servers - ADDE server definitions.

Method Detail

getServersFromXml

private void getServersFromXml(ucar.unidata.xml.XmlResourceCollection servers)

Read and parse servers.xml.

Parameters:

servers - Collection of ADDE server definitions.

getUser

public java.lang.String getUser()

Return userId, default="idv".

Returns:

User ID. Default value is "idv".

getProj

public java.lang.String getProj()

Return project number, default="0"

Returns:

Project number. Default value is "0".

setUserProj

public void setUserProj(java.lang.String user,
                        java.lang.String proj)

Change the user id and project number for this instance.

Parameters:

user - New user ID.

proj - New project number.

getServerTypes

public java.util.List getServerTypes()

Get the different "types" supported by the server.

Returns:

A list whose possible values may contain "image", "point", "grid", "text", "nav".

getServers

public java.util.List getServers(java.lang.String type,
                                 boolean all,
                                 boolean includeDuplicates)

Get list of ServerDescriptors that match the given type.

Parameters:

type - Data type. Should be one of "image", "point", "grid", "text", "nav".

all - Includes all definitions, even duplicates.

includeDuplicates - Whether or not duplicate definitions are included.

Returns:

List of ServerDescriptor objects that match type.

getServerNames

public java.util.List getServerNames(java.lang.String type,
                                     boolean all,
                                     boolean includeDuplicates)

Get list of server names that match type.

Parameters:

type - Data type. Should be one of "image", "point", "grid", "text", "nav".

all - Includes all definitions, even duplicates.

includeDuplicates - Whether or not duplicate definitions are included.

Returns:

List of server name strings.

getAddeServers

public java.util.List getAddeServers(java.lang.String type,
                                     boolean all,
                                     boolean includeDuplicates)

Get list of AddeServers that match type.

Parameters:

type - Data type. Should be one of "image", "point", "grid", "text", "nav".

all - Includes all definitions, even duplicates.

includeDuplicates - Whether or not duplicate definitions are included.

Returns:

List of AddeServer objects.

updateAddeServers

public java.util.List updateAddeServers(java.lang.String type,
                                        boolean all,
                                        boolean includeDuplicates)

Re-reads servers.xml and re-initialize all lists.

Parameters:

type - Data type. Should be one of "image", "point", "grid", "text", "nav".

all - Includes all definitions, even duplicates.

includeDuplicates - Whether or not duplicate definitions are included.

Returns:

List of server name strings that support type data.

init

private boolean init()

Read servers.xml and initialize all lists.

Returns:

false if serverDescriptors is null, true otherwise.

getGroups

public java.util.List getGroups(java.lang.String type)

Get all group names for a given data type.

Parameters:

type - Data type. Should be one of "image", "point", "grid", "text", "nav".

Returns:

List of groups that support type data.

addServers

public void addServers(ucar.unidata.idv.IntegratedDataViewer idv,
                       java.util.List serverList)

Adds serverList to servers.xml.

Parameters:

idv - Reference to main application object.

serverList - alternating strings: name1, group1, name2, group2...

clear

public void clear(ucar.unidata.xml.XmlResourceCollection serversXRC)

Clear servers.xml.

Parameters:

serversXRC - Collection of server definitions.