edu.wisc.ssec.mcidasv.servermanager
Enum LocalAddeEntry.AddeFormat

java.lang.Object
  java.lang.Enum<LocalAddeEntry.AddeFormat>
      edu.wisc.ssec.mcidasv.servermanager.LocalAddeEntry.AddeFormat

All Implemented Interfaces:

Serializable, Comparable<LocalAddeEntry.AddeFormat>

Enclosing class:

LocalAddeEntry

public static enum LocalAddeEntry.AddeFormat
extends Enum<LocalAddeEntry.AddeFormat>

The various kinds of local ADDE data understood by McIDAS-V, along with some helpful metadata.

• "Human readable" format names (friendlyName).
• Optional tooltip description (tooltip).
• Type of data (type).
• File naming pattern fileFilter.

None of AddeFormat's fields should contain null.

Enum Constant Summary

AMSRE_L1B

AMSRE_RAIN_PRODUCT

GINI

INVALID

LRIT_GOES10

LRIT_GOES11

LRIT_GOES12

LRIT_GOES9

LRIT_MET5

LRIT_MET7

LRIT_MTSAT1R

MCIDAS_AREA

MCIDAS_MD

METEOSAT_OPENMTP

METOP_AVHRR_L1B

MODIS_L1B_MOD02

MODIS_L2_MOD04

MODIS_L2_MOD06

MODIS_L2_MOD07

MODIS_L2_MOD28

MODIS_L2_MOD35

MODIS_L2_MODR

MSG_HRIT_FD

MSG_HRIT_HRV

MTSAT_HRIT

NOAA_AVHRR_L1B

SSMI

TRMM

Field Summary

private String	fileFilter Filename pattern used when listing files in a directory.
private String	friendlyName "Human readable" format name.
private LocalAddeEntry.ServerName	servName Name of the McIDAS-X server.
private String	tooltip Description of the format.
private AddeEntry.EntryType	type Data type.

Method Summary

String	getFileFilter() Gets the string used to filter out files that match this format.
LocalAddeEntry.ServerName	getServerName() Gets the McIDAS-X LocalAddeEntry.ServerName for this format.
String	getTooltip() Gets the tooltip text to use in the server manager GUI for this format.
AddeEntry.EntryType	getType() Gets the type of data used by this format.
String	toString() Gets the String representation of this format.
static LocalAddeEntry.AddeFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocalAddeEntry.AddeFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MCIDAS_AREA

public static final LocalAddeEntry.AddeFormat MCIDAS_AREA

MCIDAS_MD

public static final LocalAddeEntry.AddeFormat MCIDAS_MD

AMSRE_L1B

public static final LocalAddeEntry.AddeFormat AMSRE_L1B

AMSRE_RAIN_PRODUCT

public static final LocalAddeEntry.AddeFormat AMSRE_RAIN_PRODUCT

GINI

public static final LocalAddeEntry.AddeFormat GINI

LRIT_GOES9

public static final LocalAddeEntry.AddeFormat LRIT_GOES9

LRIT_GOES10

public static final LocalAddeEntry.AddeFormat LRIT_GOES10

LRIT_GOES11

public static final LocalAddeEntry.AddeFormat LRIT_GOES11

LRIT_GOES12

public static final LocalAddeEntry.AddeFormat LRIT_GOES12

LRIT_MET5

public static final LocalAddeEntry.AddeFormat LRIT_MET5

LRIT_MET7

public static final LocalAddeEntry.AddeFormat LRIT_MET7

LRIT_MTSAT1R

public static final LocalAddeEntry.AddeFormat LRIT_MTSAT1R

METEOSAT_OPENMTP

public static final LocalAddeEntry.AddeFormat METEOSAT_OPENMTP

METOP_AVHRR_L1B

public static final LocalAddeEntry.AddeFormat METOP_AVHRR_L1B

MODIS_L1B_MOD02

public static final LocalAddeEntry.AddeFormat MODIS_L1B_MOD02

MODIS_L2_MOD06

public static final LocalAddeEntry.AddeFormat MODIS_L2_MOD06

MODIS_L2_MOD07

public static final LocalAddeEntry.AddeFormat MODIS_L2_MOD07

MODIS_L2_MOD35

public static final LocalAddeEntry.AddeFormat MODIS_L2_MOD35

MODIS_L2_MOD04

public static final LocalAddeEntry.AddeFormat MODIS_L2_MOD04

MODIS_L2_MOD28

public static final LocalAddeEntry.AddeFormat MODIS_L2_MOD28

MODIS_L2_MODR

public static final LocalAddeEntry.AddeFormat MODIS_L2_MODR

MSG_HRIT_FD

public static final LocalAddeEntry.AddeFormat MSG_HRIT_FD

MSG_HRIT_HRV

public static final LocalAddeEntry.AddeFormat MSG_HRIT_HRV

MTSAT_HRIT

public static final LocalAddeEntry.AddeFormat MTSAT_HRIT

NOAA_AVHRR_L1B

public static final LocalAddeEntry.AddeFormat NOAA_AVHRR_L1B

SSMI

public static final LocalAddeEntry.AddeFormat SSMI

TRMM

public static final LocalAddeEntry.AddeFormat TRMM

INVALID

public static final LocalAddeEntry.AddeFormat INVALID

Field Detail

servName

private final LocalAddeEntry.ServerName servName

Name of the McIDAS-X server.

friendlyName

private final String friendlyName

"Human readable" format name. This is returned by toString().

tooltip

private final String tooltip

Description of the format.

type

private final AddeEntry.EntryType type

Data type. Corresponds to TYPE in "RESOLV.SRV".

fileFilter

private final String fileFilter

Filename pattern used when listing files in a directory. If servName is LocalAddeEntry.ServerName.MSGT then "*PRO*" is used, otherwise "*".

Method Detail

values

public static LocalAddeEntry.AddeFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LocalAddeEntry.AddeFormat c : LocalAddeEntry.AddeFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LocalAddeEntry.AddeFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getServerName

public LocalAddeEntry.ServerName getServerName()

Gets the McIDAS-X LocalAddeEntry.ServerName for this format.

Returns:

Either the name of this format's McIDAS-X server, or LocalAddeEntry.ServerName.INVALID.

getTooltip

public String getTooltip()

Gets the tooltip text to use in the server manager GUI for this format.

Returns:

Text to use as a GUI tooltip. Cannot be null, though empty String values are permitted.

getType

public AddeEntry.EntryType getType()

Gets the type of data used by this format. This value dictates the chooser(s) where this format can appear.

Returns:

One of AddeEntry.EntryType, or AddeEntry.EntryType.INVALID.

getFileFilter

public String getFileFilter()

Gets the string used to filter out files that match this format.

Returns:

Either a specialized String, like "*PRO*" or "*".

toString

public String toString()

Gets the String representation of this format.

Overrides:

toString in class Enum<LocalAddeEntry.AddeFormat>

Returns:

the value of friendlyName.