Correspondence (API 1.12.0 API)

java.lang.Object
- org.jmisb.api.klv.st1907.Correspondence

All Implemented Interfaces:

IKlvValue, INestedKlvValue, IMimdMetadataValue
```
@Beta
public class Correspondence
extends Object
implements IMimdMetadataValue, INestedKlvValue
```
Correspondence Local Set. See ST1907 for more information on this data type.

Constructor Summary

Constructors
Constructor and Description
`Correspondence()` Create a new empty Correspondence local set.
`Correspondence(byte[] bytes)` Construct Correspondence Local Set from encoded bytes.
`Correspondence(byte[] data, int offset, int numBytes)` Build a Correspondence Local Set from encoded bytes.
`Correspondence(Map<CorrespondenceMetadataKey,IMimdMetadataValue> values)` Create the Correspondence local set from the given key/value pairs.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Correspondence`	`fromBytes(byte[] bytes)` Create Correspondence Local Set from encoded bytes.
`byte[]`	`getBytes()` Get the encoded bytes.
`Correspondence_Col`	`getCol()` Get the `col` attribute value.
`MimdIdReference`	`getCrossRef()` Get the `crossRef` attribute value.
`String`	`getDisplayableValue()` Return a string of the displayable value.
`String`	`getDisplayName()` Get the human-readable name for the value.
`IKlvValue`	`getField(IKlvKey tag)` Get the value of a given item.
`Set<? extends IKlvKey>`	`getIdentifiers()` Get the set of identifiers for populated values.
`MimdId`	`getMimdId()` Get the `mimdId` attribute value.
`NumericalPrecision`	`getNumericPrecision()` Get the `numericPrecision` attribute value.
`Position`	`getPosition()` Get the `position` attribute value.
`Range`	`getRange()` Get the `range` attribute value.
`Correspondence_Row`	`getRow()` Get the `row` attribute value.
`MimdIdReference`	`getSecurity()` Get the `security` attribute value.
`MimdIdReference`	`getTimer()` Get the `timer` attribute value.
`Base_TimerOffset`	`getTimerOffset()` Get the `timerOffset` attribute value.
`CorrType`	`getType()` Get the `type` attribute value.
`void`	`setCol(Correspondence_Col col)` Set the `col` attribute value.
`void`	`setCrossRef(MimdIdReference crossRef)` Set the `crossRef` attribute value.
`void`	`setMimdId(MimdId mimdId)` Set the `mimdId` attribute value.
`void`	`setNumericPrecision(NumericalPrecision numericPrecision)` Set the `numericPrecision` attribute value.
`void`	`setPosition(Position position)` Set the `position` attribute value.
`void`	`setRange(Range range)` Set the `range` attribute value.
`void`	`setRow(Correspondence_Row row)` Set the `row` attribute value.
`void`	`setSecurity(MimdIdReference security)` Set the `security` attribute value.
`void`	`setTimer(MimdIdReference timer)` Set the `timer` attribute value.
`void`	`setTimerOffset(Base_TimerOffset timerOffset)` Set the `timerOffset` attribute value.
`void`	`setType(CorrType type)` Set the `type` attribute value.

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

- Constructor Detail
  - Correspondence
```
public Correspondence()
```
    Create a new empty Correspondence local set.
  - Correspondence
```
public Correspondence(Map<CorrespondenceMetadataKey,IMimdMetadataValue> values)
```
    Create the Correspondence local set from the given key/value pairs.
    
    Parameters:
    
    values - Tag/value pairs to be included in the local set
  - Correspondence
```
public Correspondence(byte[] data,
                      int offset,
                      int numBytes)
               throws KlvParseException
```
    Build a Correspondence Local Set from encoded bytes.
    
    Parameters:
    
    data - the bytes to build from.
    
    offset - the offset into bytes to start parsing from.
    
    numBytes - the number of bytes to parse.
    
    Throws:
    
    KlvParseException - if parsing fails (depending on InvalidDataHandler strategy)
  - Correspondence
```
public Correspondence(byte[] bytes)
               throws KlvParseException
```
    Construct Correspondence Local Set from encoded bytes.
    
    Parameters:
    
    bytes - Encoded byte array.
    
    Throws:
    
    KlvParseException - if the array could not be parsed
- Method Detail
  - getMimdId
```
public MimdId getMimdId()
```
    Get the mimdId attribute value.
    
    Returns:
    
    a MimdId value, or null if not set.
  - setMimdId
```
public void setMimdId(MimdId mimdId)
```
    Set the mimdId attribute value.
    
    Parameters:
    
    mimdId - the MimdId value to set.
  - getTimer
```
public MimdIdReference getTimer()
```
    Get the timer attribute value.
    
    Returns:
    
    a MimdIdReference value, or null if not set.
  - setTimer
```
public void setTimer(MimdIdReference timer)
```
    Set the timer attribute value.
    
    Parameters:
    
    timer - the MimdIdReference value to set.
  - getTimerOffset
```
public Base_TimerOffset getTimerOffset()
```
    Get the timerOffset attribute value.
    
    Returns:
    
    a org.jmisb.api.klv.st1904.Base_TimerOffset value, or null if not set.
  - setTimerOffset
```
public void setTimerOffset(Base_TimerOffset timerOffset)
```
    Set the timerOffset attribute value.
    
    Parameters:
    
    timerOffset - the org.jmisb.api.klv.st1904.Base_TimerOffset value to set.
  - getNumericPrecision
```
public NumericalPrecision getNumericPrecision()
```
    Get the numericPrecision attribute value.
    
    Returns:
    
    a org.jmisb.api.klv.st1904.NumericalPrecision value, or null if not set.
  - setNumericPrecision
```
public void setNumericPrecision(NumericalPrecision numericPrecision)
```
    Set the numericPrecision attribute value.
    
    Parameters:
    
    numericPrecision - the NumericPrecision value to set.
  - getSecurity
```
public MimdIdReference getSecurity()
```
    Get the security attribute value.
    
    Returns:
    
    a MimdIdReference value, or null if not set.
  - setSecurity
```
public void setSecurity(MimdIdReference security)
```
    Set the security attribute value.
    
    Parameters:
    
    security - the MimdIdReference value to set.
  - getCol
```
public Correspondence_Col getCol()
```
    Get the col attribute value.
    
    Returns:
    
    a org.jmisb.api.klv.st1907.Correspondence_Col value, or null if not set.
  - setCol
```
public void setCol(Correspondence_Col col)
```
    Set the col attribute value.
    
    Parameters:
    
    col - the org.jmisb.api.klv.st1907.Correspondence_Col value to set.
  - getRow
```
public Correspondence_Row getRow()
```
    Get the row attribute value.
    
    Returns:
    
    a org.jmisb.api.klv.st1907.Correspondence_Row value, or null if not set.
  - setRow
```
public void setRow(Correspondence_Row row)
```
    Set the row attribute value.
    
    Parameters:
    
    row - the org.jmisb.api.klv.st1907.Correspondence_Row value to set.
  - getType
```
public CorrType getType()
```
    Get the type attribute value.
    
    Returns:
    
    a org.jmisb.api.klv.st1907.CorrType value, or null if not set.
  - setType
```
public void setType(CorrType type)
```
    Set the type attribute value.
    
    Parameters:
    
    type - the Type value to set.
  - getCrossRef
```
public MimdIdReference getCrossRef()
```
    Get the crossRef attribute value.
    
    Returns:
    
    a MimdIdReference value, or null if not set.
  - setCrossRef
```
public void setCrossRef(MimdIdReference crossRef)
```
    Set the crossRef attribute value.
    
    Parameters:
    
    crossRef - the MimdIdReference value to set.
  - getPosition
```
public Position getPosition()
```
    Get the position attribute value.
    
    Returns:
    
    a org.jmisb.api.klv.st1906.Position value, or null if not set.
  - setPosition
```
public void setPosition(Position position)
```
    Set the position attribute value.
    
    Parameters:
    
    position - the Position value to set.
  - getRange
```
public Range getRange()
```
    Get the range attribute value.
    
    Returns:
    
    a org.jmisb.api.klv.st1907.Range value, or null if not set.
  - setRange
```
public void setRange(Range range)
```
    Set the range attribute value.
    
    Parameters:
    
    range - the Range value to set.
  - fromBytes
```
public static Correspondence fromBytes(byte[] bytes)
                                throws KlvParseException
```
    Create Correspondence Local Set from encoded bytes.
    
    Parameters:
    
    bytes - Encoded byte array
    
    Returns:
    
    new Correspondence corresponding to the encoded byte array.
    
    Throws:
    
    KlvParseException - if the array could not be parsed
  - getBytes
```
public byte[] getBytes()
```
    Description copied from interface: IMimdMetadataValue
    
    Get the encoded bytes.
    
    Specified by:
    
    getBytes in interface IMimdMetadataValue
    
    Returns:
    
    The encoded byte array
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: IKlvValue
    
    Get the human-readable name for the value.
    
    Specified by:
    
    getDisplayName in interface IKlvValue
    
    Returns:
    
    The name of the type
  - getDisplayableValue
```
public String getDisplayableValue()
```
    Description copied from interface: IKlvValue
    
    Return a string of the displayable value.
    
    Specified by:
    
    getDisplayableValue in interface IKlvValue
    
    Returns:
    
    String representing the value
  - getField
```
public IKlvValue getField(IKlvKey tag)
```
    Description copied from interface: INestedKlvValue
    
    Get the value of a given item.
    
    Specified by:
    
    getField in interface INestedKlvValue
    
    Parameters:
    
    tag - Tag or other identifier of the value to retrieve
    
    Returns:
    
    The value, or null if no value was set
  - getIdentifiers
```
public Set<? extends IKlvKey> getIdentifiers()
```
    Description copied from interface: INestedKlvValue
    
    Get the set of identifiers for populated values.
    
    Specified by:
    
    getIdentifiers in interface INestedKlvValue
    
    Returns:
    
    The set of item identifiers for which values have been set

Class Correspondence

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Correspondence

Correspondence

Correspondence

Correspondence

Method Detail

getMimdId

setMimdId

getTimer

setTimer

getTimerOffset

setTimerOffset

getNumericPrecision

setNumericPrecision

getSecurity

setSecurity

getCol

setCol

getRow

setRow

getType

setType

getCrossRef

setCrossRef

getPosition

setPosition

getRange

setRange

fromBytes

getBytes

getDisplayName

getDisplayableValue

getField

getIdentifiers