mysql

Class HtmStarDatabase

java.lang.Object

util.PropertyContainer

util.PropertyResources

mysql.AbstractSql

mysql.HtmStarDatabase

All Implemented Interfaces:

Cloneable, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

PpmXlDatabase, Ucac4Database

public abstract class HtmStarDatabase
extends AbstractSql

A class that allows access to databases holding stellar information where positions are indexed in an HTM.

Nested Class Summary

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	DEFEPOCH The default epoch expression.
private static String	DEFEQUINOX The default equinox expression.
static String	KEY_COLOR The key linked to the color expression.
static String	KEY_DE The key linked to the declination expression.
static String	KEY_EPOCH The key linked to the epoch expression.
static String	KEY_EQUINOX The key linked to the equinox expression.
static String	KEY_HTM The key linked to the Table field that is the HTM index field.
static String	KEY_HTMDEPTH The depth of HTM index.
static String	KEY_MAG The key linked to the magnitude expression.
static String	KEY_NAME The key linked to the Table field that is the name.
static String	KEY_PMDE The key linked to the proper motion in de expression.
static String	KEY_PMRA The key linked to the proper motion in ra expression.
static String	KEY_RA The key linked to the right ascension expression.

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

Modifier	Constructor and Description
protected	HtmStarDatabase(Map<String,String> prop) Constructs a new generic star database.

Method Summary

Modifier and Type	Method and Description
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 parseResultSet(java.sql.ResultSet) method.
List<Star>	getCircularField(Star center, 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 parseResultSet(java.sql.ResultSet) method.
long	getHtmIndex(double ra, double de)
long	getHtmIndex(Star star)
private List<Star>	getRange(long lo, long hi)
Star	parseDefaultResultSet(ResultSet rs, SimpleStar star) The classical fields defined are parsed and put into the empty star provided.
protected abstract Star	parseResultSet(ResultSet rs) This method parses a readily placed result set to a star description.
private void	purge(List<Star> all, double radeg, double dedeg, double radiusdeg)

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_HTMDEPTH

public static final String KEY_HTMDEPTH

The depth of HTM index.

See Also:

Constant Field Values

KEY_HTM

public static final String KEY_HTM

The key linked to the Table field that is the HTM index field.

See Also:

Constant Field Values

KEY_NAME

public static final String KEY_NAME

The key linked to the Table field that is the name.

See Also:

Constant Field Values

KEY_RA

public static final String KEY_RA

The key linked to the right ascension expression.

See Also:

Constant Field Values

KEY_DE

public static final String KEY_DE

The key linked to the declination expression.

See Also:

Constant Field Values

KEY_PMRA

public static final String KEY_PMRA

The key linked to the proper motion in ra expression.

See Also:

Constant Field Values

KEY_PMDE

public static final String KEY_PMDE

The key linked to the proper motion in de expression.

See Also:

Constant Field Values

KEY_MAG

public static final String KEY_MAG

The key linked to the magnitude expression.

See Also:

Constant Field Values

KEY_COLOR

public static final String KEY_COLOR

The key linked to the color expression.

See Also:

Constant Field Values

KEY_EPOCH

public static final String KEY_EPOCH

The key linked to the epoch expression.

See Also:

Constant Field Values

KEY_EQUINOX

public static final String KEY_EQUINOX

The key linked to the equinox expression.

See Also:

Constant Field Values

DEFEQUINOX

private static final String DEFEQUINOX

The default equinox expression.

See Also:

Constant Field Values

DEFEPOCH

private static final String DEFEPOCH

The default epoch expression.

See Also:

Constant Field Values

Constructor Detail

HtmStarDatabase

protected HtmStarDatabase(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

getHtmIndex

public long getHtmIndex(Star star)
                 throws HTMException

Throws:

HTMException

getHtmIndex

public long getHtmIndex(double ra,
                        double de)
                 throws HTMException

Throws:

HTMException

getCircularField

public List<Star> getCircularField(Star center,
                                   double radius,
                                   boolean strict)
                            throws SQLException

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 parseResultSet(java.sql.ResultSet) method.

Parameters:

center - The central star/position.

radius - Radius of the circular field around the center, degrees.

Throws:

SQLException

getCircularField

public List<Star> getCircularField(double ra,
                                   double dec,
                                   double radius,
                                   boolean strict)
                            throws SQLException

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 parseResultSet(java.sql.ResultSet) method.

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

parseDefaultResultSet

public Star parseDefaultResultSet(ResultSet rs,
                                  SimpleStar star)
                           throws SQLException

The classical fields defined are parsed and put into the empty star provided.

Parameters:

rs - The result set, placed on the row to read.

star - The empty star description, might be subclasses

Returns:

The argument star with new values filled in.

Throws:

SQLException

parseResultSet

protected abstract Star parseResultSet(ResultSet rs)
                                throws SQLException

This method parses a readily placed result set to a star description. a default implementation is provided as the method parseDefaultResultSet(java.sql.ResultSet, astro.SimpleStar).

Parameters:

rs -

Returns:

A StarDescription parsed from the db entry

Throws:

SQLException

getRange

private List<Star> getRange(long lo,
                            long hi)
                     throws SQLException

Throws:

SQLException

purge

private void purge(List<Star> all,
                   double radeg,
                   double dedeg,
                   double radiusdeg)