public class SkycatConfigEntry extends Object
Modifier and Type | Field and Description |
---|---|
static String |
B1950
Alternative equinox.
|
static String |
DEC
parameter: DEC coordinate
|
static String |
EQUINOX
parameter: equinox of RA,Dec
|
static String |
HEIGHT
parameter: height of query area (in arcmin or pixels)
|
static String |
J2000
Default equinox.
|
static String |
MAX_OBJECTS
parameter: max number of objects to return from a query.
|
static String |
MAX_RADIUS
parameter: maximum radius for center coordinates in arcmin (from RA,Dec), or pixels (from X,Y).
|
static String |
MIN_RADIUS
parameter: minimum radius for center coordinates in arcmin (from RA,Dec), or pixels (from X,Y).
|
static String |
NAME_SERVER
parameter: name server to use to resolve an object (star, galaxy, ...) name.
|
static String |
OBJECT
parameter: object (star, galaxy,...) name (to be resolved by a name server)
|
static String |
RA
parameter: RA coordinate
|
static String |
WIDTH
parameter: width of query area (in arcmin or pixels)
|
static String |
X
parameter: X coordinate (image coords)
|
static String |
Y
parameter: Y coordinate (image coords)
|
Constructor and Description |
---|
SkycatConfigEntry(Properties properties)
Initialize the config entry from the given catalog configuration properties.
|
SkycatConfigEntry(SkycatConfigFile configFile,
Properties properties)
Initialize the config entry from the given catalog configuration properties.
|
Modifier and Type | Method and Description |
---|---|
protected void |
checkSearchCols(Vector params)
Check for additional search parameters defined in the "search_cols" property
and add them to the given parameter description vector.
|
protected void |
determineSearchParameters()
Skycat catalogs normally default to the following parameters:
objectName, nameServer, ra, dec, minRadius, maxRadius, maxObjects.
|
CatalogDirectory |
getConfigFile()
Return a reference to the SkycatConfigFile object containing this catalog, or
null if not known.
|
URL |
getDocURL()
Return a URL pointing to documentation for the catalog, or null if not available
|
static NameValue[] |
getEquinoxOptions() |
String |
getLongName()
Return the long name of the catalog
|
String |
getName()
Return the name of the catalog
|
int |
getNumParams()
If this catalog can be querried, return the number of query parameters that it accepts
|
int |
getNumSymbols()
Return the number of plot symbol definitions associated with this catalog.
|
int |
getNumURLs()
Return the number of query URLs defined
|
FieldDesc |
getParamDesc(int i)
Return a description of the ith query parameter
|
FieldDesc |
getParamDesc(String name)
Return a description of the named query parameter, if found, otherwise null.
|
Properties |
getProperties()
Return the fields of this catalog entry as a property table.
|
String |
getProperty(String key)
Return the value of the named property as a String
|
RowCoordinates |
getRowCoordinates()
Return the object storing the column indexes where RA,Dec or X,Y are found
|
String |
getServType()
Return the value from the serv_type field.
|
String |
getShortName()
Return a short name or alias for the catalog
|
TablePlotSymbol |
getSymbolDesc(int i)
Return the ith plot symbol description
|
TablePlotSymbol[] |
getSymbols()
Return the array of symbol descriptions
|
String |
getURL(int n)
Return the nth query URL
|
boolean |
isSymbolsEdited()
Return true if the user edited the plot symbol definitions otherwise false
|
protected void |
parseProperties()
Parse the catalog properties and set the values for the member variables as needed.
|
void |
setConfigFile(CatalogDirectory configFile)
Return a reference to the SkycatConfigFile object containing this catalog, or
null if not known.
|
void |
setName(String name)
Set the name of the catalog
|
void |
setParamDesc(FieldDescAdapter[] paramDesc)
Set the array describing the query parameters.
|
void |
setServType(String servType)
Return the value from the serv_type field.
|
void |
setSymbols(TablePlotSymbol[] symbols)
Set the array of catalog table plot symbol definitions
|
void |
setSymbolsEdited(boolean edited)
Set to true if the user edited the plot symbol definitions (default: false)
|
void |
setURLs(String[] urls)
Return the nth query URL
|
public static final String OBJECT
public static final String NAME_SERVER
public static final String RA
public static final String DEC
public static final String EQUINOX
public static final String X
public static final String Y
public static final String MIN_RADIUS
public static final String MAX_RADIUS
public static final String MAX_OBJECTS
public static final String WIDTH
public static final String HEIGHT
public static final String J2000
public static final String B1950
public SkycatConfigEntry(SkycatConfigFile configFile, Properties properties)
configFile
- a reference to the SkycatConfigFile object containing
this entry, if known (used to search for a name server entry)properties
- contains (keyword : value) pairs, such as those
found in a (skycat style) catalog configuration file,
describing the catalog features.public SkycatConfigEntry(Properties properties)
properties
- contains (keyword : value) pairs, such as those
found in a (skycat style) catalog configuration file,
describing the catalog features.public Properties getProperties()
public CatalogDirectory getConfigFile()
public void setConfigFile(CatalogDirectory configFile)
protected void parseProperties()
protected void determineSearchParameters()
Parse the search column information from the catalog config entry, if found, and set the paramDesc member variable. The format of the search_cols value is: name minLabel MaxLabel : ..., (in Tcl list format).
protected void checkSearchCols(Vector params)
public static NameValue[] getEquinoxOptions()
public String getProperty(String key)
public void setName(String name)
public String getName()
public URL getDocURL()
public String getServType()
public void setServType(String servType)
public int getNumParams()
public FieldDesc getParamDesc(int i)
public FieldDesc getParamDesc(String name)
public void setParamDesc(FieldDescAdapter[] paramDesc)
public String getShortName()
public String getLongName()
public int getNumURLs()
public String getURL(int n)
public void setURLs(String[] urls)
public RowCoordinates getRowCoordinates()
public int getNumSymbols()
public TablePlotSymbol getSymbolDesc(int i)
public TablePlotSymbol[] getSymbols()
public void setSymbols(TablePlotSymbol[] symbols)
public void setSymbolsEdited(boolean edited)
public boolean isSymbolsEdited()
Copyright © 2023 Central Laboratory of the Research Councils. All Rights Reserved.