PmfmId (SIH-Adagio :: Core 3.5.6 API)

Object
- Enum<PmfmId>
- - PmfmId

All Implemented Interfaces:: AdagioEnumerationDef<Integer>, Serializable, Comparable<PmfmId>

public enum PmfmId
extends Enum<PmfmId>
implements Serializable, AdagioEnumerationDef<Integer>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGE` TODO: Model Documentation for Enumeration Literal AGE value 1430
`DEAD_OR_ALIVE` TODO: Model Documentation for Enumeration Literal DEAD_OR_ALIVE value 1393
`HAUL_VALID` TODO: Model Documentation for Enumeration Literal HAUL_VALID value 1163
`HORIZONTAL_OPENING_DOOR` TODO: Model Documentation for Enumeration Literal HORIZONTAL_OPENING_DOOR value 830
`HORIZONTAL_OPENING_WINGS` TODO: Model Documentation for Enumeration Literal HORIZONTAL_OPENING_WINGS value 827
`ID_PMFM` TODO: Model Documentation for Enumeration Literal ID_PMFM value 1433
`MARINE_LITTER_SIZE_CATEGORY` TODO: Model Documentation for Enumeration Literal MARINE_LITTER_SIZE_CATEGORY value 1422
`MARINE_LITTER_TYPE` TODO: Model Documentation for Enumeration Literal MARINE_LITTER_TYPE value 1421
`MATURITY` TODO: Model Documentation for Enumeration Literal MATURITY value 174
`MULTIRIG_AGGREGATION` TODO: Model Documentation for Enumeration Literal MULTIRIG_AGGREGATION value 1424
`MULTIRIG_NUMBER` TODO: Model Documentation for Enumeration Literal MULTIRIG_NUMBER value 1420
`RECTILINEAR_OPERATION` TODO: Model Documentation for Enumeration Literal RECTILINEAR_OPERATION value 192
`SCIENTIFIC_CRUISE_SORTING_TYPE` TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_SORTING_TYPE value 1429
`SCIENTIFIC_CRUISE_SORTING_TYPE2` TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_SORTING_TYPE2 value 1431
`SEX` TODO: Model Documentation for Enumeration Literal SEX value 196
`SIZE_CATEGORY` TODO: Model Documentation for Enumeration Literal SIZE_CATEGORY value 198
`SORTED_UNSORTED` TODO: Model Documentation for Enumeration Literal SORTED_UNSORTED value 1428
`SORTING_TYPE_TCC` TODO: Model Documentation for Enumeration Literal SORTING_TYPE_TCC value 1747
`STATION_NUMBER` TODO: Model Documentation for Enumeration Literal STATION_NUMBER value 1243
`SURVEY_PART` TODO: Model Documentation for Enumeration Literal SURVEY_PART value 1432
`TRAWL_DISTANCE` TODO: Model Documentation for Enumeration Literal TRAWL_DISTANCE value 113
`VERTICAL_OPENING` TODO: Model Documentation for Enumeration Literal VERTICAL_OPENING value 832
`WEIGHT_MEASURED` TODO: Model Documentation for Enumeration Literal WEIGHT_MEASURED value 220

Field Summary
- Fields inherited from interface AdagioEnumerationDef
  CONFIG_OPTION_PREFIX

Method Summary

Methods
Modifier and Type	Method and Description
`static PmfmId`	`fromString(String name)` Retrieves an instance of PmfmId from `its name`.
`static PmfmId`	`fromValue(Integer value)` Returns an instance of PmfmId from Integer `value`.
`String`	`getDescription()`
`String`	`getKey()`
`Class<?>`	`getType()`
`Integer`	`getValue()` Gets the underlying value of this type safe enumeration.
`String`	`getValueAsString()`
`static List<Integer>`	`literals()` Returns an unmodifiable list containing the literals that are known by this enumeration.
`static List<String>`	`names()` Returns an unmodifiable list containing the names of the literals that are known by this enumeration.
`void`	`setValue(Integer newValue)`
`Integer`	`value()` Returns an enumeration literal Integer `value`.
`static PmfmId`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PmfmId[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DEAD_OR_ALIVE
```
public static final PmfmId DEAD_OR_ALIVE
```
    TODO: Model Documentation for Enumeration Literal DEAD_OR_ALIVE value 1393
  - SORTED_UNSORTED
```
public static final PmfmId SORTED_UNSORTED
```
    TODO: Model Documentation for Enumeration Literal SORTED_UNSORTED value 1428
  - WEIGHT_MEASURED
```
public static final PmfmId WEIGHT_MEASURED
```
    TODO: Model Documentation for Enumeration Literal WEIGHT_MEASURED value 220
  - MATURITY
```
public static final PmfmId MATURITY
```
    TODO: Model Documentation for Enumeration Literal MATURITY value 174
  - HORIZONTAL_OPENING_WINGS
```
public static final PmfmId HORIZONTAL_OPENING_WINGS
```
    TODO: Model Documentation for Enumeration Literal HORIZONTAL_OPENING_WINGS value 827
  - SIZE_CATEGORY
```
public static final PmfmId SIZE_CATEGORY
```
    TODO: Model Documentation for Enumeration Literal SIZE_CATEGORY value 198
  - SCIENTIFIC_CRUISE_SORTING_TYPE2
```
public static final PmfmId SCIENTIFIC_CRUISE_SORTING_TYPE2
```
    TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_SORTING_TYPE2 value 1431
  - SURVEY_PART
```
public static final PmfmId SURVEY_PART
```
    TODO: Model Documentation for Enumeration Literal SURVEY_PART value 1432
  - AGE
```
public static final PmfmId AGE
```
    TODO: Model Documentation for Enumeration Literal AGE value 1430
  - HAUL_VALID
```
public static final PmfmId HAUL_VALID
```
    TODO: Model Documentation for Enumeration Literal HAUL_VALID value 1163
  - HORIZONTAL_OPENING_DOOR
```
public static final PmfmId HORIZONTAL_OPENING_DOOR
```
    TODO: Model Documentation for Enumeration Literal HORIZONTAL_OPENING_DOOR value 830
  - STATION_NUMBER
```
public static final PmfmId STATION_NUMBER
```
    TODO: Model Documentation for Enumeration Literal STATION_NUMBER value 1243
  - MULTIRIG_AGGREGATION
```
public static final PmfmId MULTIRIG_AGGREGATION
```
    TODO: Model Documentation for Enumeration Literal MULTIRIG_AGGREGATION value 1424
  - SEX
```
public static final PmfmId SEX
```
    TODO: Model Documentation for Enumeration Literal SEX value 196
  - MARINE_LITTER_TYPE
```
public static final PmfmId MARINE_LITTER_TYPE
```
    TODO: Model Documentation for Enumeration Literal MARINE_LITTER_TYPE value 1421
  - MULTIRIG_NUMBER
```
public static final PmfmId MULTIRIG_NUMBER
```
    TODO: Model Documentation for Enumeration Literal MULTIRIG_NUMBER value 1420
  - VERTICAL_OPENING
```
public static final PmfmId VERTICAL_OPENING
```
    TODO: Model Documentation for Enumeration Literal VERTICAL_OPENING value 832
  - TRAWL_DISTANCE
```
public static final PmfmId TRAWL_DISTANCE
```
    TODO: Model Documentation for Enumeration Literal TRAWL_DISTANCE value 113
  - RECTILINEAR_OPERATION
```
public static final PmfmId RECTILINEAR_OPERATION
```
    TODO: Model Documentation for Enumeration Literal RECTILINEAR_OPERATION value 192
  - MARINE_LITTER_SIZE_CATEGORY
```
public static final PmfmId MARINE_LITTER_SIZE_CATEGORY
```
    TODO: Model Documentation for Enumeration Literal MARINE_LITTER_SIZE_CATEGORY value 1422
  - SORTING_TYPE_TCC
```
public static final PmfmId SORTING_TYPE_TCC
```
    TODO: Model Documentation for Enumeration Literal SORTING_TYPE_TCC value 1747
  - SCIENTIFIC_CRUISE_SORTING_TYPE
```
public static final PmfmId SCIENTIFIC_CRUISE_SORTING_TYPE
```
    TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_SORTING_TYPE value 1429
  - ID_PMFM
```
public static final PmfmId ID_PMFM
```
    TODO: Model Documentation for Enumeration Literal ID_PMFM value 1433
- Method Detail
  - values
```
public static PmfmId[] 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 (PmfmId c : PmfmId.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PmfmId 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
  - setValue
```
public void setValue(Integer newValue)
```
    Specified by:
    
    setValue in interface AdagioEnumerationDef<Integer>
  - getValueAsString
```
public String getValueAsString()
```
    Specified by:
    
    getValueAsString in interface AdagioEnumerationDef<Integer>
  - fromString
```
public static PmfmId fromString(String name)
```
    Retrieves an instance of PmfmId from its name.
    
    Parameters:
    name - the name to create the PmfmId from.
    
    Returns:
    The enumeration literal named after the 'name' argument
  - value
```
public Integer value()
```
    Returns an enumeration literal Integer value. Required by JAXB2 enumeration implementation
    
    Returns:
    Integer with corresponding value
  - fromValue
```
public static PmfmId fromValue(Integer value)
```
    Returns an instance of PmfmId from Integer value. Required by JAXB2 enumeration implementation
    
    Parameters:
    value - the value to create the PmfmId from.
    
    Returns:
    static Enumeration with corresponding value
  - getValue
```
public Integer getValue()
```
    Gets the underlying value of this type safe enumeration. This method is necessary to comply with DaoBase implementation.
    
    Specified by:
    
    getValue in interface AdagioEnumerationDef<Integer>
    
    Returns:
    The name of this literal.
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface AdagioEnumerationDef<Integer>
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface AdagioEnumerationDef<Integer>
  - getType
```
public Class<?> getType()
```
    Specified by:
    
    getType in interface AdagioEnumerationDef<Integer>
  - literals
```
public static List<Integer> literals()
```
    Returns an unmodifiable list containing the literals that are known by this enumeration.
    
    Returns:
    A List containing the actual literals defined by this enumeration, this list can not be modified.
  - names
```
public static List<String> names()
```
    Returns an unmodifiable list containing the names of the literals that are known by this enumeration.
    
    Returns:
    A List containing the actual names of the literals defined by this enumeration, this list can not be modified.

Enum PmfmId

Enum Constant Summary

Field Summary

Fields inherited from interface AdagioEnumerationDef

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

DEAD_OR_ALIVE

SORTED_UNSORTED

WEIGHT_MEASURED

MATURITY

HORIZONTAL_OPENING_WINGS

SIZE_CATEGORY

SCIENTIFIC_CRUISE_SORTING_TYPE2

SURVEY_PART

AGE

HAUL_VALID

HORIZONTAL_OPENING_DOOR

STATION_NUMBER

MULTIRIG_AGGREGATION

SEX

MARINE_LITTER_TYPE

MULTIRIG_NUMBER

VERTICAL_OPENING

TRAWL_DISTANCE

RECTILINEAR_OPERATION

MARINE_LITTER_SIZE_CATEGORY

SORTING_TYPE_TCC

SCIENTIFIC_CRUISE_SORTING_TYPE

ID_PMFM

Method Detail

values

valueOf

setValue

getValueAsString

fromString

value

fromValue

getValue

getDescription

getKey

getType

literals

names