stream.lookup

Class AbstractDatabase

java.lang.Object

stream.lookup.AbstractDatabase

All Implemented Interfaces:

LifeCycle, LookupService, Service

Direct Known Subclasses:

CsvDatabase, JSONDatabase

public abstract class AbstractDatabase
extends Object
implements LookupService, LifeCycle

This class is an abstract implementation of the LookupService which provides an in-memory lookup table that is populated from a data source. Specific non-abstract implementations will need to implement the way to read the in-memory lookup table (hashmap).

Author:

Christian Bockermann

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Map<String,Data>	database
(package private) String	key
(package private) static org.slf4j.Logger	log
(package private) SourceURL	url

Constructor Summary

Constructors

Constructor and Description
AbstractDatabase()

Method Summary

Methods

Modifier and Type	Method and Description
void	finish()
String	getKey()
SourceURL	getUrl()
void	init(Context context)
Data	lookup(String key)
protected abstract void	populateDatabase(SourceURL url, Map<String,Data> database)
protected void	readDatabase(Stream stream, Map<String,Data> database)
void	reset()
void	setKey(String key)
void	setUrl(SourceURL url)

Methods inherited from class java.lang.Object

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

Field Detail

log

static org.slf4j.Logger log

database

final Map<String,Data> database

key

String key

url

SourceURL url

Constructor Detail

AbstractDatabase

public AbstractDatabase()

Method Detail

reset

public void reset()
           throws Exception

Specified by:

reset in interface Service

Throws:

Exception

See Also:

Service.reset()

init

public void init(Context context)
          throws Exception

Specified by:

init in interface LifeCycle

Throws:

Exception

See Also:

LifeCycle.init(stream.Context)

populateDatabase

protected abstract void populateDatabase(SourceURL url,
                    Map<String,Data> database)
                                  throws Exception

Throws:

Exception

readDatabase

protected void readDatabase(Stream stream,
                Map<String,Data> database)
                     throws Exception

Throws:

Exception

finish

public void finish()
            throws Exception

Specified by:

finish in interface LifeCycle

Throws:

Exception

See Also:

LifeCycle.finish()

lookup

public Data lookup(String key)

Specified by:

lookup in interface LookupService

See Also:

LookupService.lookup(java.lang.String)

getKey

public String getKey()

Returns:

the key

setKey

@Parameter(description="The lookup-key that is used for storing items in the lookup table. This key must be present in the items that are being read from the datasource while populating the database. Default value is \'@id\'.",
           required=false)
public void setKey(String key)

Parameters:

key - the key to set

getUrl

public SourceURL getUrl()

Returns:

the url

setUrl

@Parameter(description="The source URL from which data should be read at startup. This data is then used for populating the lookup table.",
           required=true)
public void setUrl(SourceURL url)

Parameters:

url - the url to set