ProposalSql

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

All Implemented Interfaces:

Cloneable, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying
```
public class ProposalSql
extends AbstractSql
```
A class that allows access to a database containing the propsals to stella observations as handed over by the user. It links observing programs to users.
```
  CREATE TABLE "proposal" ( propid | character varying(255) | not null pi
 | character varying(255) | title | character varying(255) | abstract | text |
 expire | interval |
 
```
In this setup, the columns have the following meanings:
- propid: This string links to the TaskSql table.
- pi: This is the user name of the principal investigator of the observing program. The name is identical to the UserSql user-id.
- title:A short title for the observing program. This is a user-supplied title that is not present in the target-xml.
- abstract:A short description of the scientific use of the target. This is present in the target-xml as the Abstract element.
- expire: A interval after which the data is made publically available. Zero means never. This is an SQL-interval, so it is a quoted value. On automated filling, this value is set to #KEY_INITIALEXPIRE.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProposalSql.AddProposal
Adds a new user with the command line.

static class ProposalSql.GetTime
- Nested classes/interfaces inherited from class mysql.AbstractSql
  AbstractSql.Columns, AbstractSql.Extract
- Nested classes/interfaces inherited from class util.PropertyResources
  PropertyResources.Load, PropertyResources.URLResource

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProposalSql.AddProposal` Adds a new user with the command line.
`static class`	`ProposalSql.GetTime`

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`DEFABSTRACTFIELD` The key to the object name in the database.
`private static String`	`DEFDONEDURATION`
`private static String`	`DEFDONEOBJECT`
`private static String`	`DEFDONESUCCESS`
`private static String`	`DEFDONETABLE`
`private static String`	`DEFEXPIREFIELD` The key to the object name in the database.
`private static String`	`DEFPIFIELD` The key to the object name in the database.
`private static String`	`DEFPROPIDFIELD` The key to the object name in the database.
`private static int`	`DEFPROPRIETY` The key to the default propriety period if none given.
`static String`	`DEFTABLE` The default table name.
`private static String`	`DEFTASKOBJECT`
`private static String`	`DEFTASKPROPID`
`private static String`	`DEFTASKTABLE`
`private static String`	`DEFTIMEUNIT` The key to the propriety period time unit .
`private static String`	`DEFTITLEFIELD` The key to the object name in the database.
`static String`	`KEY_ABSTRACTFIELD` The key to the object name in the database.
`static String`	`KEY_DONEDURATION`
`static String`	`KEY_DONEOBJECT`
`static String`	`KEY_DONESUCCESS`
`static String`	`KEY_DONETABLE`
`static String`	`KEY_EXPIREFIELD` The key to the object name in the database.
`static String`	`KEY_PIFIELD` The key to the object name in the database.
`static String`	`KEY_PROPIDFIELD` The key to the object name in the database.
`static String`	`KEY_PROPRIETY` The key to the default propriety period if none given.
`static String`	`KEY_TASKOBJECT`
`static String`	`KEY_TASKPROPID`
`static String`	`KEY_TASKTABLE`
`static String`	`KEY_TIMEUNIT` The key to the propriety period time unit .
`static String`	`KEY_TITLEFIELD` The key to the object 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

ProposalSql(Map<String,String> prop)
Constructs a new proposal sql.

Constructors
Constructor and Description
`ProposalSql(Map<String,String> prop)` Constructs a new proposal sql.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addProposal(String id, String user, String title, String abstr)` Adds a new proposal with a unique ID to the db.
`boolean`	`addProposal(String id, String user, String title, String abstr, int period)` Adds a new proposal with a unique ID to the db.
`List<String>`	`getAllProposalIds()` Gets all proposal ids.
`Map<String,Object>`	`getProposal(String propid)` Returns the mapping of field names to db entries for the given proposal or null if no such entry exists.
`long`	`getTimeForProposal(String propid, boolean onlysuccess)` Gets the ms spent on this proposal, if onlysuccess id true, then only successful proposals are counted.

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_PROPIDFIELD
```
public static final String KEY_PROPIDFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - KEY_PIFIELD
```
public static final String KEY_PIFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - KEY_TITLEFIELD
```
public static final String KEY_TITLEFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - KEY_ABSTRACTFIELD
```
public static final String KEY_ABSTRACTFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - KEY_EXPIREFIELD
```
public static final String KEY_EXPIREFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - KEY_PROPRIETY
```
public static final String KEY_PROPRIETY
```
    The key to the default propriety period if none given.
    
    See Also:
    
    Constant Field Values
  - KEY_TIMEUNIT
```
public static final String KEY_TIMEUNIT
```
    The key to the propriety period time unit .
    
    See Also:
    
    Constant Field Values
  - KEY_TASKOBJECT
```
public static final String KEY_TASKOBJECT
```
    See Also:
    
    Constant Field Values
  - KEY_DONEOBJECT
```
public static final String KEY_DONEOBJECT
```
    See Also:
    
    Constant Field Values
  - KEY_TASKPROPID
```
public static final String KEY_TASKPROPID
```
    See Also:
    
    Constant Field Values
  - KEY_DONESUCCESS
```
public static final String KEY_DONESUCCESS
```
    See Also:
    
    Constant Field Values
  - KEY_DONEDURATION
```
public static final String KEY_DONEDURATION
```
    See Also:
    
    Constant Field Values
  - KEY_DONETABLE
```
public static final String KEY_DONETABLE
```
    See Also:
    
    Constant Field Values
  - KEY_TASKTABLE
```
public static final String KEY_TASKTABLE
```
    See Also:
    
    Constant Field Values
  - DEFTABLE
```
public static final String DEFTABLE
```
    The default table name.
    
    See Also:
    
    Constant Field Values
  - DEFPROPIDFIELD
```
private static final String DEFPROPIDFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - DEFPIFIELD
```
private static final String DEFPIFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - DEFTITLEFIELD
```
private static final String DEFTITLEFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - DEFABSTRACTFIELD
```
private static final String DEFABSTRACTFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - DEFEXPIREFIELD
```
private static final String DEFEXPIREFIELD
```
    The key to the object name in the database.
    
    See Also:
    
    Constant Field Values
  - DEFPROPRIETY
```
private static final int DEFPROPRIETY
```
    The key to the default propriety period if none given.
    
    See Also:
    
    Constant Field Values
  - DEFTIMEUNIT
```
private static final String DEFTIMEUNIT
```
    The key to the propriety period time unit .
    
    See Also:
    
    Constant Field Values
  - DEFTASKOBJECT
```
private static final String DEFTASKOBJECT
```
    See Also:
    
    Constant Field Values
  - DEFDONEOBJECT
```
private static final String DEFDONEOBJECT
```
    See Also:
    
    Constant Field Values
  - DEFTASKPROPID
```
private static final String DEFTASKPROPID
```
    See Also:
    
    Constant Field Values
  - DEFDONESUCCESS
```
private static final String DEFDONESUCCESS
```
    See Also:
    
    Constant Field Values
  - DEFDONEDURATION
```
private static final String DEFDONEDURATION
```
    See Also:
    
    Constant Field Values
  - DEFDONETABLE
```
private static final String DEFDONETABLE
```
    See Also:
    
    Constant Field Values
  - DEFTASKTABLE
```
private static final String DEFTASKTABLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProposalSql
```
public ProposalSql(Map<String,String> prop)
```
    Constructs a new proposal sql.
- Method Detail
  - getProposal
```
public Map<String,Object> getProposal(String propid)
```
    Returns the mapping of field names to db entries for the given proposal or null if no such entry exists.
  - addProposal
```
public boolean addProposal(String id,
                           String user,
                           String title,
                           String abstr)
```
    Adds a new proposal with a unique ID to the db.
  - addProposal
```
public boolean addProposal(String id,
                           String user,
                           String title,
                           String abstr,
                           int period)
```
    Adds a new proposal with a unique ID to the db. Propriety period is in #KEY_TIMEUNITS, normally years.
  - getAllProposalIds
```
public List<String> getAllProposalIds()
```
    Gets all proposal ids.
  - getTimeForProposal
```
public long getTimeForProposal(String propid,
                               boolean onlysuccess)
```
    Gets the ms spent on this proposal, if onlysuccess id true, then only successful proposals are counted. We execute a join on the done and task table:
```
  select sum(duration) from done,task where success='t' and
 task.object=done.objid
 and propid='propid'
 
```

Class ProposalSql

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_PROPIDFIELD

KEY_PIFIELD

KEY_TITLEFIELD

KEY_ABSTRACTFIELD

KEY_EXPIREFIELD

KEY_PROPRIETY

KEY_TIMEUNIT

KEY_TASKOBJECT

KEY_DONEOBJECT

KEY_TASKPROPID

KEY_DONESUCCESS

KEY_DONEDURATION

KEY_DONETABLE

KEY_TASKTABLE

DEFTABLE

DEFPROPIDFIELD

DEFPIFIELD

DEFTITLEFIELD

DEFABSTRACTFIELD

DEFEXPIREFIELD

DEFPROPRIETY

DEFTIMEUNIT

DEFTASKOBJECT

DEFDONEOBJECT

DEFTASKPROPID

DEFDONESUCCESS

DEFDONEDURATION

DEFDONETABLE

DEFTASKTABLE

Constructor Detail

ProposalSql

Method Detail

getProposal

addProposal

addProposal

getAllProposalIds

getTimeForProposal