VizierStarParser

java.lang.Object
- util.PropertyContainer
- - astro.VizierStarParser

All Implemented Interfaces:

Cloneable, PropertySupplying
```
public class VizierStarParser
extends PropertyContainer
```
This class converts a VizierTable into a list of SimpleStars. It uses ExpressionNodes and an ExpressionParser to evaluate the SimpleStar fields from the net.cds.Vizier.Table. For this to work, the appropriate keys should point to String-expression that are then filled with data from the table at run-time. Keys that are empty mean that this info is not available in the VizieR catalog. The name of the star must always translate to a single field in the table. Its value is converted to a string. Values for the UCAC V2 release, its bright supplement, the hipparchos table, the guides-star catalog V 2.2. It is a pain in the ass if field names use normal parenthesis in their names, because those are reserved for arithemtics. There is no good solution for this. If you ever encounter field names with normal parenthesis, replace them with "[", parenthesis like "<" should be replaced with "{". A minus '-' can be expressed as a '.'.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`VizierStarParser.HipparchosUcac2` This class compares the hipparchos main catalogue with the UCAC2 catalogue.
`static class`	`VizierStarParser.Retrieve` Mainly for testing the class.

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`DEFDECALC` The default de-expression for the UCAC2 catalog.
`private static String`	`DEFEPOCHCALC` The default epoch expression.
`private static String`	`DEFEQUINOXCALC` The default equinox expression.
`private static String`	`DEFNAMESEPARATE` The default name separator is the empty string.
`private static String`	`DEFRACALC` The default ra-expression for the UCAC2 catalog.
`static String`	`KEY_COLORCALC` The key linked to the color expression.
`static String`	`KEY_DECALC` The key linked to the declination expression.
`static String`	`KEY_EPOCHCALC` The key linked to the epoch expression.
`static String`	`KEY_EQUINOXCALC` The key linked to the equinox expression.
`static String`	`KEY_IDCALC` The key linked to the id expression.
`static String`	`KEY_MAGCALC` The key linked to the magnitude expression.
`static String`	`KEY_MIXEDID` For mixed cataloges, this points to the mixed identifier.
`static String`	`KEY_MIXEDVALID` This is a comma-separated list of star entries in mixed cataloges.
`static String`	`KEY_NAME` The key linked to the Table field that is the name.
`static String`	`KEY_NAMEPREPEND` The key linked to the static part of the name that prepends it.
`static String`	`KEY_NAMESEPARATE` The key linked to the name separator in case of multiple fields.
`static String`	`KEY_PMDECALC` The key linked to the proper motion in de expression.
`static String`	`KEY_PMRACALC` The key linked to the proper motion in ra expression.
`static String`	`KEY_RACALC` The key linked to the right ascension expression.
`static String`	`KEY_TABLEID` The VizieR catalog ID.
`static String`	`KEY_TABLETEXT` The Vizier table text.
`private List<String>`	`mix` A list of valid star identifiers or null for non-mixed cataloges.
`private List<String>`	`nameid` A list of name-identifier fields, normally only a single entry.

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

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Constructor and Description

VizierStarParser(Map<String,String> prop)
Constructs a new vizier-star conversion object.

Constructors
Constructor and Description
`VizierStarParser(Map<String,String> prop)` Constructs a new vizier-star conversion object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static Number`	`evaluate(String node, Map<String,Object> data)` Evaluates a single expression.
`private static Number`	`evaluateSingle(String node, Map<String,Object> data)` Evaluates a single expression.
`List<Star>`	`getFieldOfView(double centerra, double centerde, double radius)` Retrieves a list of `SimpleStar` objects utilizing the `Vizier` class.
`List<Star>`	`getFieldOfView(String centerobject, double radius)` Retrieves a list of `SimpleStar` objects utilizing the `Vizier` class.
`List<Star>`	`getFieldOfView(VizierTable tab)` Parses a list of `SimpleStar` objects utilizing the `net.cds.Vizier.Table` handed over.
`private Star`	`getOneStar(Map<String,Object> vizier)` Converts a single `net.cds.Vizier.Table` data entry into a `SimpleStar`.

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

- Field Detail
  - KEY_TABLEID
```
public static final String KEY_TABLEID
```
    The VizieR catalog ID.
    
    See Also:
    
    Constant Field Values
  - KEY_TABLETEXT
```
public static final String KEY_TABLETEXT
```
    The Vizier table text.
    
    See Also:
    
    Constant Field Values
  - KEY_NAMEPREPEND
```
public static final String KEY_NAMEPREPEND
```
    The key linked to the static part of the name that prepends it.
    
    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_NAMESEPARATE
```
public static final String KEY_NAMESEPARATE
```
    The key linked to the name separator in case of multiple fields.
    
    See Also:
    
    Constant Field Values
  - KEY_IDCALC
```
public static final String KEY_IDCALC
```
    The key linked to the id expression.
    
    See Also:
    
    Constant Field Values
  - KEY_RACALC
```
public static final String KEY_RACALC
```
    The key linked to the right ascension expression.
    
    See Also:
    
    Constant Field Values
  - KEY_DECALC
```
public static final String KEY_DECALC
```
    The key linked to the declination expression.
    
    See Also:
    
    Constant Field Values
  - KEY_PMRACALC
```
public static final String KEY_PMRACALC
```
    The key linked to the proper motion in ra expression.
    
    See Also:
    
    Constant Field Values
  - KEY_PMDECALC
```
public static final String KEY_PMDECALC
```
    The key linked to the proper motion in de expression.
    
    See Also:
    
    Constant Field Values
  - KEY_MAGCALC
```
public static final String KEY_MAGCALC
```
    The key linked to the magnitude expression.
    
    See Also:
    
    Constant Field Values
  - KEY_COLORCALC
```
public static final String KEY_COLORCALC
```
    The key linked to the color expression.
    
    See Also:
    
    Constant Field Values
  - KEY_EPOCHCALC
```
public static final String KEY_EPOCHCALC
```
    The key linked to the epoch expression.
    
    See Also:
    
    Constant Field Values
  - KEY_EQUINOXCALC
```
public static final String KEY_EQUINOXCALC
```
    The key linked to the equinox expression.
    
    See Also:
    
    Constant Field Values
  - KEY_MIXEDID
```
public static final String KEY_MIXEDID
```
    For mixed cataloges, this points to the mixed identifier.
    
    See Also:
    
    Constant Field Values
  - KEY_MIXEDVALID
```
public static final String KEY_MIXEDVALID
```
    This is a comma-separated list of star entries in mixed cataloges.
    
    See Also:
    
    Constant Field Values
  - DEFNAMESEPARATE
```
private static final String DEFNAMESEPARATE
```
    The default name separator is the empty string.
    
    See Also:
    
    Constant Field Values
  - DEFRACALC
```
private static final String DEFRACALC
```
    The default ra-expression for the UCAC2 catalog. '[' is replaced.
    
    See Also:
    
    Constant Field Values
  - DEFDECALC
```
private static final String DEFDECALC
```
    The default de-expression for the UCAC2 catalog. '[' is replaced.
    
    See Also:
    
    Constant Field Values
  - DEFEQUINOXCALC
```
private static final String DEFEQUINOXCALC
```
    The default equinox expression.
    
    See Also:
    
    Constant Field Values
  - DEFEPOCHCALC
```
private static final String DEFEPOCHCALC
```
    The default epoch expression.
    
    See Also:
    
    Constant Field Values
  - nameid
```
private final List<String> nameid
```
    A list of name-identifier fields, normally only a single entry.
  - mix
```
private List<String> mix
```
    A list of valid star identifiers or null for non-mixed cataloges.
- Constructor Detail
  - VizierStarParser
```
public VizierStarParser(Map<String,String> prop)
```
    Constructs a new vizier-star conversion object. This is a living reference because we want to have different properties on different converters. This constructor only defaults ra and de fields and the epoch and equinox.
- Method Detail
  - getFieldOfView
```
public List<Star> getFieldOfView(double centerra,
                                 double centerde,
                                 double radius)
```
    Retrieves a list of SimpleStar objects utilizing the Vizier class. From all tables retrieved, only the one matching KEY_TABLEID is kept. Thisnet.cds.Vizier.Table returned from the vizier call is converted into SimpleStar objects by parsing and evaluating the appropriate expressions found in the vizier-star properties.
    
    Parameters:
    
    centerra - Center of the field, right ascension, in degrees.
    
    centerde - Center of the field, declination, in degrees.
    
    radius - Circular size of the FoV, degrees.
  - getFieldOfView
```
public List<Star> getFieldOfView(String centerobject,
                                 double radius)
```
    Retrieves a list of SimpleStar objects utilizing the Vizier class. From all tables retrieved, only the one matching KEY_TABLEID is kept. This net.cds.Vizier.Table returned from the vizier call is converted into SimpleStar objects by parsing and evaluating the appropriate expressions found in the vizier-star properties.
    
    Parameters:
    
    centerobject - The Simbad-resolvable name of the object in center.
    
    radius - Circular size of the FoV, degrees.
    
    Returns:
    
    A list of SimpleStars or null.
  - getFieldOfView
```
public List<Star> getFieldOfView(VizierTable tab)
```
    Parses a list of SimpleStar objects utilizing the net.cds.Vizier.Table handed over. Entries are converted into SimpleStar objects by parsing and evaluating the appropriate expressions found in the vizier-star properties.
    
    Parameters:
    
    tab - The table from the Vizier or the servlet.
    
    Returns:
    
    A list of SimpleStars or null.
  - getOneStar
```
private Star getOneStar(Map<String,Object> vizier)
```
    Converts a single net.cds.Vizier.Table data entry into a SimpleStar. The star data is parsed and evaluated using the expressions in the vizier-star properties. The names of the variables are the keys in the map, the numerical values are the values in the map.
  - evaluate
```
private static Number evaluate(String node,
                               Map<String,Object> data)
```
    Evaluates a single expression. The data in the map is treated as a link from variable names to variable values. Note that variable names that contain characters also used in numerical expresseion, like parenthesis, must be stated in the expression with this chars replaced by the following table:
    - [ instead of (
    - ] instead of )
    - { instead of <
    - } instead of >
    - . instead of -
    If the expression is null or the parsing fails, Double.NaN is returned which is interpreted as integer zero. Implementation note: If the parsing turns out to be too slow, one can have a single ExpressionNode for each star-description field and only replace the variables in this method.
  - evaluateSingle
```
private static Number evaluateSingle(String node,
                                     Map<String,Object> data)
```
    Evaluates a single expression. The data in the map is treated as a link from variable names to variable values. Note that variable names that contain characters also used in numerical expresseion, like parenthesis, must be stated in the expression with this chars replaced by the following table:
    - [ instead of (
    - ] instead of )
    - { instead of <
    - } instead of >
    - . instead of -
    Type Parameters:
    
    T -

Class VizierStarParser

Nested Class Summary

Field Summary

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_TABLEID

KEY_TABLETEXT

KEY_NAMEPREPEND

KEY_NAME

KEY_NAMESEPARATE

KEY_IDCALC

KEY_RACALC

KEY_DECALC

KEY_PMRACALC

KEY_PMDECALC

KEY_MAGCALC

KEY_COLORCALC

KEY_EPOCHCALC

KEY_EQUINOXCALC

KEY_MIXEDID

KEY_MIXEDVALID

DEFNAMESEPARATE

DEFRACALC

DEFDECALC

DEFEQUINOXCALC

DEFEPOCHCALC

nameid

mix

Constructor Detail

VizierStarParser

Method Detail

getFieldOfView

getFieldOfView

getFieldOfView

getOneStar

evaluate

evaluateSingle