dk.dma.ais.packet

Class AisPacketReader

java.lang.Object

dk.dma.ais.packet.AisPacketReader

All Implemented Interfaces:

AutoCloseable, Iterable<AisPacket>

public class AisPacketReader
extends Object
implements AutoCloseable, Iterable<AisPacket>

Class for reading AIS packet streams.

Author:

Kasper Nielsen

Field Summary

Fields

Modifier and Type	Field and Description
protected AisPacketParser	packetReader Reader to parse lines and deliver complete AIS packets.

Constructor Summary

Constructors

Constructor and Description
AisPacketReader(InputStream stream) Create

Method Summary

Modifier and Type	Method and Description
void	close()
static AisPacketReader	createFromFile(Path p, boolean throwExceptions) Creates a new AIS packet reader from the specified file.
static AisPacketReader	createFromSystemResource(String resourceName, boolean throwExceptions) Create from system resource ais packet reader.
void	forEachRemaining(Consumer<? super AisPacket>... consumers) For each remaining.
void	forEachRemainingMessage(Consumer<? super AisMessage>... consumers) For each remaining message.
long	getNumberOfBytesRead() Returns the number of bytes read by this reader.
long	getNumberOfLinesRead() Returns the number of lines read by this reader.
long	getNumberOfPacketsRead() Returns the number of packets read by this reader.
protected void	handleAbk(Abk abk) Override this method to handle Abk sentences.
Iterator<AisPacket>	iterator()
AisPacket	readPacket() Read packet ais packet.
AisPacketStream	stream() Returns a AIS packet stream running in a new thread.
AisPacketStream	stream(Executor e) Returns a AIS packet stream using the specified executor.
void	writeTo(OutputStream os, dk.dma.commons.util.io.OutputStreamSink<AisPacket> sink) Writes the reminder of packets to the output stream using the specified sink

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

packetReader

protected final AisPacketParser packetReader

Reader to parse lines and deliver complete AIS packets.

Constructor Detail

AisPacketReader

public AisPacketReader(InputStream stream)

Create

Parameters:

stream - the input stream to read data from

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

getNumberOfBytesRead

public long getNumberOfBytesRead()

Returns the number of bytes read by this reader.

Returns:

the number of bytes read by this reader

getNumberOfLinesRead

public long getNumberOfLinesRead()

Returns the number of lines read by this reader.

Returns:

the number of lines read by this reader

getNumberOfPacketsRead

public long getNumberOfPacketsRead()

Returns the number of packets read by this reader.

Returns:

the number of packets read by this reader

handleAbk

protected void handleAbk(Abk abk)

Override this method to handle Abk sentences.

Parameters:

abk - the sentence to handle

forEachRemaining

@SafeVarargs
public final void forEachRemaining(Consumer<? super AisPacket>... consumers)
                                         throws IOException

For each remaining.

Parameters:

consumers - the consumers

Throws:

IOException - the io exception

forEachRemainingMessage

@SafeVarargs
public final void forEachRemainingMessage(Consumer<? super AisMessage>... consumers)
                                                throws IOException

For each remaining message.

Parameters:

consumers - the consumers

Throws:

IOException - the io exception

readPacket

public AisPacket readPacket()
                     throws IOException

Read packet ais packet.

Returns:

the next packet or null if the end of the stream has been reached

Throws:

IOException - if an exception occurred while reading the packet

stream

public AisPacketStream stream()

Returns a AIS packet stream running in a new thread.

Returns:

a AIS packet stream running in a new thread

stream

public AisPacketStream stream(Executor e)

Returns a AIS packet stream using the specified executor.

Parameters:

e - the e

Returns:

a AIS packet stream using the specified executor

createFromSystemResource

public static AisPacketReader createFromSystemResource(String resourceName,
                                                       boolean throwExceptions)
                                                throws IOException

Create from system resource ais packet reader.

Parameters:

resourceName - the resource name

throwExceptions - the throw exceptions

Returns:

the ais packet reader

Throws:

IOException - the io exception

createFromFile

public static AisPacketReader createFromFile(Path p,
                                             boolean throwExceptions)
                                      throws IOException

Creates a new AIS packet reader from the specified file. If the specified file has a '.zip' suffix. The file is automatically treated as a zip file.

Parameters:

p - the path of the file

throwExceptions - whether to throw exceptions or just log them

Returns:

a new reader

Throws:

IOException - if the reader failed to be constructed, for example, if the specified file does not exist

writeTo

public void writeTo(OutputStream os,
                    dk.dma.commons.util.io.OutputStreamSink<AisPacket> sink)
             throws IOException

Writes the reminder of packets to the output stream using the specified sink

Parameters:

os - the output stream to write to

sink - the sink to write to

Throws:

IOException - if the a packet could not be written

iterator

public Iterator<AisPacket> iterator()

Specified by:

iterator in interface Iterable<AisPacket>