FileCurrent

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

All Implemented Interfaces:

Cloneable, DataCollecting, PropertySupplying
```
public class FileCurrent
extends AbstractDataCollector
```
A simple class that writes out the data it obtained from the SensorRepository to a file. If the KEY_MAPLIST property is given, only sensors present in this list are writtn. The file (KEY_CURRENT) is writtn whenever data is available. Depending on the KEY_APPEND property, the file is either newly writtn at each call or appended to. A typical file may look as
```
 #      Date           nsolz       solz
 30.09.02 18:10:07*  +35.08866* +35.27701*
 
```
The values given are the physical averages, if available. Otherwise the raw values are given.
If the data events received are weather-data events, their rule is added to the value. Bad weather data receives an extra KEY_BADFLAG string added to the value, while for good weather data this string is replaced with an empty string of equal length.

Field Summary

Fields
Modifier and Type	Field and Description
`private DateFormat`	`date` The date formatter to use for output.
`private static boolean`	`DEFAPPEND` The default appending behaviour.
`private static String`	`DEFBADFLAG` The default setting of the bad-weather indicator.
`private static String`	`DEFCURRENT` The default name of the output file.
`private static DateFormat`	`DEFDATE` The date/time formatter.
`private static long`	`DEFINTERVAL` The default notification period in ms.
`private static boolean`	`DEFSTRICT` The default adding to file behaviour on incomplete sets.
`private static String`	`DEFUNIT` The default unit string.
`private static String`	`DEFVALIDFLAG` The default setting of the non-valid-reading indicator.
`private static String`	`DEFWEATHER` The default binding name of the weather trigger.
`static String`	`KEY_APPEND` The key defining if appending should be enabled.
`static String`	`KEY_BADFLAG` The key to the bad-weather indicator.
`static String`	`KEY_CURRENT` The key to the file where the current data should be writtn to.
`static String`	`KEY_DATE` The key to the date-format string.
`static String`	`KEY_MAPLIST` The key to a list of sensor that should be mapped.
`static String`	`KEY_STRICT` If true, only data sets containing all sensors are writtn.
`static String`	`KEY_UNIT` The key to the default unit string.
`static String`	`KEY_VALIDFLAG` The key to the non-valid reading indicator.
`static String`	`KEY_WEATHER` The key to the bindname of the weather parameter.
`private List<String>`	`map` The list of all sensor names that should be mapped in the output file.
`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

FileCurrent(Map<String,String> prop)
Constructs a new file collector.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getInterval()` Returns the notification interval.
`private static boolean`	`isValidReading(DataEvent de)` Defines if the handed-over data event consists of valid readings.
`void`	`processData(Map<String,DataEvent> sensor, boolean weather)` The file collector writes out all the data it received in a single file.
`String`	`toString()` A short description of the current data collector.
`private void`	`writeData(Writer out, Map<String,DataEvent> data, boolean weather)` Writes the sensor data to the given stream.
`private void`	`writeHeader(Writer out, Map<String,DataEvent> data)` Writes a header to the specified stream.

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

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

- Field Detail
  - KEY_CURRENT
```
public static final String KEY_CURRENT
```
    The key to the file where the current data should be writtn to.
    
    See Also:
    
    Constant Field Values
  - KEY_APPEND
```
public static final String KEY_APPEND
```
    The key defining if appending should be enabled.
    
    See Also:
    
    Constant Field Values
  - KEY_WEATHER
```
public static final String KEY_WEATHER
```
    The key to the bindname of the weather parameter.
    
    See Also:
    
    Constant Field Values
  - KEY_BADFLAG
```
public static final String KEY_BADFLAG
```
    The key to the bad-weather indicator.
    
    See Also:
    
    Constant Field Values
  - KEY_VALIDFLAG
```
public static final String KEY_VALIDFLAG
```
    The key to the non-valid reading indicator.
    
    See Also:
    
    Constant Field Values
  - KEY_MAPLIST
```
public static final String KEY_MAPLIST
```
    The key to a list of sensor that should be mapped. If undefined, all sensors are writtn to the output file.
    
    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
  - KEY_UNIT
```
public static final String KEY_UNIT
```
    The key to the default unit string.
    
    See Also:
    
    Constant Field Values
  - KEY_DATE
```
public static final String KEY_DATE
```
    The key to the date-format string.
    
    See Also:
    
    Constant Field Values
  - DEFINTERVAL
```
private static final long DEFINTERVAL
```
    The default notification period in ms.
    
    See Also:
    
    Constant Field Values
  - DEFCURRENT
```
private static final String DEFCURRENT
```
    The default name of the output file.
    
    See Also:
    
    Constant Field Values
  - DEFAPPEND
```
private static final boolean DEFAPPEND
```
    The default appending behaviour.
    
    See Also:
    
    Constant Field Values
  - DEFWEATHER
```
private static final String DEFWEATHER
```
    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
  - DEFVALIDFLAG
```
private static final String DEFVALIDFLAG
```
    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
  - DEFUNIT
```
private static final String DEFUNIT
```
    The default unit string.
    
    See Also:
    
    Constant Field Values
  - DEFDATE
```
private static final DateFormat DEFDATE
```
    The date/time formatter.
  - map
```
private List<String> map
```
    The list of all sensor names that should be mapped in the output file.
  - validread
```
private final Map<String,DataEvent> validread
```
    A mapping of sensor names to last valid readings.
  - date
```
private final DateFormat date
```
    The date formatter to use for output.
- Constructor Detail
  - FileCurrent
```
public FileCurrent(Map<String,String> prop)
```
    Constructs a new file collector. The KEY_CURRENT, the KEY_APPEND, the KEY_STRICT, the KEY_WEATHER and the two flags, KEY_BADFLAG and KEY_VALIDFLAG obtain their default values if not present. If the KEY_MAPLIST property is set, the look-up list for the sensors to output is initialized.
- Method Detail
  - getInterval
```
public long getInterval()
```
    Returns the notification interval.
  - 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.
    
    Parameters:
    
    sensor - Mapping sensor names to data events.
    
    weather - True if current weather is good.
  - writeHeader
```
private void writeHeader(Writer out,
                         Map<String,DataEvent> data)
                  throws IOException
```
    Writes a header to the specified stream. If the map look-up list is defined, only matching sensor names are considered.
    
    Throws:
    
    IOException
  - writeData
```
private void writeData(Writer out,
                       Map<String,DataEvent> data,
                       boolean weather)
                throws IOException
```
    Writes the sensor data to the given stream. If the look-up list map exists, only sensors given in this list are writtn out.
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    A short description of the current data collector.
    
    Overrides:
    
    toString in class PropertyContainer
  - isValidReading
```
private static boolean isValidReading(DataEvent de)
```
    Defines if the handed-over data event consists of valid readings. This is fulfilled if
    - The data event is not null.
    - The data event carries a raw-reading that is not Double.NaN.

Class FileCurrent

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_CURRENT

KEY_APPEND

KEY_WEATHER

KEY_BADFLAG

KEY_VALIDFLAG

KEY_MAPLIST

KEY_STRICT

KEY_UNIT

KEY_DATE

DEFINTERVAL

DEFCURRENT

DEFAPPEND

DEFWEATHER

DEFBADFLAG

DEFVALIDFLAG

DEFSTRICT

DEFUNIT

DEFDATE

map

validread

date

Constructor Detail

FileCurrent

Method Detail

getInterval

processData

writeHeader

writeData

toString

isValidReading