jsky.catalog
Interface PlotableCatalog

All Superinterfaces:
Catalog, java.lang.Cloneable, QueryResult
All Known Implementing Classes:
AstroCatalog, SkycatCatalog

public interface PlotableCatalog
extends Catalog

Defines the interface for catalogs whose tabular query results can be plotted on an image.

Version:
$Revision: 1.2 $
Author:
Allan Brighton

Field Summary
 
Fields inherited from interface jsky.catalog.Catalog
ARCHIVE, CATALOG, DIRECTORY, IMAGE_SERVER, LOCAL, NAME_SERVER
 
Method Summary
 int getNumSymbols()
          Return the number of plot symbol definitions associated with this catalog.
 TablePlotSymbol getSymbolDesc(int i)
          Return the ith plot symbol description
 TablePlotSymbol[] getSymbols()
          Return an array of symbol descriptions, or null if none are defined.
 boolean isSymbolsEdited()
          Return true if the user edited the plot symbol definitions otherwise false
 void saveSymbolConfig()
          Save the catalogs's symbol definitions to disk with the user's changes
 void setSymbols(TablePlotSymbol[] symbols)
          Set the plot symbol descriptions to use to plot tables returned from this catalog
 void setSymbolsEdited(boolean edited)
          Set to true if the user edited the plot symbol definitions (default: false)
 
Methods inherited from interface jsky.catalog.Catalog
clone, getDescription, getDocURL, getId, getName, getNumParams, getParamDesc, getParamDesc, getParent, getPath, getTitle, getType, isImageServer, isLocal, query, setName, setParent, setRegionArgs
 

Method Detail

getNumSymbols

int getNumSymbols()
Return the number of plot symbol definitions associated with this catalog.


getSymbolDesc

TablePlotSymbol getSymbolDesc(int i)
Return the ith plot symbol description


getSymbols

TablePlotSymbol[] getSymbols()
Return an array of symbol descriptions, or null if none are defined.


setSymbols

void setSymbols(TablePlotSymbol[] symbols)
Set the plot symbol descriptions to use to plot tables returned from this catalog


setSymbolsEdited

void setSymbolsEdited(boolean edited)
Set to true if the user edited the plot symbol definitions (default: false)


isSymbolsEdited

boolean isSymbolsEdited()
Return true if the user edited the plot symbol definitions otherwise false


saveSymbolConfig

void saveSymbolConfig()
Save the catalogs's symbol definitions to disk with the user's changes