HistorySql

java.lang.Object
- util.PropertyContainer
- - util.PropertyResources
  - - mysql.AbstractSql
    - - mysql.HistorySql

All Implemented Interfaces:

Cloneable, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying
```
public class HistorySql
extends AbstractSql
```
A class that allows static access to a database containing observational history of a target. It allows restoring history of a target on SCS restart as well as information retrieval for stella.jview.JStella. In the default setup, the table of this database is called 'done' and has the following structure:
```
 CREATE TABLE "done" (
 "objid" varchar(255),
 "object" varchar(255) UNIQUE,
 "start" timestamp without time zone NOT NULL,
 "duration" integer,
 "success" boolean,
 "merrit" real,
 
 Constraint "done_pkey" Primary Key ("start")
 );
 
 GRANT ALL on "done" to "postgres";
 GRANT ALL on "done" to "stella";
 GRANT SELECT on "done" to "guest";
 
```
In this setup, the columns have the following meanings:
- objid: The unique target identifier, like 'HD 12545 cont'
- object:The unique pick number of the observation, like 20061010-0123
- start:The date of the observation start, to seconds.
- duration:The duration of the observation, in ms.
- success:True, if the observation was successful.
- merrit:The merit the object had as it was picked.
The idea of this class is to allow static access from various sides to the history without the need of producing individual db clients.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HistorySql.GridFix` Fixes wrong enries entered between 2008-10-17 15:28:30 and 2008-12-18 08:55:47, when the done table was writtn to early due to GRID timeline visibilities.
`static class`	`HistorySql.PilarPointing` We add total pointing model offsets from Pilar save files to the history db.
`static class`	`HistorySql.Show`
`static class`	`HistorySql.Sum`

Nested classes/interfaces inherited from class mysql.AbstractSql
AbstractSql.Columns, AbstractSql.Extract

Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`DEFDATEFIELD` The default target name field in the database
`private static String`	`DEFDURATIONFIELD` The default target name field in the database
`private static String`	`DEFFIRSTALTFIELD` The key to the first azimuth offset in the database.
`private static String`	`DEFFIRSTAZFIELD` The key to the first azimuth offset in the database.
`private static String`	`DEFMERITFIELD` The default target name field in the database
`private static String`	`DEFSUCCESSFIELD` The default target name field in the database
`static String`	`DEFTABLE` The default table name.
`private static String`	`DEFTARGETNAMEFIELD` The default target name field in the database
`private static String`	`DEFTELESCOPEFIELD` The default target name field in the database
`private static String`	`DEFTOTALAZFIELD` The key to the first azimuth offset in the database.
`private static String`	`DEFTOTALZFIELD` The key to the first azimuth offset in the database.
`private static String`	`DEFUNIQUEFIELD` The default target name field in the database
`static String`	`KEY_DATEFIELD` The key to the target name in the database.
`static String`	`KEY_DURATIONFIELD` The key to the target name in the database.
`static String`	`KEY_FIRSTALTFIELD` The key to the first azimuth offset in the database.
`static String`	`KEY_FIRSTAZFIELD` The key to the first azimuth offset in the database.
`static String`	`KEY_MERITFIELD` The key to the target name in the database.
`static String`	`KEY_SUCCESSFIELD` The key to the target name in the database.
`static String`	`KEY_TARGETNAMEFIELD` The key to the target name in the database.
`static String`	`KEY_TELESCOPEFIELD` The key to the target name in the database.
`static String`	`KEY_TOTALAZFIELD` The key to the first azimuth offset in the database.
`static String`	`KEY_TOTALZFIELD` The key to the first azimuth offset in the database.
`static String`	`KEY_UNIQUEFIELD` The key to the target name in the database.

Fields inherited from class mysql.AbstractSql
KEY_TABLE, SQLBATCHDIR, SQLFAILDIR

Fields inherited from class util.PropertyResources
KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

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

Fields inherited from interface util.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Constructor and Description

HistorySql(Map<String,String> prop)
Constructs a new history database.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addFirstOffsets(String unique, Vector2D degoff)` After a successful acquire, the first offset encountered is writtn to the database.
`boolean`	`addHistoryPickToDatabase(String targetname, boolean success, Date start, long duration, String unique, double merit, String idtelescope)` Adds a history entry to the database.
`boolean`	`addHistoryPickToDatabase(TargetDefinition target, boolean success, Date start, long duration, String unique, double merit, String idtelescope)` Adds a history entry to the database.
`boolean`	`addTotalOffsets(String unique, Vector2D degoff)` After a successful acquire, the total offset encountered is writtn to the database.
`HistoryAware.Pick`	`getFirstFailure(String tel, String name)` Returns the first succesful pick.
`HistoryAware.Pick`	`getFirstSuccess(String tel, String name)` Returns the first succesful pick.
`private List<HistoryAware.Pick>`	`getFormerHistoryFromDatabase(String telescope, String name, int maxlen)` Scans a database for the history.
`List<HistoryAware.Pick>`	`getHistoryFromDatabase(String telescope, String name, int maxlen)` Scans a database for the history.
`Map<String,List<HistoryAware.Pick>>`	`getHistoryPicks(String idtel, Date from, Date to)` Returns a list of `HistoryAware.Pick`s of all targets that have been picked between the given dates.
`HistoryAware.Pick`	`getLastFailure(String tel, String name)` Returns the first succesful pick.
`HistoryAware.Pick`	`getLastSuccess(String tel, String name)` Returns the first succesful pick.
`HistoryAware.Pick`	`getPickFromUnique(String uniq)` Returns a single history pick from the db by specifying the unique TARGET id of the pick.
`HistoryAware.Pick`	`getPickFromUnique(String uniq, String datekey, String durkey, String merkey, String suckey, String uniqkey, String targetkey)` Returns a single history pick from the db by specifying the unique target id of the pick plus all field names.
`private HistoryAware.Pick`	`getSinglePick(String tel, String name, boolean succ, char order)`
`long`	`getSumDuration(String idtel, Date from, Date to)`
`long`	`getSumSuccess(String idtel, Date from, Date to)`
`(package private) String`	`historyWhere(String idtel, Date from, Date to)`
`boolean`	`removeHistoryPickFromDatabase(String unique)` Removes a entry from the history db if the unique specifier is given.
`private static HistoryAware.Pick`	`retrievePick(ResultSet history, String datekey, String durationkey, String meritkey, String successkey, String uniquekey, String targetkey)` Converts the current row in the result set into a history pick.
`private long`	`sumDuration(String where)` We cannot simple sum as we would count daughter-targets twice.
`boolean`	`updateHistoryPick(String unique, boolean to)` Updates the success flag of the pick with the given unique identifier.

Methods inherited from class mysql.AbstractSql
delete, distinct, distinct, exit, getAccess, getDefaultArchive, getDefaultFormat, getTable, init, insert, isEntry, release, release, replace, retrieve, retrieve, retrieve, single, single

Methods inherited from class util.PropertyResources
clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer
augment, augment, augment, augment, augment, 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, isNew, parseObject, parseObject, 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

Methods inherited from interface util.PropertySupplying
defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Field Detail
- KEY_TARGETNAMEFIELD
```
public static final String KEY_TARGETNAMEFIELD
```
  The key to the target name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_UNIQUEFIELD
```
public static final String KEY_UNIQUEFIELD
```
  The key to the target name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_DATEFIELD
```
public static final String KEY_DATEFIELD
```
  The key to the target name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_DURATIONFIELD
```
public static final String KEY_DURATIONFIELD
```
  The key to the target name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_SUCCESSFIELD
```
public static final String KEY_SUCCESSFIELD
```
  The key to the target name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_MERITFIELD
```
public static final String KEY_MERITFIELD
```
  The key to the target name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_TELESCOPEFIELD
```
public static final String KEY_TELESCOPEFIELD
```
  The key to the target name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_FIRSTAZFIELD
```
public static final String KEY_FIRSTAZFIELD
```
  The key to the first azimuth offset in the database.
  
  See Also:
  
  Constant Field Values
- KEY_FIRSTALTFIELD
```
public static final String KEY_FIRSTALTFIELD
```
  The key to the first azimuth offset in the database.
  
  See Also:
  
  Constant Field Values
- KEY_TOTALAZFIELD
```
public static final String KEY_TOTALAZFIELD
```
  The key to the first azimuth offset in the database.
  
  See Also:
  
  Constant Field Values
- KEY_TOTALZFIELD
```
public static final String KEY_TOTALZFIELD
```
  The key to the first azimuth offset in the database.
  
  See Also:
  
  Constant Field Values
- DEFTABLE
```
public static final String DEFTABLE
```
  The default table name.
  
  See Also:
  
  Constant Field Values
- DEFTARGETNAMEFIELD
```
private static final String DEFTARGETNAMEFIELD
```
  The default target name field in the database
  
  See Also:
  
  Constant Field Values
- DEFUNIQUEFIELD
```
private static final String DEFUNIQUEFIELD
```
  The default target name field in the database
  
  See Also:
  
  Constant Field Values
- DEFDATEFIELD
```
private static final String DEFDATEFIELD
```
  The default target name field in the database
  
  See Also:
  
  Constant Field Values
- DEFDURATIONFIELD
```
private static final String DEFDURATIONFIELD
```
  The default target name field in the database
  
  See Also:
  
  Constant Field Values
- DEFSUCCESSFIELD
```
private static final String DEFSUCCESSFIELD
```
  The default target name field in the database
  
  See Also:
  
  Constant Field Values
- DEFMERITFIELD
```
private static final String DEFMERITFIELD
```
  The default target name field in the database
  
  See Also:
  
  Constant Field Values
- DEFTELESCOPEFIELD
```
private static final String DEFTELESCOPEFIELD
```
  The default target name field in the database
  
  See Also:
  
  Constant Field Values
- DEFFIRSTAZFIELD
```
private static final String DEFFIRSTAZFIELD
```
  The key to the first azimuth offset in the database.
  
  See Also:
  
  Constant Field Values
- DEFFIRSTALTFIELD
```
private static final String DEFFIRSTALTFIELD
```
  The key to the first azimuth offset in the database.
  
  See Also:
  
  Constant Field Values
- DEFTOTALAZFIELD
```
private static final String DEFTOTALAZFIELD
```
  The key to the first azimuth offset in the database.
  
  See Also:
  
  Constant Field Values
- DEFTOTALZFIELD
```
private static final String DEFTOTALZFIELD
```
  The key to the first azimuth offset in the database.
  
  See Also:
  
  Constant Field Values

Constructor Detail
- HistorySql
```
public HistorySql(Map<String,String> prop)
```
  Constructs a new history database.

Method Detail

getPickFromUnique
```
public HistoryAware.Pick getPickFromUnique(String uniq)
                                    throws SQLException
```
Returns a single history pick from the db by specifying the unique TARGET id of the pick.

Parameters:

uniq - The unique target id, i.e. without exposure ID.

Throws:

SQLException

getPickFromUnique

public HistoryAware.Pick getPickFromUnique(String uniq,
                                           String datekey,
                                           String durkey,
                                           String merkey,
                                           String suckey,
                                           String uniqkey,
                                           String targetkey)
                                    throws SQLException

Returns a single history pick from the db by specifying the unique target id of the pick plus all field names.

Parameters:: uniq - The unique target id, i.e. without exposure ID.; datekey - The name of the date column.; durkey - The name of the duration column.; merkey - The name of the merit column.; suckey - The name of the successful column.; uniqkey - The name of the column holding the unique target ID.
Throws:: SQLException

removeHistoryPickFromDatabase
```
public final boolean removeHistoryPickFromDatabase(String unique)
```
Removes a entry from the history db if the unique specifier is given. This will always delete a single entry, as the unique field is truely unique. If for whatever reason more than a single entry match the delete query, it is not executed.

Returns:

True If a single pick was removed from the database.

addHistoryPickToDatabase

public final boolean addHistoryPickToDatabase(TargetDefinition target,
                                              boolean success,
                                              Date start,
                                              long duration,
                                              String unique,
                                              double merit,
                                              String idtelescope)

Adds a history entry to the database.

addHistoryPickToDatabase

public final boolean addHistoryPickToDatabase(String targetname,
                                              boolean success,
                                              Date start,
                                              long duration,
                                              String unique,
                                              double merit,
                                              String idtelescope)

Adds a history entry to the database.

updateHistoryPick
```
public final boolean updateHistoryPick(String unique,
                                       boolean to)
```
Updates the success flag of the pick with the given unique identifier. Used on rating targets.

Returns:

True, if the unique field was present.

historyWhere

String historyWhere(String idtel,
                    Date from,
                    Date to)

getSumDuration

public long getSumDuration(String idtel,
                           Date from,
                           Date to)
                    throws SQLException

Throws:: SQLException

getSumSuccess

public long getSumSuccess(String idtel,
                          Date from,
                          Date to)
                   throws SQLException

Throws:: SQLException

sumDuration
```
private long sumDuration(String where)
                  throws SQLException
```
We cannot simple sum as we would count daughter-targets twice.

Parameters:

where -

Returns:

Throws:

SQLException

getHistoryPicks

public Map<String,List<HistoryAware.Pick>> getHistoryPicks(String idtel,
                                                           Date from,
                                                           Date to)

Returns a list of HistoryAware.Picks of all targets that have been picked between the given dates.

Returns:: A mapping of target identifier to list of picks.

getFirstSuccess

public final HistoryAware.Pick getFirstSuccess(String tel,
                                               String name)

Returns the first succesful pick.

getFirstFailure

public final HistoryAware.Pick getFirstFailure(String tel,
                                               String name)

Returns the first succesful pick.

getLastSuccess

public final HistoryAware.Pick getLastSuccess(String tel,
                                              String name)

Returns the first succesful pick.

getLastFailure

public final HistoryAware.Pick getLastFailure(String tel,
                                              String name)

Returns the first succesful pick.

getSinglePick

private final HistoryAware.Pick getSinglePick(String tel,
                                              String name,
                                              boolean succ,
                                              char order)

getFormerHistoryFromDatabase

private final List<HistoryAware.Pick> getFormerHistoryFromDatabase(String telescope,
                                                                   String name,
                                                                   int maxlen)

Scans a database for the history.

getHistoryFromDatabase

public final List<HistoryAware.Pick> getHistoryFromDatabase(String telescope,
                                                            String name,
                                                            int maxlen)

Scans a database for the history.

addFirstOffsets
```
public boolean addFirstOffsets(String unique,
                               Vector2D degoff)
```
After a successful acquire, the first offset encountered is writtn to the database. As the entry must have a non-null date field, only updates are possible.
The recorded offsets should have a random distribution, with an RMS equal to the RMS of the pointing model. If tendencies are observed, this may call for a update of the pointing model.

addTotalOffsets
```
public boolean addTotalOffsets(String unique,
                               Vector2D degoff)
```
After a successful acquire, the total offset encountered is writtn to the database. This could be used to recalculate the pointing model.

retrievePick

private static HistoryAware.Pick retrievePick(ResultSet history,
                                              String datekey,
                                              String durationkey,
                                              String meritkey,
                                              String successkey,
                                              String uniquekey,
                                              String targetkey)
                                       throws SQLException

Converts the current row in the result set into a history pick. The resutl set must be pointing to a valid row.

Throws:: SQLException

Class HistorySql

Nested Class Summary

Nested classes/interfaces inherited from class mysql.AbstractSql

Nested classes/interfaces inherited from class util.PropertyResources

Field Summary

Fields inherited from class mysql.AbstractSql

Fields inherited from class util.PropertyResources

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.ResourceSupplying

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class mysql.AbstractSql

Methods inherited from class util.PropertyResources

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Methods inherited from interface util.PropertySupplying

Field Detail

KEY_TARGETNAMEFIELD

KEY_UNIQUEFIELD

KEY_DATEFIELD

KEY_DURATIONFIELD

KEY_SUCCESSFIELD

KEY_MERITFIELD

KEY_TELESCOPEFIELD

KEY_FIRSTAZFIELD

KEY_FIRSTALTFIELD

KEY_TOTALAZFIELD

KEY_TOTALZFIELD

DEFTABLE

DEFTARGETNAMEFIELD

DEFUNIQUEFIELD

DEFDATEFIELD

DEFDURATIONFIELD

DEFSUCCESSFIELD

DEFMERITFIELD

DEFTELESCOPEFIELD

DEFFIRSTAZFIELD

DEFFIRSTALTFIELD

DEFTOTALAZFIELD

DEFTOTALZFIELD

Constructor Detail

HistorySql

Method Detail

getPickFromUnique

getPickFromUnique

removeHistoryPickFromDatabase

addHistoryPickToDatabase

addHistoryPickToDatabase

updateHistoryPick

historyWhere

getSumDuration

getSumSuccess

sumDuration

getHistoryPicks

getFirstSuccess

getFirstFailure

getLastSuccess

getLastFailure

getSinglePick

getFormerHistoryFromDatabase

getHistoryFromDatabase

addFirstOffsets

addTotalOffsets

retrievePick