dk.dma.ais.packet

Class AisPacketFiltersStateful

java.lang.Object

dk.dma.ais.packet.AisPacketFiltersBase

dk.dma.ais.packet.AisPacketFiltersStateful

All Implemented Interfaces:

FilterPredicateFactory

public class AisPacketFiltersStateful
extends AisPacketFiltersBase

This class provides factory methods to create Predicate<AisPacket> functions which can be used to filter AisPackets.

As opposed to the AisPacketFilters class, this class is designed to create predicates which "remember" some state of AisPackets that have previously been served. This implies, that it is possible to establish more advanced filtering, than just inspecting the current AisPacket.

Instead, with this stateful filter, it is possible to generate Predicates which can e.g. filter away AisStaticCommon packages for targets whose position is outside some defined area.

Since:

v2.1

Author:

Thomas Borg Salling <tbsalling@tbsalling.dk>

Constructor Summary

Constructors

Constructor and Description
AisPacketFiltersStateful() Instantiates a new Ais packet filters stateful.

Method Summary

Modifier and Type	Method and Description
Predicate<AisPacket>	filterOnTargetCallsign(CompareToOperator operator, String rhsCallsign) Return false if this message is known to be related to a target with a callsign not comparing to rhs parameter.
Predicate<AisPacket>	filterOnTargetCallsignMatch(String pattern) Return false if this message is known to be related to a target with a callsign not comparing to rhs parameter.
Predicate<AisPacket>	filterOnTargetCourseOverGround(CompareToOperator operator, Float cog) Return false if this message is known to be related to a target with a COG comparing false to 'cog'.
Predicate<AisPacket>	filterOnTargetCourseOverGround(float min, float max) Return false if this message is known to be related to a target with a COG outside the given range.
Predicate<AisPacket>	filterOnTargetDraught(CompareToOperator operator, Float draught) Return false if this message is known to be related to a target with a draught comparing false to 'draught'.
Predicate<AisPacket>	filterOnTargetDraught(float min, float max) Return false if this message is known to be related to a target with a draught outside the given range.
Predicate<AisPacket>	filterOnTargetImo(CompareToOperator operator, Integer rhsImo) Return false if this message is known to be related to a target with an IMO no. different to 'imo'.
Predicate<AisPacket>	filterOnTargetImo(Integer[] imos) Return false if this message is known to be related to a target with an IMO outside the given list.
Predicate<AisPacket>	filterOnTargetImo(int min, int max) Return false if this message is known to be related to a target with an IMO outside the given range.
Predicate<AisPacket>	filterOnTargetLatitude(CompareToOperator operator, Float lat) Return false if this message is known to be related to a target with a latitude comparing false to 'lat'.
Predicate<AisPacket>	filterOnTargetLatitude(float min, float max) Return false if this message is known to be related to a target with a latitude outside the given range.
Predicate<AisPacket>	filterOnTargetLongitude(CompareToOperator operator, Float lon) Return false if this message is known to be related to a target with a longitude comparing false to 'lon'.
Predicate<AisPacket>	filterOnTargetLongitude(float min, float max) Return false if this message is known to be related to a target with a longitude outside the given range.
Predicate<AisPacket>	filterOnTargetName(CompareToOperator operator, String rhsName) Return false if this message is known to be related to a target with a name not comparing to rhs parameter.
Predicate<AisPacket>	filterOnTargetNameMatch(String pattern) Return false if this message is known to be related to a target with a name not comparing to rhs parameter.
Predicate<AisPacket>	filterOnTargetNavigationalStatus(CompareToOperator operator, Integer rhsNavstat) Return false if this message is known to be related to a target with an navstat different to the rhs parameter.
Predicate<AisPacket>	filterOnTargetNavigationalStatus(Integer[] navstats) Return false if this message is known to be related to a target with a navstat outside the given list.
Predicate<AisPacket>	filterOnTargetNavigationalStatus(int min, int max) Return false if this message is known to be related to a target with a navstat outside the given range.
Predicate<AisPacket>	filterOnTargetPositionWithin(dk.dma.enav.model.geometry.Area area) Filter on message to have known position inside given area.
Predicate<AisPacket>	filterOnTargetShiptype(CompareToOperator operator, Integer rhsShiptype) Return false if this message is known to be related to a target with an IMO no. different to 'imo'.
Predicate<AisPacket>	filterOnTargetShiptype(Integer[] shiptypes) Return false if this message is known to be related to a target with a ship type outside the given list.
Predicate<AisPacket>	filterOnTargetShiptype(int min, int max) Return false if this message is known to be related to a target with an shiptype outside the given range.
Predicate<AisPacket>	filterOnTargetSpeedOverGround(CompareToOperator operator, Float sog) Return false if this message is known to be related to a target with a SOG comparing false to 'sog'.
Predicate<AisPacket>	filterOnTargetSpeedOverGround(float min, float max) Return false if this message is known to be related to a target with a SOG outside the given range.
Predicate<AisPacket>	filterOnTargetTrueHeading(CompareToOperator operator, Integer hdg) Return false if this message is known to be related to a target with a COG comparing false to 'hdg'.
Predicate<AisPacket>	filterOnTargetTrueHeading(int min, int max) Return false if this message is known to be related to a target with a COG outside the given range.

Methods inherited from class dk.dma.ais.packet.AisPacketFiltersBase

compare, compare, compare, inRange, inRange, matchesGlob, preprocessAisString, preprocessExpressionString, preprocessExpressionStrings

Methods inherited from class java.lang.Object

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

Constructor Detail

AisPacketFiltersStateful

public AisPacketFiltersStateful()

Instantiates a new Ais packet filters stateful.

Method Detail

filterOnTargetImo

public Predicate<AisPacket> filterOnTargetImo(CompareToOperator operator,
                                              Integer rhsImo)

Return false if this message is known to be related to a target with an IMO no. different to 'imo'.

Parameters:

operator - the operator

rhsImo - the rhs imo

Returns:

predicate predicate

filterOnTargetImo

public Predicate<AisPacket> filterOnTargetImo(int min,
                                              int max)

Return false if this message is known to be related to a target with an IMO outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetImo

public Predicate<AisPacket> filterOnTargetImo(Integer[] imos)

Return false if this message is known to be related to a target with an IMO outside the given list.

Parameters:

imos - the imos

Returns:

the predicate

filterOnTargetShiptype

public Predicate<AisPacket> filterOnTargetShiptype(CompareToOperator operator,
                                                   Integer rhsShiptype)

Return false if this message is known to be related to a target with an IMO no. different to 'imo'.

Parameters:

operator - the operator

rhsShiptype - the rhs shiptype

Returns:

predicate predicate

filterOnTargetShiptype

public Predicate<AisPacket> filterOnTargetShiptype(int min,
                                                   int max)

Return false if this message is known to be related to a target with an shiptype outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetShiptype

public Predicate<AisPacket> filterOnTargetShiptype(Integer[] shiptypes)

Return false if this message is known to be related to a target with a ship type outside the given list.

Parameters:

shiptypes - the shiptypes

Returns:

the predicate

filterOnTargetNavigationalStatus

public Predicate<AisPacket> filterOnTargetNavigationalStatus(CompareToOperator operator,
                                                             Integer rhsNavstat)

Return false if this message is known to be related to a target with an navstat different to the rhs parameter.

Parameters:

operator - the operator

rhsNavstat - the rhs navstat

Returns:

predicate predicate

filterOnTargetNavigationalStatus

public Predicate<AisPacket> filterOnTargetNavigationalStatus(int min,
                                                             int max)

Return false if this message is known to be related to a target with a navstat outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetNavigationalStatus

public Predicate<AisPacket> filterOnTargetNavigationalStatus(Integer[] navstats)

Return false if this message is known to be related to a target with a navstat outside the given list.

Parameters:

navstats - the navstats

Returns:

the predicate

filterOnTargetSpeedOverGround

public Predicate<AisPacket> filterOnTargetSpeedOverGround(CompareToOperator operator,
                                                          Float sog)

Return false if this message is known to be related to a target with a SOG comparing false to 'sog'.

Parameters:

operator - the operator

sog - the sog

Returns:

predicate predicate

filterOnTargetSpeedOverGround

public Predicate<AisPacket> filterOnTargetSpeedOverGround(float min,
                                                          float max)

Return false if this message is known to be related to a target with a SOG outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetCourseOverGround

public Predicate<AisPacket> filterOnTargetCourseOverGround(CompareToOperator operator,
                                                           Float cog)

Return false if this message is known to be related to a target with a COG comparing false to 'cog'.

Parameters:

operator - the operator

cog - the cog

Returns:

predicate predicate

filterOnTargetCourseOverGround

public Predicate<AisPacket> filterOnTargetCourseOverGround(float min,
                                                           float max)

Return false if this message is known to be related to a target with a COG outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetTrueHeading

public Predicate<AisPacket> filterOnTargetTrueHeading(CompareToOperator operator,
                                                      Integer hdg)

Return false if this message is known to be related to a target with a COG comparing false to 'hdg'.

Parameters:

operator - the operator

hdg - the hdg

Returns:

predicate predicate

filterOnTargetTrueHeading

public Predicate<AisPacket> filterOnTargetTrueHeading(int min,
                                                      int max)

Return false if this message is known to be related to a target with a COG outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetDraught

public Predicate<AisPacket> filterOnTargetDraught(CompareToOperator operator,
                                                  Float draught)

Return false if this message is known to be related to a target with a draught comparing false to 'draught'.

Parameters:

operator - the operator

draught - the draught

Returns:

predicate predicate

filterOnTargetDraught

public Predicate<AisPacket> filterOnTargetDraught(float min,
                                                  float max)

Return false if this message is known to be related to a target with a draught outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetLatitude

public Predicate<AisPacket> filterOnTargetLatitude(CompareToOperator operator,
                                                   Float lat)

Return false if this message is known to be related to a target with a latitude comparing false to 'lat'.

Parameters:

operator - the operator

lat - the lat

Returns:

predicate predicate

filterOnTargetLatitude

public Predicate<AisPacket> filterOnTargetLatitude(float min,
                                                   float max)

Return false if this message is known to be related to a target with a latitude outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetLongitude

public Predicate<AisPacket> filterOnTargetLongitude(CompareToOperator operator,
                                                    Float lon)

Return false if this message is known to be related to a target with a longitude comparing false to 'lon'.

Parameters:

operator - the operator

lon - the lon

Returns:

predicate predicate

filterOnTargetLongitude

public Predicate<AisPacket> filterOnTargetLongitude(float min,
                                                    float max)

Return false if this message is known to be related to a target with a longitude outside the given range.

Parameters:

min - the min

max - the max

Returns:

the predicate

filterOnTargetName

public Predicate<AisPacket> filterOnTargetName(CompareToOperator operator,
                                               String rhsName)

Return false if this message is known to be related to a target with a name not comparing to rhs parameter.

Parameters:

operator - the operator

rhsName - the rhs name

Returns:

predicate predicate

filterOnTargetNameMatch

public Predicate<AisPacket> filterOnTargetNameMatch(String pattern)

Return false if this message is known to be related to a target with a name not comparing to rhs parameter.

Parameters:

pattern - the pattern

Returns:

predicate predicate

filterOnTargetCallsign

public Predicate<AisPacket> filterOnTargetCallsign(CompareToOperator operator,
                                                   String rhsCallsign)

Return false if this message is known to be related to a target with a callsign not comparing to rhs parameter.

Parameters:

operator - the operator

rhsCallsign - the rhs callsign

Returns:

predicate predicate

filterOnTargetCallsignMatch

public Predicate<AisPacket> filterOnTargetCallsignMatch(String pattern)

Return false if this message is known to be related to a target with a callsign not comparing to rhs parameter.

Parameters:

pattern - the pattern

Returns:

predicate predicate

filterOnTargetPositionWithin

public Predicate<AisPacket> filterOnTargetPositionWithin(dk.dma.enav.model.geometry.Area area)

Filter on message to have known position inside given area.

Parameters:

area - The area that the position must reside inside.

Returns:

predicate predicate