dk.dma.ais.bus

Class AisBusComponent

java.lang.Object

dk.dma.ais.bus.AisBusComponent

Direct Known Subclasses:

AisBus, AisBusSocket

@ThreadSafe
public abstract class AisBusComponent
extends Object

Base class for all AisBus components receiving and handing of AIS packets. All components are able to filter, transform and tag all received data.

Field Summary

Fields

Modifier and Type	Field and Description
protected PacketFilterCollection	filters Filters to apply to received packets
protected CopyOnWriteArrayList<IAisPacketTransformer>	packetTransformers Transformers to apply
protected AisBusComponentStatus	status The status of the component
static long	THREAD_STOP_WAIT_MAX Maximum time to wait for threads to stop after having been cancelled

Constructor Summary

Constructors

Constructor and Description
AisBusComponent() Instantiates a new Ais bus component.

Method Summary

Modifier and Type	Method and Description
abstract void	cancel() All components must implement a way to stop
PacketFilterCollection	getFilters() Get filters collection
CopyOnWriteArrayList<IAisPacketTransformer>	getPacketTransformers() Get packet transformers list
AisBusComponentStatus	getStatus() Get component status
Thread	getThread() Get component thread
protected AisPacket	handleReceived(AisPacket packet) Method to handle incoming packet for all AisBus components.
void	init() Initialize the component after configuration.
String	rateReport() Rate report string.
void	setConnected() Sets connected.
void	setNotConnected() Sets not connected.
void	setStopped() Sets stopped.
protected void	setThread(Thread thread) Set component thread
void	start() Start the component.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

THREAD_STOP_WAIT_MAX

public static final long THREAD_STOP_WAIT_MAX

Maximum time to wait for threads to stop after having been cancelled

See Also:

Constant Field Values

status

protected final AisBusComponentStatus status

The status of the component

filters

protected final PacketFilterCollection filters

Filters to apply to received packets

packetTransformers

protected final CopyOnWriteArrayList<IAisPacketTransformer> packetTransformers

Transformers to apply

Constructor Detail

AisBusComponent

public AisBusComponent()

Instantiates a new Ais bus component.

Method Detail

init

public void init()

Initialize the component after configuration. Must be called be starting the component.

start

public void start()

Start the component. Must be called after init().

setConnected

public void setConnected()

Sets connected.

setNotConnected

public void setNotConnected()

Sets not connected.

setStopped

public void setStopped()

Sets stopped.

getStatus

public AisBusComponentStatus getStatus()

Get component status

Returns:

status status

setThread

protected void setThread(Thread thread)

Set component thread

Parameters:

thread - the thread

getThread

public Thread getThread()

Get component thread

Returns:

thread thread

cancel

public abstract void cancel()

All components must implement a way to stop

handleReceived

protected AisPacket handleReceived(AisPacket packet)

Method to handle incoming packet for all AisBus components. Will do filtering, transformation and tagging.

Parameters:

packet - the packet

Returns:

ais packet

getFilters

public PacketFilterCollection getFilters()

Get filters collection

Returns:

filters filters

getPacketTransformers

public CopyOnWriteArrayList<IAisPacketTransformer> getPacketTransformers()

Get packet transformers list

Returns:

packet transformers

toString

public String toString()

Overrides:

toString in class Object

rateReport

public String rateReport()

Rate report string.

Returns:

the string