dk.dma.ais.reader

Class AisReaders

java.lang.Object

dk.dma.ais.reader.AisReaders

public class AisReaders
extends Object

Factory and utility methods for AisReader, AisTcpReader, AisUdpReader, and AisReaderGroup classes defined in this package.

Author:

Kasper Nielsen

Constructor Summary

Constructors

Constructor and Description
AisReaders()

Method Summary

Modifier and Type	Method and Description
static AisDirectoryReader	createDirectoryReader(String dir, String pattern, boolean recursive) Reader that recursively reads files matching pattern in directories with root dir
static AisReaderGroup	createGroup(String name, List<String> sources) Equivalent to parseSource(String) except that it will parse an array of sources.
static AisReaderGroup	createGroupFromDefaultsSource() Creates a default group from reader available in the system property ais.default.sources
static AisTcpReader	createReader(String commaHostPort) Creates a AisTcpReader from a list of one or more hosts.
static AisTcpReader	createReader(String hostname, int port) Create reader ais tcp reader.
static AisReader	createReaderFromFile(String filename) Creates a AisReader from a file.
static AisReader	createReaderFromInputStream(InputStream inputStream) Create reader from input stream ais reader.
static AisUdpReader	createUdpReader(int port) Creates a AisUdpReader listening on port for any interface
static AisUdpReader	createUdpReader(String address, int port) Creates a AisUdpReader listening on ip and port
static String[]	getDefaultSources() Returns the default sources configured for the system.
static void	manageGroup(AisReaderGroup group) Manage group.

Methods inherited from class java.lang.Object

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

Constructor Detail

AisReaders

public AisReaders()

Method Detail

createGroup

public static AisReaderGroup createGroup(String name,
                                         List<String> sources)

Equivalent to parseSource(String) except that it will parse an array of sources. Returning a map making sure there all source names are unique

Parameters:

name - the name

sources - the sources

Returns:

the ais reader group

createGroupFromDefaultsSource

public static AisReaderGroup createGroupFromDefaultsSource()

Creates a default group from reader available in the system property ais.default.sources

Returns:

a new reader group

See Also:

#getDefaultSources()#getDefaultSources()

createReader

public static AisTcpReader createReader(String commaHostPort)

Creates a AisTcpReader from a list of one or more hosts. On the form: host1:port1,...,hostN:portN

Parameters:

commaHostPort - the comma host port

Returns:

the ais tcp reader

createReader

public static AisTcpReader createReader(String hostname,
                                        int port)

Create reader ais tcp reader.

Parameters:

hostname - the hostname

port - the port

Returns:

the ais tcp reader

createUdpReader

public static AisUdpReader createUdpReader(int port)

Creates a AisUdpReader listening on port for any interface

Parameters:

port - the port

Returns:

ais udp reader

createUdpReader

public static AisUdpReader createUdpReader(String address,
                                           int port)

Creates a AisUdpReader listening on ip and port

Parameters:

address - the address

port - the port

Returns:

ais udp reader

createReaderFromInputStream

public static AisReader createReaderFromInputStream(InputStream inputStream)

Create reader from input stream ais reader.

Parameters:

inputStream - the input stream

Returns:

the ais reader

createReaderFromFile

public static AisReader createReaderFromFile(String filename)
                                      throws IOException

Creates a AisReader from a file. If the file has '.zip' or '.gz' suffix the file will treated as a zip file or gzip file respectively.

Parameters:

filename - the filename

Returns:

ais reader

Throws:

IOException - the io exception

createDirectoryReader

public static AisDirectoryReader createDirectoryReader(String dir,
                                                       String pattern,
                                                       boolean recursive)
                                                throws IOException

Reader that recursively reads files matching pattern in directories with root dir

Parameters:

dir - the dir

pattern - E.g. *.txt or *.gz

recursive - Apply to all sub directories depth first

Returns:

ais directory reader

Throws:

IOException - the io exception

getDefaultSources

public static String[] getDefaultSources()

Returns the default sources configured for the system. The default sources can be set using enviroment variable AIS_DEFAULT_SOURCES.

Returns:

the default sources configured for the system

manageGroup

public static void manageGroup(AisReaderGroup group)
                        throws JMException

Manage group.

Parameters:

group - the group

Throws:

JMException - the jm exception