Package edu.wisc.ssec.mcidasv.servermanager

Enum Class LocalAddeEntry.AddeFormat

java.lang.Object

java.lang.Enum<LocalAddeEntry.AddeFormat>

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

All Implemented Interfaces:

Serializable, Comparable<LocalAddeEntry.AddeFormat>, Constable

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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMSRE_L1B
AMSRE_L2A
AMSRE_RAIN_PRODUCT
GINI
GOES16_ABI
HIMAWARI8
HIMAWARICAST
INSAT3D_IMAGER
INSAT3D_SOUNDER
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
MSG_NATIVE
MTSAT_HRIT
NOAA_AVHRR_L1B
SCMI
SSMI
TRMM
VIIREI
VIIREM
VIIRSD
VIIRSI
VIIRSM

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AddeFormat(LocalAddeEntry.ServerName servName, String friendlyName)	Builds an "imagery ADDE Format" without a tooltip.
private	AddeFormat(LocalAddeEntry.ServerName servName, String friendlyName, String tooltip)	Builds an "imagery ADDE Format" with a tooltip.
private	AddeFormat(LocalAddeEntry.ServerName servName, String friendlyName, String tooltip, AddeEntry.EntryType type)	Builds an "ADDE format" and its associated metadata in a typesafe way.

Method Summary

Modifier and Type	Method	Description
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 class with the specified name.
static LocalAddeEntry.AddeFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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_L2A

public static final LocalAddeEntry.AddeFormat AMSRE_L2A

AMSRE_RAIN_PRODUCT

public static final LocalAddeEntry.AddeFormat AMSRE_RAIN_PRODUCT

GINI

public static final LocalAddeEntry.AddeFormat GINI

GOES16_ABI

public static final LocalAddeEntry.AddeFormat GOES16_ABI

HIMAWARI8

public static final LocalAddeEntry.AddeFormat HIMAWARI8

HIMAWARICAST

public static final LocalAddeEntry.AddeFormat HIMAWARICAST

INSAT3D_IMAGER

public static final LocalAddeEntry.AddeFormat INSAT3D_IMAGER

INSAT3D_SOUNDER

public static final LocalAddeEntry.AddeFormat INSAT3D_SOUNDER

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

MSG_NATIVE

public static final LocalAddeEntry.AddeFormat MSG_NATIVE

MTSAT_HRIT

public static final LocalAddeEntry.AddeFormat MTSAT_HRIT

NOAA_AVHRR_L1B

public static final LocalAddeEntry.AddeFormat NOAA_AVHRR_L1B

SCMI

public static final LocalAddeEntry.AddeFormat SCMI

SSMI

public static final LocalAddeEntry.AddeFormat SSMI

TRMM

public static final LocalAddeEntry.AddeFormat TRMM

VIIRSD

public static final LocalAddeEntry.AddeFormat VIIRSD

VIIRSI

public static final LocalAddeEntry.AddeFormat VIIRSI

VIIRSM

public static final LocalAddeEntry.AddeFormat VIIRSM

VIIREI

public static final LocalAddeEntry.AddeFormat VIIREI

VIIREM

public static final LocalAddeEntry.AddeFormat VIIREM

INVALID

public static final LocalAddeEntry.AddeFormat INVALID

Field Details

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 "*".

Constructor Details

AddeFormat

private AddeFormat(LocalAddeEntry.ServerName servName,
 String friendlyName,
 String tooltip,
 AddeEntry.EntryType type)

Builds an "ADDE format" and its associated metadata in a typesafe way.

Parameters:

servName - LocalAddeEntry.ServerName that McIDAS-X uses for this format.

friendlyName - "Human readable" name of the format; returned by toString().

tooltip - If non-empty, this is used as a tooltip in the local entry editor.

type - AddeEntry.EntryType used by this format.

AddeFormat

private AddeFormat(LocalAddeEntry.ServerName servName,
 String friendlyName)

Builds an "imagery ADDE Format" without a tooltip.

Parameters:

servName - LocalAddeEntry.ServerName that McIDAS-X uses for this format.

friendlyName - "Human readable" name of the format; returned by toString().

AddeFormat

private AddeFormat(LocalAddeEntry.ServerName servName,
 String friendlyName,
 String tooltip)

Builds an "imagery ADDE Format" with a tooltip.

Parameters:

servName - LocalAddeEntry.ServerName that McIDAS-X uses for this format.

friendlyName - "Human readable" name of the format; returned by toString().

tooltip - If non-empty, this is used as a tooltip in the local entry editor.

Method Details

values

public static LocalAddeEntry.AddeFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LocalAddeEntry.AddeFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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 EntryType, or 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.