LocalAddeEntry (McIDAS-V 1.8 Developer Documentation)

java.lang.Object
- edu.wisc.ssec.mcidasv.servermanager.LocalAddeEntry

All Implemented Interfaces:: AddeEntry

public class LocalAddeEntry
extends java.lang.Object
implements AddeEntry

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LocalAddeEntry.AddeFormat` The various kinds of local ADDE data understood by McIDAS-V, along with some helpful metadata.
`static class`	`LocalAddeEntry.Builder` A builder of (mostly) immutable `LocalAddeEntry` instances.
`static class`	`LocalAddeEntry.ServerName`

Nested classes/interfaces inherited from interface edu.wisc.ssec.mcidasv.servermanager.AddeEntry
AddeEntry.EditorAction, AddeEntry.EntrySource, AddeEntry.EntryStatus, AddeEntry.EntryType, AddeEntry.EntryValidity

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`asStringId`
`private java.lang.String`	`descriptor` N2
`private java.lang.String`	`end` R2
`private java.lang.String`	`entryAlias` Allows the user to refer to this entry with an arbitrary name.
`private AddeEntry.EntryStatus`	`entryStatus` Status of this entry.
`private java.lang.String`	`fileMask` MASK
`private LocalAddeEntry.AddeFormat`	`format` MCV
`private java.lang.String`	`group` N1
`static java.util.List<LocalAddeEntry>`	`INVALID_ENTRIES` Represents a "bad" collection of local ADDE entries.
`static LocalAddeEntry`	`INVALID_ENTRY` Represents a "bad" local ADDE entry.
`private boolean`	`isTemporary` Whether or not this entry is temporary.
`(package private) static org.slf4j.Logger`	`logger` Friendly neighborhood logging object.
`private java.lang.String`	`name` C
`private boolean`	`realtime` RT
`private java.lang.String`	`start` R1

Fields inherited from interface edu.wisc.ssec.mcidasv.servermanager.AddeEntry
DEFAULT_ACCOUNT

Constructor Summary

Constructors
Modifier Constructor and Description

private LocalAddeEntry(LocalAddeEntry.Builder builder)
Creates a new local ADDE entry from the given builder object.

Constructors
Modifier	Constructor and Description
`private`	`LocalAddeEntry(LocalAddeEntry.Builder builder)` Creates a new local ADDE entry from the given `builder` object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`asStringId()` Currently used as a identifier for convenient storage by the server manager.
`boolean`	`equals(java.lang.Object obj)` Checks a given object for equality with the current `LocalAddeEntry` instance.
`static int`	`generateHashCode(LocalAddeEntry entry)`
`static int`	`generateHashCode(java.lang.String name, java.lang.String group, java.lang.String fileMask, java.lang.String entryAlias, boolean isTemporary, LocalAddeEntry.AddeFormat format)`
`AddeAccount`	`getAccount()` Accounting information associated with the current entry.
`java.lang.String`	`getAddress()` Address of the server associated with the current entry.
`java.lang.String`	`getDescriptor()` Gets the ADDE descriptor for the current local ADDE entry.
`java.lang.String`	`getEnd()` Gets the ending number of the current local ADDE dataset.
`java.lang.String`	`getEntryAlias()`
`AddeEntry.EntrySource`	`getEntrySource()` Source that specified this entry.
`AddeEntry.EntryStatus`	`getEntryStatus()` GUI status of the entry.
`java.lang.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.
`java.lang.String`	`getFileMask()` Gets the ADDE file mask for the current local ADDE entry.
`LocalAddeEntry.AddeFormat`	`getFormat()` Gets the ADDE dataset format for the current local ADDE entry.
`java.lang.String`	`getGroup()` Dataset/group located on the server.
`java.lang.String`	`getMask()` Gets the ADDE file mask for the current local ADDE entry.
`java.lang.String`	`getName()` Name associated with this entry.
`boolean`	`getRealtime()` Gets the ADDE realtime status of the current local ADDE entry.
`java.lang.String`	`getRealtimeAsString()` Gets the local ADDE dataset's realtime status as a value suitable for RESOLV.SRV (one of "Y" or "N").
`java.lang.String`	`getStart()` Gets the starting number of the current local ADDE dataset.
`int`	`hashCode()`
`boolean`	`isEntryTemporary()` Determine whether or not this entry will be saved between application sessions.
`boolean`	`isValid()` Tests the current local ADDE dataset for validity.
`void`	`setEntryAlias(java.lang.String newAlias)`
`void`	`setEntryStatus(AddeEntry.EntryStatus newStatus)`
`java.lang.String`	`toString()` String representation of this entry.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - logger
```
static final org.slf4j.Logger logger
```
    Friendly neighborhood logging object.
  - INVALID_ENTRY
```
public static final LocalAddeEntry INVALID_ENTRY
```
    Represents a "bad" local ADDE entry.
  - INVALID_ENTRIES
```
public static final java.util.List<LocalAddeEntry> INVALID_ENTRIES
```
    Represents a "bad" collection of local ADDE entries.
  - entryStatus
```
private AddeEntry.EntryStatus entryStatus
```
    Status of this entry.
  - group
```
private final java.lang.String group
```
    N1
  - descriptor
```
private final java.lang.String descriptor
```
    N2
  - realtime
```
private final boolean realtime
```
    RT
  - format
```
private final LocalAddeEntry.AddeFormat format
```
    MCV
  - start
```
private final java.lang.String start
```
    R1
  - end
```
private final java.lang.String end
```
    R2
  - fileMask
```
private final java.lang.String fileMask
```
    MASK
  - name
```
private final java.lang.String name
```
    C
  - asStringId
```
private java.lang.String asStringId
```
  - isTemporary
```
private final boolean isTemporary
```
    Whether or not this entry is temporary.
  - entryAlias
```
private java.lang.String entryAlias
```
    Allows the user to refer to this entry with an arbitrary name.
- Constructor Detail
  - LocalAddeEntry
```
private LocalAddeEntry(LocalAddeEntry.Builder builder)
```
    Creates a new local ADDE entry from the given builder object.
    
    Parameters:
    
    builder - Builder that represents a local ADDE entry.
    
    See Also:
    
    LocalAddeEntry.Builder
- Method Detail
  - getAccount
```
public AddeAccount getAccount()
```
    Description copied from interface: AddeEntry
    
    Accounting information associated with the current entry. If the server does not require accounting information, this method returns AddeEntry.DEFAULT_ACCOUNT.
    
    Specified by:
    
    getAccount in interface AddeEntry
    
    Returns:
    
    ADDE account object.
  - getAddress
```
public java.lang.String getAddress()
```
    Description copied from interface: AddeEntry
    
    Address of the server associated with the current entry. LocalAddeEntries will return localhost.
    
    Specified by:
    
    getAddress in interface AddeEntry
    
    Returns:
    
    Server address.
  - getEntrySource
```
public AddeEntry.EntrySource getEntrySource()
```
    Description copied from interface: AddeEntry
    
    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).
    
    Specified by:
    
    getEntrySource in interface AddeEntry
    
    Returns:
    
    Source of this entry.
  - getEntryStatus
```
public AddeEntry.EntryStatus getEntryStatus()
```
    Description copied from interface: AddeEntry
    
    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.
    
    Specified by:
    
    getEntryStatus in interface AddeEntry
    
    Returns:
    
    Status of this entry.
  - getEntryText
```
public java.lang.String getEntryText()
```
    Description copied from interface: AddeEntry
    
    Handy String representation of this ADDE entry. Currently looks like ADDRESS/GROUP, but this is subject to change.
    
    Specified by:
    
    getEntryText in interface AddeEntry
    
    Returns:
    
    Entry as a String.
  - getEntryType
```
public AddeEntry.EntryType getEntryType()
```
    Description copied from interface: AddeEntry
    
    Type of chooser this entry should appear under.
    
    Specified by:
    
    getEntryType in interface AddeEntry
    
    Returns:
    
    The "type" of data associated with this entry.
  - getEntryValidity
```
public AddeEntry.EntryValidity getEntryValidity()
```
    Description copied from interface: AddeEntry
    
    Does this entry represent a "valid" ADDE server.
    
    Specified by:
    
    getEntryValidity in interface AddeEntry
    
    Returns:
    
    Whether or not this entry has been validated.
  - getEntryAlias
```
public java.lang.String getEntryAlias()
```
    Specified by:
    
    getEntryAlias in interface AddeEntry
  - setEntryAlias
```
public void setEntryAlias(java.lang.String newAlias)
```
    Specified by:
    
    setEntryAlias in interface AddeEntry
  - setEntryStatus
```
public void setEntryStatus(AddeEntry.EntryStatus newStatus)
```
    Specified by:
    
    setEntryStatus in interface AddeEntry
  - isEntryTemporary
```
public boolean isEntryTemporary()
```
    Description copied from interface: AddeEntry
    
    Determine whether or not this entry will be saved between application sessions.
    
    Specified by:
    
    isEntryTemporary in interface AddeEntry
    
    Returns:
    
    Whether or not this entry is saved for subsequent sessions.
  - getGroup
```
public java.lang.String getGroup()
```
    Description copied from interface: AddeEntry
    
    Dataset/group located on the server.
    
    Specified by:
    
    getGroup in interface AddeEntry
    
    Returns:
    
    ADDE group.
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: AddeEntry
    
    Name associated with this entry.
    
    Specified by:
    
    getName in interface AddeEntry
    
    Returns:
    
    Name associated with this entry.
  - getDescriptor
```
public java.lang.String getDescriptor()
```
    Gets the ADDE descriptor for the current local ADDE entry.
    
    Returns:
    
    ADDE descriptor (corresponds to the "N2" section of a RESOLV.SRV entry).
  - getFormat
```
public LocalAddeEntry.AddeFormat getFormat()
```
    Gets the ADDE dataset format for the current local ADDE entry.
    
    Returns:
    
    ADDE format (corresponds to the "MCV" section of a RESOLV.SRV entry).
  - getMask
```
public java.lang.String getMask()
```
    Gets the ADDE file mask for the current local ADDE entry.
    
    Returns:
    
    ADDE file mask (corresponds to the "MASK" section of a RESOLV.SRV entry).
  - getFileMask
```
public java.lang.String getFileMask()
```
    Gets the ADDE file mask for the current local ADDE entry.
    
    Returns:
    
    ADDE file mask (corresponds to the "MASK" section of a RESOLV.SRV entry).
  - getRealtime
```
public boolean getRealtime()
```
    Gets the ADDE realtime status of the current local ADDE entry.
    
    Returns:
    
    Whether or not the current dataset is "realtime". Corresponds to the "RT" section of a RESOLV.SRV entry.
  - getStart
```
public java.lang.String getStart()
```
    Gets the starting number of the current local ADDE dataset.
    
    Returns:
    
    Corresponds to the "R1" section of a RESOLV.SRV entry.
  - getEnd
```
public java.lang.String getEnd()
```
    Gets the ending number of the current local ADDE dataset.
    
    Returns:
    
    Corresponds to the "R2" section of a RESOLV.SRV entry.
  - isValid
```
public boolean isValid()
```
    Tests the current local ADDE dataset for validity.
    
    Returns:
    
    true iff group and name are not empty.
  - getRealtimeAsString
```
public java.lang.String getRealtimeAsString()
```
    Gets the local ADDE dataset's realtime status as a value suitable for RESOLV.SRV (one of "Y" or "N").
    
    Returns:
    
    RESOLV.SRV-friendly representation of the current realtime status.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    See Also:
    
    generateHashCode(String, String, String, String, boolean, AddeFormat)
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks a given object for equality with the current LocalAddeEntry instance.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - Object to check. null values allowed.
    
    Returns:
    
    true if obj is "equal" to the current LocalAddeEntry instance.
  - asStringId
```
public java.lang.String asStringId()
```
    Description copied from interface: AddeEntry
    
    Currently used as a identifier for convenient storage by the server manager.
    
    Specified by:
    
    asStringId in interface AddeEntry
    
    Returns:
    
    Identifier for this entry.
  - toString
```
public java.lang.String toString()
```
    Description copied from interface: AddeEntry
    
    String representation of this entry.
    Output will typically contain internal details and as such will differ from AddeEntry.getEntryText().
    
    Specified by:
    
    toString in interface AddeEntry
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Entry as a String.
  - generateHashCode
```
public static int generateHashCode(LocalAddeEntry entry)
```
  - generateHashCode
```
public static int generateHashCode(java.lang.String name,
                                   java.lang.String group,
                                   java.lang.String fileMask,
                                   java.lang.String entryAlias,
                                   boolean isTemporary,
                                   LocalAddeEntry.AddeFormat format)
```

Class LocalAddeEntry

Nested Class Summary

Nested classes/interfaces inherited from interface edu.wisc.ssec.mcidasv.servermanager.AddeEntry

Field Summary

Fields inherited from interface edu.wisc.ssec.mcidasv.servermanager.AddeEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

INVALID_ENTRY

INVALID_ENTRIES

entryStatus

group

descriptor

realtime

format

start

end

fileMask

name

asStringId

isTemporary

entryAlias

Constructor Detail

LocalAddeEntry

Method Detail

getAccount

getAddress

getEntrySource

getEntryStatus

getEntryText

getEntryType

getEntryValidity

getEntryAlias

setEntryAlias

setEntryStatus

isEntryTemporary

getGroup

getName

getDescriptor

getFormat

getMask

getFileMask

getRealtime

getStart

getEnd

isValid

getRealtimeAsString

hashCode

equals

asStringId

toString

generateHashCode

generateHashCode