jsky.catalog.skycat
Class SkycatPlotSymbol

java.lang.Object
  extended by gnu.jel.DVMap
      extended by jsky.catalog.TablePlotSymbol
          extended by jsky.catalog.skycat.SkycatPlotSymbol
All Implemented Interfaces:
gnu.jel.DVResolver

public class SkycatPlotSymbol
extends TablePlotSymbol

Represents the contents of a plot symbol definition, as defined in a skycat catalog config file.

Version:
$Revision: 1.1 $
Author:
Allan Brighton

Field Summary
 
Fields inherited from class jsky.catalog.TablePlotSymbol
ARROW, CIRCLE, COLOR_NAMES, COLORS, COMPASS, CROSS, DEFAULT_DEC_COL, DEFAULT_EQUINOX, DEFAULT_RA_COL, DIAMOND, ELLIPSE, LINE, PLUS, SQUARE, SYMBOLS, TRIANGLE
 
Constructor Summary
SkycatPlotSymbol(SkycatTable table, java.lang.String[] colNames, java.lang.String shapeName, java.lang.String fg, java.lang.String bg, java.lang.String ratio, java.lang.String angle, java.lang.String label, java.lang.String cond, java.lang.String size, java.lang.String units)
          Initialize a SkycatPlotSymbol from the given values.
SkycatPlotSymbol(SkycatTable table, java.lang.String cols, java.lang.String symbol, java.lang.String expr)
          Parses the given fields from the plot symbol definition in the skycat catalog config file and makes the values available via methods.
 
Method Summary
 int getDecCol()
          Return the index of the center position Dec column
 int getRaCol()
          Return the index of the center position RA column
 RowCoordinates getRowCoordinates()
          Return an object storing the column indexes where RA and Dec are found
 
Methods inherited from class jsky.catalog.TablePlotSymbol
getAngle, getAngle, getBg, getBoundingShape, getColIndexes, getColNames, getColNamesList, getColorName, getCond, getCond, getDescription, getDoubleProperty, getEquinox, getFg, getFloatProperty, getLabel, getLabel, getName, getObjectProperty, getPlotSymbolInfo, getRatio, getRatio, getShape, getShapeName, getSize, getSize, getStringProperty, getTable, getTypeName, getUnits, parsePlotSymbolInfo, setAngle, setBg, setBg, setColNames, setCond, setDecCol, setDescription, setEquinox, setFg, setFg, setLabel, setName, setRaCol, setRatio, setShape, setShapeName, setSize, setTable, setUnits
 
Methods inherited from class gnu.jel.DVMap
translate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SkycatPlotSymbol

public SkycatPlotSymbol(SkycatTable table,
                        java.lang.String cols,
                        java.lang.String symbol,
                        java.lang.String expr)
Parses the given fields from the plot symbol definition in the skycat catalog config file and makes the values available via methods. Default values are filled in where needed.

Parameters:
table - contains the table data and information
cols - a Tcl list of column names that may be used in symbol expressions
symbol - a Tcl list of the form {shape color ratio angle label condition}
expr - a Tcl list of the form {sizeExpr units}

SkycatPlotSymbol

public SkycatPlotSymbol(SkycatTable table,
                        java.lang.String[] colNames,
                        java.lang.String shapeName,
                        java.lang.String fg,
                        java.lang.String bg,
                        java.lang.String ratio,
                        java.lang.String angle,
                        java.lang.String label,
                        java.lang.String cond,
                        java.lang.String size,
                        java.lang.String units)
Initialize a SkycatPlotSymbol from the given values.

Parameters:
table - contains the table data and information
colNames - an array of column headings used as variables
shapeName - the name of the plot symbol shape
fg - the name of the foreground color of the plot symbol
bg - the name of the background color of the plot symbol
ratio - the x/y ratio expression (stretch)
angle - the angle expression
label - the label expression
cond - the condition expression
size - the symbol size expression
units - the units of the symbol size
Method Detail

getRowCoordinates

public RowCoordinates getRowCoordinates()
Return an object storing the column indexes where RA and Dec are found

Overrides:
getRowCoordinates in class TablePlotSymbol

getRaCol

public int getRaCol()
Return the index of the center position RA column

Overrides:
getRaCol in class TablePlotSymbol

getDecCol

public int getDecCol()
Return the index of the center position Dec column

Overrides:
getDecCol in class TablePlotSymbol