org.jmisb.api.klv.st1907

Class CorrespondenceGroup_Rectangle

java.lang.Object

org.jmisb.api.klv.st1907.CorrespondenceGroup_Rectangle

All Implemented Interfaces:

IKlvValue, INestedKlvValue, IMimdMetadataValue

public class CorrespondenceGroup_Rectangle
extends Object
implements IMimdMetadataValue, INestedKlvValue

MIMD CorrespondenceGroup rectangle attribute.

This is a specialisation of a MIMD LIST<Correspondence>.

See ST1907 for more information on this data type.

Constructor Summary

Constructors

Constructor and Description
CorrespondenceGroup_Rectangle(byte[] data, int offset, int numBytes) Build a CorrespondenceGroup_Rectangle from encoded bytes.
CorrespondenceGroup_Rectangle(List<Correspondence> values) Create a CorrespondenceGroup_Rectangle from values.

Method Summary

Modifier and Type	Method and Description
static CorrespondenceGroup_Rectangle	fromBytes(byte[] data) Build a CorrespondenceGroup_Rectangle from encoded bytes.
byte[]	getBytes() Get the encoded bytes.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CorrespondenceGroup_Rectangle

public CorrespondenceGroup_Rectangle(List<Correspondence> values)

Create a CorrespondenceGroup_Rectangle from values.

Parameters:

values - the values to construct from.

CorrespondenceGroup_Rectangle

public CorrespondenceGroup_Rectangle(byte[] data,
                                     int offset,
                                     int numBytes)
                              throws KlvParseException

Build a CorrespondenceGroup_Rectangle 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

Method Detail

fromBytes

public static CorrespondenceGroup_Rectangle fromBytes(byte[] data)
                                               throws KlvParseException

Build a CorrespondenceGroup_Rectangle from encoded bytes.

Parameters:

data - the bytes to build from.

Returns:

new CorrespondenceGroup_Rectangle corresponding to the encoded byte array.

Throws:

KlvParseException - if parsing fails

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

getBytes

public byte[] getBytes()

Description copied from interface: IMimdMetadataValue

Get the encoded bytes.

Specified by:

getBytes in interface IMimdMetadataValue

Returns:

The encoded byte array

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