DatabaseCurrent

java.lang.Object
- util.PropertyContainer
- - stella.sensor.AbstractDataCollector
  - - stella.sensor.DatabaseCurrent

All Implemented Interfaces:

Cloneable, DataCollecting, ExitCleaning, Initializable, PropertySupplying
```
public class DatabaseCurrent
extends AbstractDataCollector
implements Initializable, ExitCleaning
```
A simple class that writes the data it obtained from the SensorRepository to a postgresql database. The mapping of sensor names to data events provided by the repository is used in the following way. Mappings pointed to with the KEY_PRINCIPAL property are key-traversed. Each key found is used in the data map to grab a DataEvent which is then assigned to the database field given by the value mapped to. For this map, the physical value is used. The structure of the KEY_MINIMA and KEY_MAXIMA tables is similar, but here either the minimal or the maximal physical value encountered is used. All mappings obtained are combined in a mapping of fields to float values, unless specified differently in the KEY_FORMAT mapping, where data base fields might be mapped to java class names. Whenever a sql-field is found in this mapping, the mapped value is taken as a java class name. A new instance of this class is then constructed using a single-string constructor. If no mapping is found, the default class KEY_DATACLASS is used. The DataEvent.getTimeOfMeasure() is entered with the KEY_DATEFIELD. The current weather condition is inserted as a string using the KEY_WEATHERFIELD sql field. The mapping finally obtained is inserted into the database with the GenericSql#insert method. On 2014, 21th Oct, 13:10 UTC, the digital measurements had been replaced by analog ones, 0.0175 corresponding roughly to digital 1.

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`DATABASESHUTDOWN` The default priority of the sql&weather shutdown.
`private Class<?>`	`datadef` The default class to use if no mapping is specified.
`private static String`	`DEFBADFLAG` The default setting of the bad-weather indicator.
`private static Class<Float>`	`DEFDATACLASS` The default data class for sensor data.
`private static String`	`DEFDATEFIELD` The default binding name of the weather trigger.
`private static String`	`DEFGOODFLAG` The default setting of the non-valid-reading indicator.
`private static long`	`DEFINTERVAL` The default notification period in ms.
`private static String`	`DEFMAXIMA` The default mapping of STELLA sensor maxima to sql fields.
`private static String`	`DEFPRINCIPAL` The default mapping of STELLA sensor names to sql fields.
`private static boolean`	`DEFSTRICT` The default adding to file behaviour on incomplete sets.
`private Map<String,Constructor<?>>`	`format` The mapping of sql field names to java constructors.
`static String`	`KEY_BADFLAG` The key to the bad-weather string.
`static String`	`KEY_DATACLASS` The default data class to use if no mapping is found in KEY_FORMAT.
`static String`	`KEY_DATEFIELD` The key to the sql date-field name.
`static String`	`KEY_DEVIATION` The mapping of STELLA sensor names to sql data fields.
`static String`	`KEY_FORMAT` The mapping of sql-field names to the java data types.
`static String`	`KEY_GOODFLAG` The key to the good-weather string.
`static String`	`KEY_MAXIMA` The mapping of STELLA sensor maximas to sql data fields.
`static String`	`KEY_MINIMA` The mapping of STELLA sensor minimas to sql data fields.
`static String`	`KEY_PRINCIPAL` The mapping of STELLA sensor names to sql data fields.
`static String`	`KEY_STRICT` If true, only data sets containing all sensors are writtn.
`static String`	`KEY_WEATHERFIELD` The key to the sql weather-field name.
`private Map<String,String>`	`maxima` The mapping of STELLA sensors maximas to sql field names.
`private Map<String,String>`	`minima` The mapping of STELLA sensors minimas to sql field names.
`private Map<String,String>`	`principal` The mapping of STELLA sensors values to sql field names.
`private Map<String,String>`	`sigma` The mapping of STELLA sensors standard deviations to sql fields.
`private EnvironmentSql`	`sql` The database access object.
`private Map<String,DataEvent>`	`validread` A mapping of sensor names to last valid readings.

Fields inherited from class stella.sensor.AbstractDataCollector
KEY_CLASS, KEY_INTERVAL, KEY_RMIDATACOLLECT

Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying
CONFIG

Constructor Summary

Constructors
Constructor and Description

DatabaseCurrent(Map<String,String> prop)
Constructs a new database collector.

Constructors
Constructor and Description
`DatabaseCurrent(Map<String,String> prop)` Constructs a new database collector.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`exit()` Performs an orderly exit by invoking the exit methods of the database and the weather trigger.
`private DataEvent`	`getDataEvent(String sensor, Map<String,DataEvent> data)` Checks the data event found in the sensor-name-to-data map supplied for validity.
`long`	`getInterval()` Returns the notification interval.
`private Object`	`getSqlEntry(Object sqlfield, String init)` Returns a new instance of a data sensor measurement, as an instance of `KEY_DATACLASS` or, if found in `KEY_FORMAT`, as an instance of the appropriate type.
`void`	`init()` Initializes the database current object as well as the database access object.
`private boolean`	`initSql()` Initializes the sql-connection.
`void`	`processData(Map<String,DataEvent> sensor, boolean weather)` The file collector writes out all the data it received in a single file.

Methods inherited from class stella.sensor.AbstractDataCollector
createDataCollector

Methods inherited from class util.PropertyContainer
augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - KEY_PRINCIPAL
```
public static final String KEY_PRINCIPAL
```
    The mapping of STELLA sensor names to sql data fields.
    
    See Also:
    
    Constant Field Values
  - KEY_DEVIATION
```
public static final String KEY_DEVIATION
```
    The mapping of STELLA sensor names to sql data fields.
    
    See Also:
    
    Constant Field Values
  - KEY_MINIMA
```
public static final String KEY_MINIMA
```
    The mapping of STELLA sensor minimas to sql data fields.
    
    See Also:
    
    Constant Field Values
  - KEY_MAXIMA
```
public static final String KEY_MAXIMA
```
    The mapping of STELLA sensor maximas to sql data fields.
    
    See Also:
    
    Constant Field Values
  - KEY_FORMAT
```
public static final String KEY_FORMAT
```
    The mapping of sql-field names to the java data types.
    
    See Also:
    
    Constant Field Values
  - KEY_DATACLASS
```
public static final String KEY_DATACLASS
```
    The default data class to use if no mapping is found in KEY_FORMAT.
    
    See Also:
    
    Constant Field Values
  - KEY_DATEFIELD
```
public static final String KEY_DATEFIELD
```
    The key to the sql date-field name.
    
    See Also:
    
    Constant Field Values
  - KEY_WEATHERFIELD
```
public static final String KEY_WEATHERFIELD
```
    The key to the sql weather-field name.
    
    See Also:
    
    Constant Field Values
  - KEY_BADFLAG
```
public static final String KEY_BADFLAG
```
    The key to the bad-weather string.
    
    See Also:
    
    Constant Field Values
  - KEY_GOODFLAG
```
public static final String KEY_GOODFLAG
```
    The key to the good-weather string.
    
    See Also:
    
    Constant Field Values
  - KEY_STRICT
```
public static final String KEY_STRICT
```
    If true, only data sets containing all sensors are writtn.
    
    See Also:
    
    Constant Field Values
  - DEFINTERVAL
```
private static final long DEFINTERVAL
```
    The default notification period in ms.
    
    See Also:
    
    Constant Field Values
  - DEFPRINCIPAL
```
private static final String DEFPRINCIPAL
```
    The default mapping of STELLA sensor names to sql fields.
    
    See Also:
    
    Constant Field Values
  - DEFMAXIMA
```
private static final String DEFMAXIMA
```
    The default mapping of STELLA sensor maxima to sql fields.
    
    See Also:
    
    Constant Field Values
  - DEFDATACLASS
```
private static final Class<Float> DEFDATACLASS
```
    The default data class for sensor data.
  - DEFDATEFIELD
```
private static final String DEFDATEFIELD
```
    The default binding name of the weather trigger.
    
    See Also:
    
    Constant Field Values
  - DEFBADFLAG
```
private static final String DEFBADFLAG
```
    The default setting of the bad-weather indicator.
    
    See Also:
    
    Constant Field Values
  - DEFGOODFLAG
```
private static final String DEFGOODFLAG
```
    The default setting of the non-valid-reading indicator.
    
    See Also:
    
    Constant Field Values
  - DEFSTRICT
```
private static final boolean DEFSTRICT
```
    The default adding to file behaviour on incomplete sets.
    
    See Also:
    
    Constant Field Values
  - DATABASESHUTDOWN
```
private static final int DATABASESHUTDOWN
```
    The default priority of the sql&weather shutdown.
    
    See Also:
    
    Constant Field Values
  - principal
```
private Map<String,String> principal
```
    The mapping of STELLA sensors values to sql field names.
  - sigma
```
private Map<String,String> sigma
```
    The mapping of STELLA sensors standard deviations to sql fields.
  - minima
```
private Map<String,String> minima
```
    The mapping of STELLA sensors minimas to sql field names.
  - maxima
```
private Map<String,String> maxima
```
    The mapping of STELLA sensors maximas to sql field names.
  - format
```
private Map<String,Constructor<?>> format
```
    The mapping of sql field names to java constructors.
  - validread
```
private Map<String,DataEvent> validread
```
    A mapping of sensor names to last valid readings.
  - sql
```
private EnvironmentSql sql
```
    The database access object. Initialized when the collector inits.
  - datadef
```
private Class<?> datadef
```
    The default class to use if no mapping is specified.
- Constructor Detail
  - DatabaseCurrent
```
public DatabaseCurrent(Map<String,String> prop)
```
    Constructs a new database collector. The properties of this collector are also used to generate the databank access object, this means that the properties defined in the GenericSql class must also be present here if non-default values are wanted. Additionally, the weather trigger stub is constructed here with the generic properties of the collector.
- Method Detail
  - init
```
public void init()
```
    Initializes the database current object as well as the database access object.
    For the current database collector, its essential maps (principal, minima, and maxima) are assigned. Additionally, the format look-up table is constructed using the class names pointed to in the KEY_FORMAT property to java classes. Only classes found that also support a single-string constructor are used.
    
    Specified by:
    
    init in interface Initializable
  - initSql
```
private boolean initSql()
```
    Initializes the sql-connection. If the connection cannot be opened, the sql driver is set to null.
    
    Returns:
    
    True on success, i.e. if the sql is ready for action.
  - exit
```
public void exit()
```
    Performs an orderly exit by invoking the exit methods of the database and the weather trigger.
    
    Specified by:
    
    exit in interface ExitCleaning
  - getInterval
```
public long getInterval()
```
    Returns the notification interval.
    
    Specified by:
    
    getInterval in interface DataCollecting
  - processData
```
public void processData(Map<String,DataEvent> sensor,
                        boolean weather)
```
    The file collector writes out all the data it received in a single file. This file is updated whenever new data arrives.
    To give the file a unique characteristic, it is advisable that the calling method uses a sorted map to allow a constant ordering of the sensor readouts in the file.
    
    Specified by:
    
    processData in interface DataCollecting
    
    Parameters:
    
    sensor - Mapping sensor names to data events.
    
    weather - True if current weather is good.
  - getDataEvent
```
private DataEvent getDataEvent(String sensor,
                               Map<String,DataEvent> data)
```
    Checks the data event found in the sensor-name-to-data map supplied for validity. If the named data event is not valid, the last valid data event of the named sensor is returned. If no valid data event is found at all, null is returned.
  - getSqlEntry
```
private Object getSqlEntry(Object sqlfield,
                           String init)
```
    Returns a new instance of a data sensor measurement, as an instance of KEY_DATACLASS or, if found in KEY_FORMAT, as an instance of the appropriate type. The class used to instantiate a new object must have a single-string constructor. If everything fails a new string using the second string passed over as a source is returned.
    
    Parameters:
    
    sqlfield - The name of the database field.
    
    init - The value with which the class is to be instantiated.

Class DatabaseCurrent

Field Summary

Fields inherited from class stella.sensor.AbstractDataCollector

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class stella.sensor.AbstractDataCollector

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_PRINCIPAL

KEY_DEVIATION

KEY_MINIMA

KEY_MAXIMA

KEY_FORMAT

KEY_DATACLASS

KEY_DATEFIELD

KEY_WEATHERFIELD

KEY_BADFLAG

KEY_GOODFLAG

KEY_STRICT

DEFINTERVAL

DEFPRINCIPAL

DEFMAXIMA

DEFDATACLASS

DEFDATEFIELD

DEFBADFLAG

DEFGOODFLAG

DEFSTRICT

DATABASESHUTDOWN

principal

sigma

minima

maxima

format

validread

sql

datadef

Constructor Detail

DatabaseCurrent

Method Detail

init

initSql

exit

getInterval

processData

getDataEvent

getSqlEntry