PpmXlDatabase

java.lang.Object
- util.PropertyContainer
- - util.PropertyResources
  - - mysql.AbstractSql
    - - mysql.HtmStarDatabase
      - mysql.PpmXlDatabase

All Implemented Interfaces:

Cloneable, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

PpmXlDatabaseFeeder
```
public class PpmXlDatabase
extends HtmStarDatabase
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PpmXlDatabase.Query
- 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`	`PpmXlDatabase.Query`

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`DEFCOLOR` Default column name.
`private static String`	`DEFDE` Default column name.
`private static String`	`DEFDEERR` Default column name.
`private static float`	`DEFFAINTMAG`
`private static String`	`DEFFAINTTABLE` Default table.
`private static String`	`DEFHTM` Default column name.
`private static int`	`DEFHTMDEPTH` Default column name.
`private static String`	`DEFMAG` Default column name.
`private static String`	`DEFMAGERR` Default column name.
`private static String`	`DEFNAME` Default column name.
`private static String`	`DEFPMDE` Default column name.
`private static String`	`DEFPMRA` Default column name.
`private static String`	`DEFRA` Default column name.
`private static String`	`DEFRAERR` Default column name.
`private static String`	`DEFRI` Default column name.
`private static String`	`DEFTABLE` Default table.
`static double`	`DEGMARCSEC` Converts degrees to milliarcseconds.
`static String`	`KEY_DEERR` The key linked to the error of the declination, mas.
`static String`	`KEY_FAINTMAG` Stars fainter than this go to the extended table.
`static String`	`KEY_FAINTTABLE` The table name of the faint-magnitude stars.
`static String`	`KEY_MAGERR` The key linked to the error of the magnitude.
`static String`	`KEY_RAERR` The key linked to the error of the right ascension, mas.
`static String`	`KEY_RI` The key linked to the R-I color expression.
`static String`	`PPMXLDATABASE` The properties for connecting to the ppmxl db on stella.
`static String`	`PPMXLFURMINT` The properties for connecting to the UCAC2 database on furmint.
`private String`	`table` Currently queried table.

Fields inherited from class mysql.HtmStarDatabase
KEY_COLOR, KEY_DE, KEY_EPOCH, KEY_EQUINOX, KEY_HTM, KEY_HTMDEPTH, KEY_MAG, KEY_NAME, KEY_PMDE, KEY_PMRA, KEY_RA

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

PpmXlDatabase(Map<String,String> prop)
Constructs a new generic star database.

Constructors
Constructor and Description
`PpmXlDatabase(Map<String,String> prop)` Constructs a new generic star database.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Star>`	`around(SimpleStar to, double radius, boolean faint)` Matches the given star to the PPMXL database using the provided search radius, which should be five times the combined catalog position uncertainties.
`List<Star>`	`getCircularField(double ra, double dec, double radius, boolean strict)` Takes a central star and a circular radius around it to convert it to a database query result set, which is then passed to the `HtmStarDatabase.parseResultSet(java.sql.ResultSet)` method.
`static Map<String,String>`	`getDefaulProperites()` Returns the default properties for the ppmxl db on stella.aip.de
`List<Star>`	`getFaintCircularField(double ra, double dec, double radius, boolean strict)`
`float`	`getFaintMag()` Returns the magnitude above which the catalog is considered faint magnitudes.
`List<Star>`	`getFullCircularField(double ra, double dec, double radius, boolean strict)`
`String`	`getTable()` For querying faint stars we return the faint table name here.
`Star`	`match(SimpleStar to, double radius, boolean faint)` Matches the given star to the PPMXL database using the provided search radius, which should be five times the combined catalog position uncertainties.
`protected SimpleStar`	`parseResultSet(ResultSet rs)` We consider that ra, de are gien in milli-arcsec, so we divide by 3600000.

Methods inherited from class mysql.HtmStarDatabase
getCircularField, getHtmIndex, getHtmIndex, parseDefaultResultSet

Methods inherited from class mysql.AbstractSql
delete, distinct, distinct, exit, getAccess, getDefaultArchive, getDefaultFormat, 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
  - PPMXLFURMINT
```
public static final String PPMXLFURMINT
```
    The properties for connecting to the UCAC2 database on furmint.
    
    See Also:
    
    Constant Field Values
  - PPMXLDATABASE
```
public static final String PPMXLDATABASE
```
    The properties for connecting to the ppmxl db on stella.
    
    See Also:
    
    Constant Field Values
  - DEGMARCSEC
```
public static final double DEGMARCSEC
```
    Converts degrees to milliarcseconds.
    
    See Also:
    
    Constant Field Values
  - KEY_RAERR
```
public static final String KEY_RAERR
```
    The key linked to the error of the right ascension, mas.
    
    See Also:
    
    Constant Field Values
  - KEY_DEERR
```
public static final String KEY_DEERR
```
    The key linked to the error of the declination, mas.
    
    See Also:
    
    Constant Field Values
  - KEY_RI
```
public static final String KEY_RI
```
    The key linked to the R-I color expression.
    
    See Also:
    
    Constant Field Values
  - KEY_MAGERR
```
public static final String KEY_MAGERR
```
    The key linked to the error of the magnitude. Zero for low-quality mag.
    
    See Also:
    
    Constant Field Values
  - KEY_FAINTTABLE
```
public static final String KEY_FAINTTABLE
```
    The table name of the faint-magnitude stars. Same layout as main
    
    See Also:
    
    Constant Field Values
  - KEY_FAINTMAG
```
public static final String KEY_FAINTMAG
```
    Stars fainter than this go to the extended table.
    
    See Also:
    
    Constant Field Values
  - DEFTABLE
```
private static final String DEFTABLE
```
    Default table.
    
    See Also:
    
    Constant Field Values
  - DEFFAINTTABLE
```
private static final String DEFFAINTTABLE
```
    Default table.
    
    See Also:
    
    Constant Field Values
  - DEFHTMDEPTH
```
private static final int DEFHTMDEPTH
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFHTM
```
private static final String DEFHTM
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFNAME
```
private static final String DEFNAME
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFRA
```
private static final String DEFRA
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFRAERR
```
private static final String DEFRAERR
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFDE
```
private static final String DEFDE
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFDEERR
```
private static final String DEFDEERR
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFPMRA
```
private static final String DEFPMRA
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFPMDE
```
private static final String DEFPMDE
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFMAG
```
private static final String DEFMAG
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFCOLOR
```
private static final String DEFCOLOR
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFRI
```
private static final String DEFRI
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFMAGERR
```
private static final String DEFMAGERR
```
    Default column name.
    
    See Also:
    
    Constant Field Values
  - DEFFAINTMAG
```
private static final float DEFFAINTMAG
```
    See Also:
    
    Constant Field Values
  - table
```
private String table
```
    Currently queried table.
- Constructor Detail
  - PpmXlDatabase
```
public PpmXlDatabase(Map<String,String> prop)
```
    Constructs a new generic star database. The connection data are part of the parent class, while this class takes expressions on how to convert individual results from the result set to SimpleStars. Keys that are not defined mean that they are not present in the database.
- Method Detail
  - getDefaulProperites
```
public static final Map<String,String> getDefaulProperites()
```
    Returns the default properties for the ppmxl db on stella.aip.de
    
    Returns:
  - getTable
```
public String getTable()
```
    For querying faint stars we return the faint table name here.
    
    Overrides:
    
    getTable in class AbstractSql
  - getFaintMag
```
public float getFaintMag()
```
    Returns the magnitude above which the catalog is considered faint magnitudes. Bright magnitudes are for the FoV of the guider camera.
  - getCircularField
```
public List<Star> getCircularField(double ra,
                                   double dec,
                                   double radius,
                                   boolean strict)
                            throws SQLException
```
    Description copied from class: HtmStarDatabase
    
    Takes a central star and a circular radius around it to convert it to a database query result set, which is then passed to the HtmStarDatabase.parseResultSet(java.sql.ResultSet) method.
    
    Overrides:
    
    getCircularField in class HtmStarDatabase
    
    Parameters:
    
    ra - The central position, right ascension degrees.
    
    dec - The central position, declination degrees.
    
    radius - Radius of the circular field around the center, degrees.
    
    Throws:
    
    SQLException
  - getFaintCircularField
```
public List<Star> getFaintCircularField(double ra,
                                        double dec,
                                        double radius,
                                        boolean strict)
                                 throws SQLException
```
    Throws:
    
    SQLException
  - getFullCircularField
```
public List<Star> getFullCircularField(double ra,
                                       double dec,
                                       double radius,
                                       boolean strict)
                                throws SQLException
```
    Throws:
    
    SQLException
  - match
```
public Star match(SimpleStar to,
                  double radius,
                  boolean faint)
           throws ConnectException,
                  SQLException
```
    Matches the given star to the PPMXL database using the provided search radius, which should be five times the combined catalog position uncertainties.
    
    Returns:
    
    The star in PpmXl closest to the specified position.
    
    Throws:
    
    SQLException
    
    ConnectException
  - around
```
public List<Star> around(SimpleStar to,
                         double radius,
                         boolean faint)
                  throws ConnectException,
                         SQLException
```
    Matches the given star to the PPMXL database using the provided search radius, which should be five times the combined catalog position uncertainties.
    
    Returns:
    
    The star in PpmXl closest to the specified position.
    
    Throws:
    
    SQLException
    
    ConnectException
  - parseResultSet
```
protected SimpleStar parseResultSet(ResultSet rs)
                             throws SQLException
```
    We consider that ra, de are gien in milli-arcsec, so we divide by 3600000. Magnitudes are given in millimag, thus divide by 1000.
    
    Specified by:
    
    parseResultSet in class HtmStarDatabase
    
    Returns:
    
    A StarDescription parsed from the db entry
    
    Throws:
    
    SQLException

Class PpmXlDatabase

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.HtmStarDatabase

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.HtmStarDatabase

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

PPMXLFURMINT

PPMXLDATABASE

DEGMARCSEC

KEY_RAERR

KEY_DEERR

KEY_RI

KEY_MAGERR

KEY_FAINTTABLE

KEY_FAINTMAG

DEFTABLE

DEFFAINTTABLE

DEFHTMDEPTH

DEFHTM

DEFNAME

DEFRA

DEFRAERR

DEFDE

DEFDEERR

DEFPMRA

DEFPMDE

DEFMAG

DEFCOLOR

DEFRI

DEFMAGERR

DEFFAINTMAG

table

Constructor Detail

PpmXlDatabase

Method Detail

getDefaulProperites

getTable

getFaintMag

getCircularField

getFaintCircularField

getFullCircularField

match

around

parseResultSet