dk.dma.ais.sentence

Class Sentence

java.lang.Object

dk.dma.ais.sentence.Sentence

Direct Known Subclasses:

AnySentence, EncapsulatedSentence, ParametricSentence

public abstract class Sentence
extends Object

Abstract base class for representing IEC sentences

Field Summary

Fields

Modifier and Type	Field and Description
protected int	checksum The Checksum.
protected CommentBlock	commentBlock The Comment block.
protected String	delimiter The Delimiter.
protected LinkedList<String>	encodedFields The Encoded fields.
protected String	formatter The Formatter.
protected String	msgChecksum The Msg checksum.
protected Date	mssisTimestamp The Mssis timestamp.
protected List<String>	orgLines The Org lines.
protected List<String>	rawSentences The Raw sentences.
protected String	sentenceStr The Sentence str.
protected LinkedList<IProprietaryTag>	tags The Tags.
protected String	talker The Talker.

Constructor Summary

Constructors

Constructor and Description
Sentence()

Method Summary

Modifier and Type	Method and Description
void	addSingleCommentBlock(String line) Add single comment block.
protected void	baseParse(SentenceLine sl) Basic parse of line into sentence parts
static String	convert(String sentence, String talker, String formatter) Convert any sentence to new sentence with !
protected void	encode() The top most encode method
protected String	finalEncode() Method to finalize the encoding and return sentence
static Date	findMssisTimestamp(SentenceLine sentenceLine) Try to get the proprietary MSSIS timestamp appended to the NMEA sentence
static int	getChecksum(String sentence) Calculate checksum of sentence
CommentBlock	getCommentBlock() Get possible comment block
abstract String	getEncoded() Get an encoded sentence
Date	getMssisTimestamp() Get found MSSIS timestamp
List<String>	getOrgLines() Get original lines for this sentence
String	getOrgLinesJoined() Get original lines joined by carriage return line feed
List<String>	getRawSentences() Get original raw sentences without any prefix
String	getRawSentencesJoined() Get original raw sentences without any prefix joined by carriage return line feed
IProprietarySourceTag	getSourceTag() Return the LAST source tag (closest to AIS sentence)
static String	getStringChecksum(int checksum) Get checksum string representation
LinkedList<IProprietaryTag>	getTags() Get all tags
Date	getTimestamp() Try to get timestamp in this order: Comment block timestamp, proprietary tag timestamp and MSSIS timestamp
static boolean	hasSentence(String line) Determine if a line seems to contain a sentence There should be a !
abstract int	parse(SentenceLine sl) Abstract method that all sentence classes must implement The method handles assembly and extraction of the 6-bit data from sentences.
static int	parseInt(String str) Parse int int.
void	setDelimiter(String delimiter) Set delimiter
void	setFormatter(String formatter) Set formatter
void	setTag(IProprietaryTag tag) Add tag (to front)
void	setTags(LinkedList<IProprietaryTag> tags) Sets tags.
void	setTalker(String talker) Set talker

Methods inherited from class java.lang.Object

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

Field Detail

delimiter

protected String delimiter

The Delimiter.

talker

protected String talker

The Talker.

formatter

protected String formatter

The Formatter.

checksum

protected int checksum

The Checksum.

msgChecksum

protected String msgChecksum

The Msg checksum.

sentenceStr

protected String sentenceStr

The Sentence str.

orgLines

protected List<String> orgLines

The Org lines.

rawSentences

protected List<String> rawSentences

The Raw sentences.

encodedFields

protected LinkedList<String> encodedFields

The Encoded fields.

commentBlock

protected CommentBlock commentBlock

The Comment block.

tags

protected LinkedList<IProprietaryTag> tags

The Tags.

mssisTimestamp

protected Date mssisTimestamp

The Mssis timestamp.

Constructor Detail

Sentence

public Sentence()

Method Detail

parse

public abstract int parse(SentenceLine sl)
                   throws SentenceException,
                          SixbitException

Abstract method that all sentence classes must implement

The method handles assembly and extraction of the 6-bit data from sentences. The sentence is expected to be in order.

It will return an error if received line is out of order or from a new sequence before the previous one is finished.

Parameters:

sl - the sl

Returns:

0 Complete packet - 1 Incomplete packet

Throws:

SentenceException - the sentence exception

SixbitException - the sixbit exception

getEncoded

public abstract String getEncoded()

Get an encoded sentence

Returns:

encoded

baseParse

protected void baseParse(SentenceLine sl)
                  throws SentenceException

Basic parse of line into sentence parts

Parameters:

sl - the sl

Throws:

SentenceException - the sentence exception

addSingleCommentBlock

public void addSingleCommentBlock(String line)
                           throws SentenceException

Add single comment block.

Parameters:

line - the line

Throws:

SentenceException - the sentence exception

encode

protected void encode()

The top most encode method

finalEncode

protected String finalEncode()

Method to finalize the encoding and return sentence

Returns:

final sentence

getChecksum

public static int getChecksum(String sentence)
                       throws SentenceException

Calculate checksum of sentence

Parameters:

sentence - the sentence

Returns:

checksum

Throws:

SentenceException - the sentence exception

getStringChecksum

public static String getStringChecksum(int checksum)

Get checksum string representation

Parameters:

checksum - the checksum

Returns:

string checksum

findMssisTimestamp

public static Date findMssisTimestamp(SentenceLine sentenceLine)

Try to get the proprietary MSSIS timestamp appended to the NMEA sentence

Parameters:

sentenceLine - the sentence line

Returns:

date

getMssisTimestamp

public Date getMssisTimestamp()

Get found MSSIS timestamp

Returns:

mssis timestamp

getTimestamp

public Date getTimestamp()

Try to get timestamp in this order: Comment block timestamp, proprietary tag timestamp and MSSIS timestamp

Returns:

timestamp

parseInt

public static int parseInt(String str)
                    throws SentenceException

Parse int int.

Parameters:

str - the str

Returns:

the int

Throws:

SentenceException - the sentence exception

hasSentence

public static boolean hasSentence(String line)

Determine if a line seems to contain a sentence There should be a ! or $

Parameters:

line - the line

Returns:

boolean

getOrgLines

public List<String> getOrgLines()

Get original lines for this sentence

Returns:

org lines

getOrgLinesJoined

public String getOrgLinesJoined()

Get original lines joined by carriage return line feed

Returns:

org lines joined

getRawSentences

public List<String> getRawSentences()

Get original raw sentences without any prefix

Returns:

raw sentences

getRawSentencesJoined

public String getRawSentencesJoined()

Get original raw sentences without any prefix joined by carriage return line feed

Returns:

raw sentences joined

setTalker

public void setTalker(String talker)

Set talker

Parameters:

talker - the talker

setDelimiter

public void setDelimiter(String delimiter)

Set delimiter

Parameters:

delimiter - the delimiter

setFormatter

public void setFormatter(String formatter)

Set formatter

Parameters:

formatter - the formatter

getCommentBlock

public CommentBlock getCommentBlock()

Get possible comment block

Returns:

comment block

getTags

public LinkedList<IProprietaryTag> getTags()

Get all tags

Returns:

tags

setTags

public void setTags(LinkedList<IProprietaryTag> tags)

Sets tags.

Parameters:

tags - the tags

getSourceTag

public IProprietarySourceTag getSourceTag()

Return the LAST source tag (closest to AIS sentence)

Returns:

source tag

setTag

public void setTag(IProprietaryTag tag)

Add tag (to front)

Parameters:

tag - the tag

convert

public static String convert(String sentence,
                             String talker,
                             String formatter)
                      throws SentenceException

Convert any sentence to new sentence with !

 <talker><formatter>,...., 

Parameters:

sentence - the sentence

talker - the talker

formatter - the formatter

Returns:

string

Throws:

SentenceException - the sentence exception