dk.tbsalling.aismessages.ais.messages

Class AISMessage

java.lang.Object

dk.tbsalling.aismessages.ais.messages.AISMessage

All Implemented Interfaces:

CachedDecodedValues, Serializable

Direct Known Subclasses:

AddressedBinaryMessage, AddressedSafetyRelatedMessage, AidToNavigationReport, AssignedModeCommand, BaseStationReport, BinaryAcknowledge, BinaryBroadcastMessage, BinaryMessageMultipleSlot, BinaryMessageSingleSlot, ChannelManagement, ClassBCSStaticDataReport, DataLinkManagement, Error, ExtendedClassBEquipmentPositionReport, GNSSBinaryBroadcastMessage, GroupAssignmentCommand, Interrogation, LongRangeBroadcastMessage, PositionReport, SafetyRelatedAcknowledge, SafetyRelatedBroadcastMessage, ShipAndVoyageData, StandardClassBCSPositionReport, StandardSARAircraftPositionReport, UTCAndDateInquiry, UTCAndDateResponse

public abstract class AISMessage
extends Object
implements Serializable, CachedDecodedValues

The AISMessage class models a complete and self-contained AIS message. If the AISMessage was created from received NMEA strings, then the original NMEA strings are cached, together with the decoded values of the message. Lazy extraction of values.

Author:

tbsalling

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AISMessage()
protected	AISMessage(NMEAMessage[] nmeaMessages)
protected	AISMessage(NMEAMessage[] nmeaMessages, String bitString)

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkAISMessage()
static AISMessage	create(Metadata metadata, NMEAMessage... nmeaMessages) Create proper type of AISMessage from 1..n NMEA messages, and attach metadata.
static AISMessage	create(NMEAMessage... nmeaMessages) Create proper type of AISMessage from 1..n NMEA messages.
Map<String,Object>	dataFields() Return a map of data field name and values.
protected static String	decodePayloadToBitString(NMEAMessage... nmeaMessages)
byte[]	digest() Compute a SHA-1 message digest of this AISmessage.
boolean	equals(Object o)
protected String	getBits(Integer beginIndex, Integer endIndex)
protected String	getBitString()
abstract AISMessageType	getMessageType()
Metadata	getMetadata()
NMEAMessage[]	getNmeaMessages()
protected int	getNumberOfBits()
Integer	getRepeatIndicator()
MMSI	getSourceMmsi()
protected String	getZeroBitStuffedString(Integer endIndex)
int	hashCode()
boolean	isValid()
void	setMetadata(Metadata metadata)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dk.tbsalling.aismessages.ais.messages.CachedDecodedValues

getDecodedValue, getDecodedValueByWeakReference

Field Detail

VERSION

public static final transient String VERSION

See Also:

Constant Field Values

Constructor Detail

AISMessage

protected AISMessage()

AISMessage

protected AISMessage(NMEAMessage[] nmeaMessages)

AISMessage

protected AISMessage(NMEAMessage[] nmeaMessages,
                     String bitString)

Method Detail

digest

public byte[] digest()
              throws NoSuchAlgorithmException

Compute a SHA-1 message digest of this AISmessage. Suitable for e.g. doublet discovery and filtering.

Returns:

Message digest

Throws:

NoSuchAlgorithmException - if SHA-1 algorithm is not accessible

dataFields

public Map<String,Object> dataFields()

Return a map of data field name and values.

checkAISMessage

protected abstract void checkAISMessage()

getNmeaMessages

public NMEAMessage[] getNmeaMessages()

getMessageType

public abstract AISMessageType getMessageType()

getMetadata

public final Metadata getMetadata()

setMetadata

public final void setMetadata(Metadata metadata)

getRepeatIndicator

public final Integer getRepeatIndicator()

getSourceMmsi

public final MMSI getSourceMmsi()

toString

public String toString()

Overrides:

toString in class Object

getBitString

protected String getBitString()

getZeroBitStuffedString

protected String getZeroBitStuffedString(Integer endIndex)

getBits

protected String getBits(Integer beginIndex,
                         Integer endIndex)

getNumberOfBits

protected int getNumberOfBits()

decodePayloadToBitString

protected static String decodePayloadToBitString(NMEAMessage... nmeaMessages)

create

public static AISMessage create(Metadata metadata,
                                NMEAMessage... nmeaMessages)

Create proper type of AISMessage from 1..n NMEA messages, and attach metadata.

Parameters:

metadata -

nmeaMessages -

Returns:

create

public static AISMessage create(NMEAMessage... nmeaMessages)

Create proper type of AISMessage from 1..n NMEA messages.

Parameters:

nmeaMessages -

Returns:

isValid

public boolean isValid()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object