edu.wisc.ssec.mcidasv.servermanager

Interface AddeEntry

All Known Implementing Classes:

LocalAddeEntry, RemoteAddeEntry

public interface AddeEntry

Represents a source of ADDE data. An ADDE entry may describe a dataset on remote servers or the user's own machine.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AddeEntry.EditorAction Represents the possible actions that an ADDE editor can perform.
static class	AddeEntry.EntrySource Where did this entry come from?
static class	AddeEntry.EntryStatus Has the user elected to disable this entry from appearing in its relevant chooser?
static class	AddeEntry.EntryType Type of chooser this should appear under.
static class	AddeEntry.EntryValidity Sort of a "misc" status field...

Field Summary

Fields

Modifier and Type	Field and Description
static AddeAccount	DEFAULT_ACCOUNT Represents the "no accounting" entries.

Method Summary

Modifier and Type	Method and Description
String	asStringId() Currently used as a identifier for convenient storage by the server manager.
AddeAccount	getAccount() Accounting information associated with the current entry.
String	getAddress() Address of the server associated with the current entry.
String	getEntryAlias()
AddeEntry.EntrySource	getEntrySource() Source that specified this entry.
AddeEntry.EntryStatus	getEntryStatus() GUI status of the entry.
String	getEntryText() Handy String representation of this ADDE entry.
AddeEntry.EntryType	getEntryType() Type of chooser this entry should appear under.
AddeEntry.EntryValidity	getEntryValidity() Does this entry represent a "valid" ADDE server.
String	getGroup() Dataset/group located on the server.
String	getName() Name associated with this entry.
boolean	isEntryTemporary() Determine whether or not this entry will be saved between application sessions.
void	setEntryAlias(String newAlias)
void	setEntryStatus(AddeEntry.EntryStatus newStatus)
String	toString() String representation of this entry.

Field Detail

DEFAULT_ACCOUNT

static final AddeAccount DEFAULT_ACCOUNT

Represents the "no accounting" entries.

Method Detail

getAddress

String getAddress()

Address of the server associated with the current entry. LocalAddeEntries will return localhost.

Returns:

Server address.

getGroup

String getGroup()

Dataset/group located on the server.

Returns:

ADDE group.

getName

String getName()

Name associated with this entry.

Returns:

Name associated with this entry.

getAccount

AddeAccount getAccount()

Accounting information associated with the current entry. If the server does not require accounting information, this method returns DEFAULT_ACCOUNT.

Returns:

ADDE account object.

getEntryType

AddeEntry.EntryType getEntryType()

Type of chooser this entry should appear under.

Returns:

The "type" of data associated with this entry.

getEntryValidity

AddeEntry.EntryValidity getEntryValidity()

Does this entry represent a "valid" ADDE server.

Returns:

Whether or not this entry has been validated.

getEntrySource

AddeEntry.EntrySource getEntrySource()

Source that specified this entry. For example; allows you to distinguish "system" entries (which cannot be removed, only disabled) from entries created by the user (full control).

Returns:

Source of this entry.

getEntryStatus

AddeEntry.EntryStatus getEntryStatus()

GUI status of the entry. Differs from AddeEntry.EntryValidity in that EntryStatus controls this entry showing up in a chooser and has nothing to do with whether or not the entry is a valid ADDE server.

Returns:

Status of this entry.

getEntryText

String getEntryText()

Handy String representation of this ADDE entry. Currently looks like ADDRESS/GROUP, but this is subject to change.

Returns:

Entry as a String.

setEntryStatus

void setEntryStatus(AddeEntry.EntryStatus newStatus)

getEntryAlias

String getEntryAlias()

setEntryAlias

void setEntryAlias(String newAlias)

isEntryTemporary

boolean isEntryTemporary()

Determine whether or not this entry will be saved between application sessions.

Returns:

Whether or not this entry is saved for subsequent sessions.

asStringId

String asStringId()

Currently used as a identifier for convenient storage by the server manager.

Returns:

Identifier for this entry.

toString

String toString()

String representation of this entry.

Output will typically contain internal details and as such will differ from getEntryText().

Overrides:

toString in class Object

Returns:

Entry as a String.