dk.dma.ais.packet

Class AisPacketOutputSinks

java.lang.Object

dk.dma.ais.packet.AisPacketOutputSinks

public class AisPacketOutputSinks
extends Object

Common sink that can be used to convert AIS packets to text.

Author:

Kasper Nielsen

Field Summary

Fields

Modifier and Type	Field and Description
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	OUTPUT_PREFIXED_SENTENCES A sink that writes an AIS packet to an output stream.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	OUTPUT_TO_HTML A sink that writes an AIS packet to an output stream.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	OUTPUT_TO_TEXT A sink that writes an ais packet to an output stream.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	PAST_TRACK_JSON A sink that writes an AIS packet the past track as a JSON to an output stream.

Constructor Summary

Constructors

Constructor and Description
AisPacketOutputSinks()

Method Summary

Modifier and Type	Method and Description
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	getOutputSink(String... params) Gets output sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	jsonMessageSink() A sink that writes ais messages as JSON to an output stream.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	jsonObjectSink(String format) Json object sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	jsonPosListSink() Json pos list sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	jsonStaticListSink() Json static list sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newCsvSink() New csv sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newCsvSink(String format) New csv sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newCsvStatefulSink() New csv stateful sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newCsvStatefulSink(String format) New csv stateful sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newKmlSink() New kml sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newKmlSink(Predicate<? super AisPacket> filter) New kml sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newKmlSink(Predicate<? super AisPacket> filter, boolean createSituationFolder, boolean createMovementsFolder, boolean createTracksFolder, Predicate<? super AisPacket> isPrimaryTarget, Predicate<? super AisPacket> isSecondaryTarget, Predicate<? super AisPacket> triggerSnapshot, Supplier<? extends String> snapshotDescriptionSupplier, Supplier<? extends Integer> movementInterpolationStep, BiFunction<? super ShipTypeCargo,? super NavigationalStatus,? extends String> iconHrefSupplier) New kml sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newKmlSink(Predicate<? super AisPacket> filter, boolean createSituationFolder, boolean createMovementsFolder, boolean createTracksFolder, Predicate<? super AisPacket> isPrimaryTarget, Predicate<? super AisPacket> isSecondaryTarget, Predicate<? super AisPacket> triggerSnapshot, Supplier<? extends String> snapshotDescriptionSupplier, Supplier<? extends Integer> movementInterpolationStep, Supplier<? extends String> supplyTitle, Supplier<? extends String> supplyDescription, BiFunction<? super ShipTypeCargo,? super NavigationalStatus,? extends String> iconHrefSupplier) New kml sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newKmzSink() New kmz sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newKmzSink(Predicate<? super AisPacket> filter) New kmz sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newKmzSink(Predicate<? super AisPacket> filter, boolean createSituationFolder, boolean createMovementsFolder, boolean createTracksFolder, Predicate<? super AisPacket> isPrimaryTarget, Predicate<? super AisPacket> isSecondaryTarget, Predicate<? super AisPacket> triggerSnapshot, Supplier<? extends String> snapshotDescriptionSupplier, Supplier<? extends Integer> movementInterpolationStep, BiFunction<? super ShipTypeCargo,? super NavigationalStatus,? extends String> iconHrefSupplier) New kmz sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newKmzSink(Predicate<? super AisPacket> filter, boolean createSituationFolder, boolean createMovementsFolder, boolean createTracksFolder, Predicate<? super AisPacket> isPrimaryTarget, Predicate<? super AisPacket> isSecondaryTarget, Predicate<? super AisPacket> triggerSnapshot, Supplier<? extends String> snapshotDescriptionSupplier, Supplier<? extends Integer> movementInterpolationStep, Supplier<? extends String> supplyTitle, Supplier<? extends String> supplyDescription, BiFunction<? super ShipTypeCargo,? super NavigationalStatus,? extends String> iconHrefSupplier) New kmz sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newTableSink(String columns, boolean writeHeader) New table sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	newTableSink(String columns, boolean writeHeader, String seperator) New table sink output stream sink.
static dk.dma.commons.util.io.OutputStreamSink<AisPacket>	OUTPUT_TO_KML() A sink that transforms ais stream into kml.

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_TO_TEXT

public static final dk.dma.commons.util.io.OutputStreamSink<AisPacket> OUTPUT_TO_TEXT

A sink that writes an ais packet to an output stream. Using the default multi-line format.

PAST_TRACK_JSON

public static final dk.dma.commons.util.io.OutputStreamSink<AisPacket> PAST_TRACK_JSON

A sink that writes an AIS packet the past track as a JSON to an output stream. The implementation is a little bit special. Because we are stateless, ending tags are written when the next package is received. Or the end is reached.

OUTPUT_PREFIXED_SENTENCES

public static final dk.dma.commons.util.io.OutputStreamSink<AisPacket> OUTPUT_PREFIXED_SENTENCES

A sink that writes an AIS packet to an output stream. Printing only the actual sentence .

OUTPUT_TO_HTML

public static final dk.dma.commons.util.io.OutputStreamSink<AisPacket> OUTPUT_TO_HTML

A sink that writes an AIS packet to an output stream. Using the default multi-line format.

Constructor Detail

AisPacketOutputSinks

public AisPacketOutputSinks()

Method Detail

jsonMessageSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> jsonMessageSink()

A sink that writes ais messages as JSON to an output stream. Each Line is a valid json object.

Returns:

the output stream sink

jsonObjectSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> jsonObjectSink(String format)

Json object sink output stream sink.

Parameters:

format - the format

Returns:

the output stream sink

jsonPosListSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> jsonPosListSink()

Json pos list sink output stream sink.

Returns:

the output stream sink

jsonStaticListSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> jsonStaticListSink()

Json static list sink output stream sink.

Returns:

the output stream sink

OUTPUT_TO_KML

public static final dk.dma.commons.util.io.OutputStreamSink<AisPacket> OUTPUT_TO_KML()

A sink that transforms ais stream into kml. @return the output stream sink

Returns:

the output stream sink

newTableSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newTableSink(String columns,
                                                                              boolean writeHeader)

New table sink output stream sink.

Parameters:

columns - the columns

writeHeader - the write header

Returns:

the output stream sink

newTableSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newTableSink(String columns,
                                                                              boolean writeHeader,
                                                                              String seperator)

New table sink output stream sink.

Parameters:

columns - the columns

writeHeader - the write header

seperator - the seperator

Returns:

the output stream sink

newCsvSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newCsvSink()

New csv sink output stream sink.

Returns:

the output stream sink

newCsvSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newCsvSink(String format)

New csv sink output stream sink.

Parameters:

format - the format

Returns:

the output stream sink

newCsvStatefulSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newCsvStatefulSink()

New csv stateful sink output stream sink.

Returns:

the output stream sink

newCsvStatefulSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newCsvStatefulSink(String format)

New csv stateful sink output stream sink.

Parameters:

format - the format

Returns:

the output stream sink

newKmlSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newKmlSink()

New kml sink output stream sink.

Returns:

the output stream sink

newKmlSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newKmlSink(Predicate<? super AisPacket> filter)

New kml sink output stream sink.

Parameters:

filter - the filter

Returns:

the output stream sink

newKmlSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newKmlSink(Predicate<? super AisPacket> filter,
                                                                            boolean createSituationFolder,
                                                                            boolean createMovementsFolder,
                                                                            boolean createTracksFolder,
                                                                            Predicate<? super AisPacket> isPrimaryTarget,
                                                                            Predicate<? super AisPacket> isSecondaryTarget,
                                                                            Predicate<? super AisPacket> triggerSnapshot,
                                                                            Supplier<? extends String> snapshotDescriptionSupplier,
                                                                            Supplier<? extends Integer> movementInterpolationStep,
                                                                            BiFunction<? super ShipTypeCargo,? super NavigationalStatus,? extends String> iconHrefSupplier)

New kml sink output stream sink.

Parameters:

filter - the filter

createSituationFolder - the create situation folder

createMovementsFolder - the create movements folder

createTracksFolder - the create tracks folder

isPrimaryTarget - the is primary target

isSecondaryTarget - the is secondary target

triggerSnapshot - the trigger snapshot

snapshotDescriptionSupplier - the snapshot description supplier

movementInterpolationStep - the movement interpolation step

iconHrefSupplier - the icon href supplier

Returns:

the output stream sink

newKmlSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newKmlSink(Predicate<? super AisPacket> filter,
                                                                            boolean createSituationFolder,
                                                                            boolean createMovementsFolder,
                                                                            boolean createTracksFolder,
                                                                            Predicate<? super AisPacket> isPrimaryTarget,
                                                                            Predicate<? super AisPacket> isSecondaryTarget,
                                                                            Predicate<? super AisPacket> triggerSnapshot,
                                                                            Supplier<? extends String> snapshotDescriptionSupplier,
                                                                            Supplier<? extends Integer> movementInterpolationStep,
                                                                            Supplier<? extends String> supplyTitle,
                                                                            Supplier<? extends String> supplyDescription,
                                                                            BiFunction<? super ShipTypeCargo,? super NavigationalStatus,? extends String> iconHrefSupplier)

New kml sink output stream sink.

Parameters:

filter - the filter

createSituationFolder - the create situation folder

createMovementsFolder - the create movements folder

createTracksFolder - the create tracks folder

isPrimaryTarget - the is primary target

isSecondaryTarget - the is secondary target

triggerSnapshot - the trigger snapshot

snapshotDescriptionSupplier - the snapshot description supplier

movementInterpolationStep - the movement interpolation step

supplyTitle - the supply title

supplyDescription - the supply description

iconHrefSupplier - the icon href supplier

Returns:

the output stream sink

newKmzSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newKmzSink()

New kmz sink output stream sink.

Returns:

the output stream sink

newKmzSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newKmzSink(Predicate<? super AisPacket> filter)

New kmz sink output stream sink.

Parameters:

filter - the filter

Returns:

the output stream sink

newKmzSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newKmzSink(Predicate<? super AisPacket> filter,
                                                                            boolean createSituationFolder,
                                                                            boolean createMovementsFolder,
                                                                            boolean createTracksFolder,
                                                                            Predicate<? super AisPacket> isPrimaryTarget,
                                                                            Predicate<? super AisPacket> isSecondaryTarget,
                                                                            Predicate<? super AisPacket> triggerSnapshot,
                                                                            Supplier<? extends String> snapshotDescriptionSupplier,
                                                                            Supplier<? extends Integer> movementInterpolationStep,
                                                                            BiFunction<? super ShipTypeCargo,? super NavigationalStatus,? extends String> iconHrefSupplier)

New kmz sink output stream sink.

Parameters:

filter - the filter

createSituationFolder - the create situation folder

createMovementsFolder - the create movements folder

createTracksFolder - the create tracks folder

isPrimaryTarget - the is primary target

isSecondaryTarget - the is secondary target

triggerSnapshot - the trigger snapshot

snapshotDescriptionSupplier - the snapshot description supplier

movementInterpolationStep - the movement interpolation step

iconHrefSupplier - the icon href supplier

Returns:

the output stream sink

newKmzSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> newKmzSink(Predicate<? super AisPacket> filter,
                                                                            boolean createSituationFolder,
                                                                            boolean createMovementsFolder,
                                                                            boolean createTracksFolder,
                                                                            Predicate<? super AisPacket> isPrimaryTarget,
                                                                            Predicate<? super AisPacket> isSecondaryTarget,
                                                                            Predicate<? super AisPacket> triggerSnapshot,
                                                                            Supplier<? extends String> snapshotDescriptionSupplier,
                                                                            Supplier<? extends Integer> movementInterpolationStep,
                                                                            Supplier<? extends String> supplyTitle,
                                                                            Supplier<? extends String> supplyDescription,
                                                                            BiFunction<? super ShipTypeCargo,? super NavigationalStatus,? extends String> iconHrefSupplier)

New kmz sink output stream sink.

Parameters:

filter - the filter

createSituationFolder - the create situation folder

createMovementsFolder - the create movements folder

createTracksFolder - the create tracks folder

isPrimaryTarget - the is primary target

isSecondaryTarget - the is secondary target

triggerSnapshot - the trigger snapshot

snapshotDescriptionSupplier - the snapshot description supplier

movementInterpolationStep - the movement interpolation step

supplyTitle - the supply title

supplyDescription - the supply description

iconHrefSupplier - the icon href supplier

Returns:

the output stream sink

getOutputSink

public static dk.dma.commons.util.io.OutputStreamSink<AisPacket> getOutputSink(String... params)
                                                                        throws IllegalArgumentException,
                                                                               IllegalAccessException,
                                                                               NoSuchFieldException,
                                                                               SecurityException

Gets output sink.

Parameters:

params - the params

Returns:

the output sink

Throws:

IllegalArgumentException - the illegal argument exception

IllegalAccessException - the illegal access exception

NoSuchFieldException - the no such field exception

SecurityException - the security exception