|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjsky.catalog.astrocat.AstroCatalog
public class AstroCatalog
Represents a catalog server, as described in an AstroCat XML catalog description file. This class is responsible for generating the catalog query.
Field Summary |
---|
Fields inherited from interface jsky.catalog.Catalog |
---|
ARCHIVE, CATALOG, DIRECTORY, IMAGE_SERVER, LOCAL |
Constructor Summary | |
---|---|
AstroCatalog()
Default constructor |
Method Summary | |
---|---|
protected void |
_setMaxRows(QueryArgs queryArgs,
SearchCondition[] sc)
Check for a "Max Objects" argument and if found, set queryArgs.maxRows with the value. |
java.lang.Object |
clone()
Implementation of the clone method (makes a shallow copy). |
java.lang.String |
getDescription()
Return a description of the catalog, or null if not available |
java.net.URL |
getDocURL()
Return a URL pointing to documentation for the catalog, or null if not available |
java.lang.String |
getHandlerClass()
Return the name of a class implementing the QueryResultHandler interface. |
java.lang.String |
getHost()
Return the host name where the catalog server lives |
java.lang.String |
getId()
Return the Id or short name of the catalog |
java.lang.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. |
FieldDesc |
getParamDesc(int i)
Return a description of the ith query parameter |
FieldDesc |
getParamDesc(java.lang.String name)
Return a description of the named query parameter, if found, otherwise null. |
CatalogDirectory |
getParent()
Return a reference to the parent catalog directory, or null if not known. |
Catalog[] |
getPath()
Return an array of Catalog or CatalogDirectory objects representing the path from the root catalog directory to this catalog. |
int |
getPort()
Return the host name where the catalog server lives |
java.lang.String |
getProtocol()
Return the protocol to use to access the catalog. |
TablePlotSymbol |
getSymbolDesc(int i)
Return the ith plot symbol description |
TablePlotSymbol[] |
getSymbols()
Return the array of symbol descriptions |
java.lang.String |
getTitle()
Return a string to display as a title for the catalog in a user interface |
java.lang.String |
getType()
Return the catalog type (one of the constants: CATALOG, ARCHIVE, DIRECTORY, LOCAL, IMAGE_SERVER) |
java.net.URL |
getURL()
Return the URL of the XML file describing this catalog, if known, otherwise null. |
java.lang.String |
getURLPath()
Return the path name to the catalog server |
boolean |
isImageServer()
Return true if this object represents an image server. |
boolean |
isLocal()
Return true if this is a local catalog, and false if it requires network access or if a query could hang. |
boolean |
isSymbolsEdited()
Return true if the user edited the plot symbol definitions otherwise false |
static void |
main(java.lang.String[] args)
Test cases |
QueryResult |
query(QueryArgs queryArgs)
Query the catalog using the given arguments and return the result. |
void |
saveSymbolConfig()
Save the catalog symbol information to disk with the user's changes |
void |
setDescription(java.lang.String description)
Set the catalog description or copyright info |
void |
setDocURL(java.lang.String docURL)
Set a URL pointing to more information about the catalog |
void |
setHandlerClass(java.lang.String handlerClass)
May be set to the name of a class implementing the QueryResultHandler interface. |
void |
setHost(java.lang.String host)
Set the host name where the catalog server lives |
void |
setId(java.lang.String id)
Set the catalog ID (short name) |
void |
setName(java.lang.String name)
Set the display name of the catalog |
void |
setParams(FieldDesc[] params)
Set the array of query parameters for this catalog |
void |
setParent(CatalogDirectory dir)
Set the parent catalog directory |
void |
setPort(int port)
Set the host name where the catalog server lives |
void |
setProtocol(java.lang.String protocol)
Set the protocol to use to access the catalog. |
void |
setRegionArgs(QueryArgs queryArgs,
CoordinateRadius region)
Given a description of a region of the sky (center point and radius range), and the current query argument settings, set the values of the corresponding query parameters. |
void |
setSymbols(TablePlotSymbol[] symbols)
Set the array of catalog table plot symbol definitions for use with this catalog |
void |
setSymbolsEdited(boolean edited)
Set to true if the user edited the plot symbol definitions (default: false) |
void |
setType(java.lang.String type)
Set the catalog type (one of the constants: CATALOG, ARCHIVE, DIRECTORY, LOCAL, IMAGE_SERVER) |
void |
setURL(java.net.URL url)
Set the URL of the XML file describing this catalog. |
void |
setURLPath(java.lang.String path)
Set the path name to the catalog server |
java.lang.String |
toString()
Return the name of the catalog |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AstroCatalog()
Method Detail |
---|
public java.lang.Object clone()
clone
in interface Catalog
clone
in class java.lang.Object
public java.net.URL getURL()
public void setURL(java.net.URL url)
public CatalogDirectory getParent()
Catalog
getParent
in interface Catalog
public void setParent(CatalogDirectory dir)
Catalog
setParent
in interface Catalog
public Catalog[] getPath()
getPath
in interface Catalog
public java.lang.String toString()
toString
in class java.lang.Object
public void setId(java.lang.String id)
public java.lang.String getId()
getId
in interface Catalog
public void setName(java.lang.String name)
setName
in interface Catalog
public java.lang.String getName()
getName
in interface Catalog
public void setDescription(java.lang.String description)
public java.lang.String getDescription()
getDescription
in interface Catalog
public void setDocURL(java.lang.String docURL)
public java.net.URL getDocURL()
getDocURL
in interface Catalog
public void setType(java.lang.String type)
public java.lang.String getType()
getType
in interface Catalog
public void setProtocol(java.lang.String protocol)
public java.lang.String getProtocol()
public void setHost(java.lang.String host)
public java.lang.String getHost()
public void setPort(int port)
public int getPort()
public void setURLPath(java.lang.String path)
public java.lang.String getURLPath()
public void setParams(FieldDesc[] params)
public void setSymbols(TablePlotSymbol[] symbols)
setSymbols
in interface PlotableCatalog
public void setSymbolsEdited(boolean edited)
setSymbolsEdited
in interface PlotableCatalog
public boolean isSymbolsEdited()
isSymbolsEdited
in interface PlotableCatalog
public void saveSymbolConfig()
saveSymbolConfig
in interface PlotableCatalog
public void setHandlerClass(java.lang.String handlerClass)
public java.lang.String getHandlerClass()
public java.lang.String getTitle()
getTitle
in interface Catalog
public int getNumParams()
getNumParams
in interface Catalog
public FieldDesc getParamDesc(int i)
getParamDesc
in interface Catalog
public FieldDesc getParamDesc(java.lang.String name)
getParamDesc
in interface Catalog
public int getNumSymbols()
getNumSymbols
in interface PlotableCatalog
public TablePlotSymbol getSymbolDesc(int i)
getSymbolDesc
in interface PlotableCatalog
public TablePlotSymbol[] getSymbols()
getSymbols
in interface PlotableCatalog
public void setRegionArgs(QueryArgs queryArgs, CoordinateRadius region)
setRegionArgs
in interface Catalog
queryArgs
- (in/out) describes the query argumentsregion
- (in) describes the query region (center and radius range)public boolean isLocal()
isLocal
in interface Catalog
public boolean isImageServer()
isImageServer
in interface Catalog
public QueryResult query(QueryArgs queryArgs) throws java.io.IOException
query
in interface Catalog
queryArgs
- An object describing the query arguments.
java.io.IOException
protected void _setMaxRows(QueryArgs queryArgs, SearchCondition[] sc)
public static void main(java.lang.String[] args)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |