Package org.bedework.timezones.common.db

Class AbstractDb

java.lang.Object

org.bedework.timezones.common.AbstractCachedData

org.bedework.timezones.common.db.AbstractDb

All Implemented Interfaces:

Serializable, CachedData, org.bedework.util.logging.Logged

Direct Known Subclasses:

H2dbCachedData

public abstract class AbstractDb
extends AbstractCachedData

User: mike Date: 6/22/21 Time: 23:07

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractDb.DbIterator<T>
protected static class	AbstractDb.TzEntry
protected class	AbstractDb.UpdateThread

Nested classes/interfaces inherited from class org.bedework.timezones.common.AbstractCachedData

AbstractCachedData.AliasMaps

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Object	dbLock
protected boolean	open

Fields inherited from class org.bedework.timezones.common.AbstractCachedData

aliasMaps, cfg, dtstamp, expansions, msgPrefix

Constructor Summary

Constructors

Constructor	Description
AbstractDb(TzConfig cfg, String msgPrefix)

Method Summary

Modifier and Type	Method	Description
abstract void	addTzAlias(TzAlias val)
abstract void	addTzSpec(TzDbSpec val)
void	checkData()	Update from primary source if any.
protected void	checkOpen()
protected abstract void	clearDb()
protected abstract void	close()
protected void	fail()
List<String>	findIds(String val)	Find tz identifiers or alias names that (partially) match the given value
List<TzAlias>	findTzAliases(String val)
List<String>	findTzs(String val)
protected abstract AbstractDb.DbIterator<TzAlias>	getAliasIterator()
String	getSource()
protected abstract TzDbSpec	getSpec(String id)
List<Stat>	getStats()
abstract TzAlias	getTzAlias(String val)
protected abstract AbstractDb.DbIterator<TzDbSpec>	getTzSpecIterator()
protected void	initData(boolean clear)
protected boolean	isOpen()
protected boolean	loadInitialData()
protected abstract void	open()
abstract void	putTzAlias(TzAlias val)
abstract void	putTzSpec(TzDbSpec val)
abstract void	removeTzAlias(TzAlias val)
void	stop()	Stop any running threads.
void	updateData(String dtstamp, List<Differ.DiffListEntry> dles)	Update the stored data using the given update list.

Methods inherited from class org.bedework.timezones.common.AbstractCachedData

addAlias, escape, findAliases, findTimezones, fromAlias, getAliasedCachedVtz, getAliasedXTimeZone, getAliasesStr, getAllCachedVtzs, getCachedVtz, getDtstamp, getExpanded, getLogger, getNameList, getTimeZone, getTimezones, getTimezones, getXTimeZone, parseDef, processSpec, processSpec, resetTzs, setExpanded, vtzFromCal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, trace, warn

Field Details

dbLock

protected static final Object dbLock

open

protected boolean open

Constructor Details

AbstractDb

public AbstractDb(TzConfig cfg,
 String msgPrefix)
           throws TzException

Parameters:

cfg - tz configuration

msgPrefix - - for messages

Throws:

TzException - on fatal error

Method Details

initData

protected void initData(boolean clear)
                 throws TzException

Parameters:

clear - remove all data from db first

Throws:

TzException - on fatal error

addTzSpec

public abstract void addTzSpec(TzDbSpec val)
                        throws TzException

Parameters:

val - the spec

Throws:

TzException - on fatal error

putTzSpec

public abstract void putTzSpec(TzDbSpec val)
                        throws TzException

Parameters:

val - the spec

Throws:

TzException - on fatal error

getSpec

protected abstract TzDbSpec getSpec(String id)
                             throws TzException

Throws:

TzException

addTzAlias

public abstract void addTzAlias(TzAlias val)
                         throws TzException

Parameters:

val - the alias

Throws:

TzException - on fatal error

putTzAlias

public abstract void putTzAlias(TzAlias val)
                         throws TzException

Parameters:

val - the alias

Throws:

TzException - on fatal error

removeTzAlias

public abstract void removeTzAlias(TzAlias val)
                            throws TzException

Parameters:

val - the alias

Throws:

TzException - on fatal error

getTzAlias

public abstract TzAlias getTzAlias(String val)
                            throws TzException

Parameters:

val - the alias

Returns:

alias entry

Throws:

TzException - on fatal error

getAliasIterator

protected abstract AbstractDb.DbIterator<TzAlias> getAliasIterator()

getTzSpecIterator

protected abstract AbstractDb.DbIterator<TzDbSpec> getTzSpecIterator()

open

protected abstract void open()
                      throws TzException

Throws:

TzException

close

protected abstract void close()

clearDb

protected abstract void clearDb()
                         throws TzException

Throws:

TzException

checkData

public void checkData()

Description copied from interface: CachedData

Update from primary source if any.

updateData

public void updateData(String dtstamp,
 List<Differ.DiffListEntry> dles)
                throws TzException

Description copied from interface: CachedData

Update the stored data using the given update list. Note that the update may be transient if the data cache has no or an unchangable backing.

Parameters:

dtstamp - lastmod for change

dles - diff list

Throws:

TzException - on fatal error

stop

public void stop()
          throws TzException

Description copied from interface: CachedData

Stop any running threads.

Throws:

TzException - on fatal error

getSource

public String getSource()
                 throws TzException

Returns:

String source information for data.

Throws:

TzException - on fatal error

getStats

public List<Stat> getStats()
                    throws TzException

Specified by:

getStats in interface CachedData

Overrides:

getStats in class AbstractCachedData

Returns:

stats for the module

Throws:

TzException - on fatal error

findIds

public List<String> findIds(String val)
                     throws TzException

Description copied from class: AbstractCachedData

Find tz identifiers or alias names that (partially) match the given value

Specified by:

findIds in class AbstractCachedData

Parameters:

val - pattern to match

Returns:

list of strings - never null

Throws:

TzException - on fatal error

findTzs

public List<String> findTzs(String val)
                     throws TzException

Parameters:

val - to match

Returns:

matching tz entry names

Throws:

TzException - on fatal error

findTzAliases

public List<TzAlias> findTzAliases(String val)
                            throws TzException

Parameters:

val - the alias

Returns:

matching alias entries

Throws:

TzException - on fatal error

fail

protected void fail()

isOpen

protected boolean isOpen()

checkOpen

protected void checkOpen()
                  throws TzException

Throws:

TzException

loadInitialData

protected boolean loadInitialData()
                           throws TzException

Throws:

TzException