TargetDatabase

java.lang.Object
- util.PropertyContainer
- - util.PropertyResources
  - - mysql.AbstractSql
    - - stella.sql.TargetDatabase

All Implemented Interfaces:

Cloneable, HistoryProviding, TargetProviding<SporeTarget>, TargetQuickProviding<SporeTarget>, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying
```
public class TargetDatabase
extends AbstractSql
implements TargetQuickProviding<SporeTarget>, HistoryProviding
```
A database provider roams through a sql database to load STELLA targets. The table used is a TaskSql, a TargetSql contains information of astronomical targets, i.e. stars.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`TargetDatabase.ConsistencyThread`
`static class`	`TargetDatabase.Listing` Test class for changing from target list to target database.

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 Map<String,SporeTarget>`	`active` My parsed collection of active targets, available after init.
`private Map<String,SporeTarget>`	`all` Names to targets for all targets, available after init.
`private static boolean`	`DEFCONSISTENCY` On default, we do not check for consistency.
`private static boolean`	`DEFREMOVESCIENCE` On default, we do not remove science targets.
`private Map<String,SporeTarget>`	`finished` My parsed collection of finished targets, available after init.
`private HistorySql`	`histsql` The history table for reconstructing the obs.
`static String`	`KEY_CONSISTENCY` If true check for database consitency.
`static String`	`KEY_HISTORYDB` If present, the properties of the history database.
`static String`	`KEY_KEEPLIST` The key to the comma-list of targets kept in active though finished.
`static String`	`KEY_PROPOSALDB` If present, the properties of the proposal database.
`static String`	`KEY_REMOVEFILE` The key to the ascii-file of unwanted targets.
`static String`	`KEY_REMOVELIST` The key to the comma-list of unwanted targets.
`static String`	`KEY_REMOVESCIENCE` If true, remove all but engineering targets.
`static String`	`KEY_STELLA` The telescope we work on.
`static String`	`KEY_TARGETDB` If present, the properties of the target database.
`static String`	`KEY_TASKDB` If present, the properties of the task database.
`private ProposalSql`	`propsql` The task sql we drain the targets from.
`private TargetSql`	`starsql` The target sql we drain the ra/de of stars from.
`private TaskSql`	`tasksql` The task sql we drain the targets from.

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 stella.TargetProviding
SERIAL, XML

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

TargetDatabase(Map<String,String> sprop)
Constructs a new target database provider.

Constructors
Constructor and Description
`TargetDatabase(Map<String,String> sprop)` Constructs a new target database provider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addTarget(SporeTarget dom)` Adds a new target to this provider.
`void`	`clear()` Empties the targets hash map.
`Collection<SporeTarget>`	`getActiveTargets()` Returns all active targets.
`Collection<SporeTarget>`	`getAllTargets()` Returns all targets known to this provider.
`Collection<SporeTarget>`	`getCompletedTargets()` Parsed Targets provide a complete flag.
`SporeTarget`	`getFromActive(String name)` Returns a set of all target names.
`SporeTarget`	`getFromAll(String name)` Returns a set of all target names.
`HistorySql`	`getHistorySql()` Access to the history database.
`void`	`init()` The init section.
`Map<String,Star>`	`mapToStars()` If only a linking of target names to main stars is needed, try this method, it is much faster.
`(package private) Map<String,Star>`	`mapToStarsSlow()`
`Map<String,String>`	`mapToUsers()` If only access to target names vs.
`private boolean`	`removeFrom(Map<String,SporeTarget> map, SporeTarget dom)` Removes the specified target from the table.
`boolean`	`removeTarget(SporeTarget dom)` Removes the target-defining `DOM` from the scheduler, classified by its name.
`boolean`	`restore()` Restores all targets.
`private boolean`	`restoreTargets()` Restores all targets.

Methods inherited from class mysql.AbstractSql
delete, distinct, distinct, exit, getAccess, getDefaultArchive, getDefaultFormat, getTable, 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_KEEPLIST
```
public static final String KEY_KEEPLIST
```
    The key to the comma-list of targets kept in active though finished.
    
    See Also:
    
    Constant Field Values
  - KEY_REMOVELIST
```
public static final String KEY_REMOVELIST
```
    The key to the comma-list of unwanted targets.
    
    See Also:
    
    Constant Field Values
  - KEY_REMOVEFILE
```
public static final String KEY_REMOVEFILE
```
    The key to the ascii-file of unwanted targets.
    
    See Also:
    
    Constant Field Values
  - KEY_REMOVESCIENCE
```
public static final String KEY_REMOVESCIENCE
```
    If true, remove all but engineering targets.
    
    See Also:
    
    Constant Field Values
  - KEY_CONSISTENCY
```
public static final String KEY_CONSISTENCY
```
    If true check for database consitency. Only useful on write-hosts.
    
    See Also:
    
    Constant Field Values
  - KEY_STELLA
```
public static final String KEY_STELLA
```
    The telescope we work on.
    
    See Also:
    
    Constant Field Values
  - KEY_HISTORYDB
```
public static final String KEY_HISTORYDB
```
    If present, the properties of the history database.
    
    See Also:
    
    Constant Field Values
  - KEY_TASKDB
```
public static final String KEY_TASKDB
```
    If present, the properties of the task database.
    
    See Also:
    
    Constant Field Values
  - KEY_TARGETDB
```
public static final String KEY_TARGETDB
```
    If present, the properties of the target database.
    
    See Also:
    
    Constant Field Values
  - KEY_PROPOSALDB
```
public static final String KEY_PROPOSALDB
```
    If present, the properties of the proposal database.
    
    See Also:
    
    Constant Field Values
  - DEFCONSISTENCY
```
private static final boolean DEFCONSISTENCY
```
    On default, we do not check for consistency.
    
    See Also:
    
    Constant Field Values
  - DEFREMOVESCIENCE
```
private static final boolean DEFREMOVESCIENCE
```
    On default, we do not remove science targets.
    
    See Also:
    
    Constant Field Values
  - tasksql
```
private TaskSql tasksql
```
    The task sql we drain the targets from.
  - propsql
```
private ProposalSql propsql
```
    The task sql we drain the targets from.
  - starsql
```
private TargetSql starsql
```
    The target sql we drain the ra/de of stars from.
  - histsql
```
private HistorySql histsql
```
    The history table for reconstructing the obs. history.
  - all
```
private Map<String,SporeTarget> all
```
    Names to targets for all targets, available after init.
  - active
```
private Map<String,SporeTarget> active
```
    My parsed collection of active targets, available after init.
  - finished
```
private Map<String,SporeTarget> finished
```
    My parsed collection of finished targets, available after init.
- Constructor Detail
  - TargetDatabase
```
public TargetDatabase(Map<String,String> sprop)
```
    Constructs a new target database provider. The resources are defaulted. Target loading and parsing is deferred to the init() section.
- Method Detail
  - init
```
public void init()
          throws InitException
```
    The init section. If the #KEY_TARGETFILE is set, the target list is searched, read and passed to the #resolveFileTargets method.
    
    Specified by:
    
    init in interface Initializable
    
    Overrides:
    
    init in class AbstractSql
    
    Throws:
    
    InitException
  - restore
```
public boolean restore()
```
    Restores all targets. First, the db is queried for all entries. These are stored in the all Collection. The active targets start with a copy of all. After that, the non-enabled targets as well as the finished targets (i.e. those with a non-null finished date) are removed, the latter stored in finished. If the #KEY_REMOVEDAUGHTERS key points to true, all resolved daughters are removed from the active list. Finally, if either of the KEY_REMOVELIST or KEY_REMOVEFILE properties is given, the targets with these names are removed from the active targets. Finally, if the KEY_CONSISTENCY trigger is set, all restored targets are checked for their consistency.
    
    Specified by:
    
    restore in interface TargetProviding<SporeTarget>
  - getHistorySql
```
public HistorySql getHistorySql()
```
    Access to the history database.
    
    Specified by:
    
    getHistorySql in interface HistoryProviding
  - restoreTargets
```
private boolean restoreTargets()
```
    Restores all targets. First, the db is queried for all entries. These are stored in the all Collection. The active targets start with a copy of all. After that, the non-enabled targets as well as the finished targets (i.e. those with a non-null finished date) are removed, the latter stored in finished. If the #KEY_REMOVEDAUGHTERS key points to true, all resolved daughters are removed from the active list. Finally, if either of the KEY_REMOVELIST or KEY_REMOVEFILE properties is given, the targets with these names are removed from the active targets.
  - getCompletedTargets
```
public Collection<SporeTarget> getCompletedTargets()
```
    Parsed Targets provide a complete flag.
    
    Specified by:
    
    getCompletedTargets in interface TargetProviding<SporeTarget>
    
    See Also:
    
    HistoryAware, Appointable
  - getAllTargets
```
public Collection<SporeTarget> getAllTargets()
```
    Description copied from interface: TargetProviding
    
    Returns all targets known to this provider.
    
    Specified by:
    
    getAllTargets in interface TargetProviding<SporeTarget>
  - getActiveTargets
```
public Collection<SporeTarget> getActiveTargets()
```
    Description copied from interface: TargetProviding
    
    Returns all active targets. These are the targets that take part in a scheduling process. br> This collection must be contained in the TargetProviding.getAllTargets().
    
    Specified by:
    
    getActiveTargets in interface TargetProviding<SporeTarget>
  - addTarget
```
public boolean addTarget(SporeTarget dom)
```
    Adds a new target to this provider. If the target allows database access, its history is read in. Children are resolved, if needed. The target is copied also to the finished list, if finished and to the active list, if not finished and enabled. The ignore-for-resolved is ignored, as well as a remove list.
    The target is added to the database, if the consistency flag is set
    
    Specified by:
    
    addTarget in interface TargetProviding<SporeTarget>
    
    Returns:
    
    True, if adding was successful.
  - removeTarget
```
public boolean removeTarget(SporeTarget dom)
```
    Removes the target-defining DOM from the scheduler, classified by its name. The target is physically removed and must be re-parsed from the target-definition file if re-added.
    
    Specified by:
    
    removeTarget in interface TargetProviding<SporeTarget>
    
    Returns:
    
    True, if target was present in at least one list.
  - clear
```
public void clear()
```
    Empties the targets hash map. All parsed information is lost. Additionally, adding targets after a call to this method may require re-hashing.
    
    Specified by:
    
    clear in interface TargetProviding<SporeTarget>
  - getFromAll
```
public SporeTarget getFromAll(String name)
```
    Returns a set of all target names. If no targets are stored within this scheduler null is returned, instead of an empty set. Note that the returned set is backed by the targets' hash map.
    
    Specified by:
    
    getFromAll in interface TargetProviding<SporeTarget>
  - getFromActive
```
public SporeTarget getFromActive(String name)
```
    Returns a set of all target names. If no targets are stored within this scheduler null is returned, instead of an empty set. Note that the returned set is backed by the targets' hash map.
    
    Specified by:
    
    getFromActive in interface TargetProviding<SporeTarget>
  - mapToUsers
```
public Map<String,String> mapToUsers()
```
    If only access to target names vs. user names is required, we do a single lookup, not retrieving all data from the db.
    
    Specified by:
    
    mapToUsers in interface TargetQuickProviding<SporeTarget>
  - mapToStars
```
public Map<String,Star> mapToStars()
```
    If only a linking of target names to main stars is needed, try this method, it is much faster.
    
    Specified by:
    
    mapToStars in interface TargetQuickProviding<SporeTarget>
  - mapToStarsSlow
```
Map<String,Star> mapToStarsSlow()
```
  - removeFrom
```
private boolean removeFrom(Map<String,SporeTarget> map,
                           SporeTarget dom)
```
    Removes the specified target from the table. Returns true, if it was present. No synch on map.

Class TargetDatabase

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 stella.TargetProviding

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_KEEPLIST

KEY_REMOVELIST

KEY_REMOVEFILE

KEY_REMOVESCIENCE

KEY_CONSISTENCY

KEY_STELLA

KEY_HISTORYDB

KEY_TASKDB

KEY_TARGETDB

KEY_PROPOSALDB

DEFCONSISTENCY

DEFREMOVESCIENCE

tasksql

propsql

starsql

histsql

all

active

finished

Constructor Detail

TargetDatabase

Method Detail

init

restore

getHistorySql

restoreTargets

getCompletedTargets

getAllTargets

getActiveTargets

addTarget

removeTarget

clear

getFromAll

getFromActive

mapToUsers

mapToStars

mapToStarsSlow

removeFrom