dk.dma.ais.message

Class AisMessage

java.lang.Object

dk.dma.ais.message.AisMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AisBinaryMessage, AisMessage10, AisMessage12, AisMessage14, AisMessage17, AisMessage18, AisMessage21, AisMessage27, AisMessage7, AisMessage9, AisPositionMessage, AisStaticCommon, AisUnsupportedMessageType, UTCDateResponseMessage

public abstract class AisMessage
extends Object
implements Serializable

Abstract base class for all AIS messages

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	msgId The Msg id.
protected int	repeat The Repeat.
protected int	userId The User id.
static Set<Integer>	VALID_MESSAGE_TYPES A set of all valid AIS message types.
protected Vdm	vdm The Vdm.

Constructor Summary

Constructors

Constructor and Description
AisMessage(int msgId) Constructor given message id
AisMessage(Vdm vdm) Constructor given VDM with AIS message

Method Summary

Modifier and Type	Method and Description
protected SixbitEncoder	encode() Base encode method to be called by all extending classes
abstract SixbitEncoder	getEncoded() Abstract method to be implemented by all extending classes
static AisMessage	getInstance(Vdm vdm) Given VDM return the encapsulated AIS message.
int	getMsgId() Gets msg id.
int	getRepeat() Gets repeat.
IProprietarySourceTag	getSourceTag() Return the LAST source tag (closest to AIS sentence)
LinkedList<IProprietaryTag>	getTags() Get all tags
AisTargetType	getTargetType() Returns the target type of the message or null if the message does not have a target type.
int	getUserId() Gets user id.
dk.dma.enav.model.geometry.Position	getValidPosition() Returns a valid position if this message has a valid position, otherwise null.
Vdm	getVdm() Get VDM this message was encapsulated in
protected void	parse(BinArray binArray) Base parse method to be called by all extending classes
String	reassemble() Method for reassembling original message appending possible proprietary source tags
void	setRepeat(int repeat) Sets repeat.
void	setTag(IProprietaryTag tag) Add tag (to front)
void	setTags(LinkedList<IProprietaryTag> tags) Sets tags.
void	setUserId(int userId) Sets user id.
String	toString()
static String	trimText(String text) Utility to trim text from AIS message

Methods inherited from class java.lang.Object

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

Field Detail

VALID_MESSAGE_TYPES

public static final Set<Integer> VALID_MESSAGE_TYPES

A set of all valid AIS message types.

msgId

protected int msgId

The Msg id.

repeat

protected int repeat

The Repeat.

userId

protected int userId

The User id.

vdm

protected transient Vdm vdm

The Vdm.

Constructor Detail

AisMessage

public AisMessage(int msgId)

Constructor given message id

Parameters:

msgId - the msg id

AisMessage

public AisMessage(Vdm vdm)

Constructor given VDM with AIS message

Parameters:

vdm - the vdm

Method Detail

parse

protected void parse(BinArray binArray)
              throws AisMessageException,
                     SixbitException

Base parse method to be called by all extending classes

Parameters:

binArray - the bin array

Throws:

AisMessageException - the ais message exception

SixbitException - the sixbit exception

encode

protected SixbitEncoder encode()

Base encode method to be called by all extending classes

Returns:

SixbitEncoder sixbit encoder

getEncoded

public abstract SixbitEncoder getEncoded()

Abstract method to be implemented by all extending classes

Returns:

SixbitEncoder encoded

getMsgId

public int getMsgId()

Gets msg id.

Returns:

the msg id

getRepeat

public int getRepeat()

Gets repeat.

Returns:

the repeat

setRepeat

public void setRepeat(int repeat)

Sets repeat.

Parameters:

repeat - the repeat

getUserId

public int getUserId()

Gets user id.

Returns:

the user id

setUserId

public void setUserId(int userId)

Sets user id.

Parameters:

userId - the user id

getSourceTag

public IProprietarySourceTag getSourceTag()

Return the LAST source tag (closest to AIS sentence)

Returns:

source tag

getTags

public LinkedList<IProprietaryTag> getTags()

Get all tags

Returns:

tags

setTag

public void setTag(IProprietaryTag tag)

Add tag (to front)

Parameters:

tag - the tag

setTags

public void setTags(LinkedList<IProprietaryTag> tags)

Sets tags.

Parameters:

tags - the tags

getVdm

public Vdm getVdm()

Get VDM this message was encapsulated in

Returns:

Vdm vdm

getValidPosition

public dk.dma.enav.model.geometry.Position getValidPosition()

Returns a valid position if this message has a valid position, otherwise null.

Returns:

a valid position if this message has a valid position, otherwise null

getTargetType

public AisTargetType getTargetType()

Returns the target type of the message or null if the message does not have a target type.

Returns:

the target type of the message or null if the message does not have a target type

getInstance

public static AisMessage getInstance(Vdm vdm)
                              throws AisMessageException,
                                     SixbitException

Given VDM return the encapsulated AIS message. To determine which message is returned use instanceof operator or getMsgId() before casting.

Example: AisMessage aisMessage = AisMessage.getInstance(vmd); if (aisMessage instanceof AisPositionMessage) { AisPositionMessage posMessage = (AisPositionMessage)aisMessage; } ...

Parameters:

vdm - the vdm

Returns:

AisMessage instance

Throws:

AisMessageException - the ais message exception

SixbitException - the sixbit exception

trimText

public static String trimText(String text)

Utility to trim text from AIS message

Parameters:

text - the text

Returns:

string

reassemble

public String reassemble()

Method for reassembling original message appending possible proprietary source tags

Returns:

string

toString

public String toString()

Overrides:

toString in class Object