public interface Catalog extends QueryResult, Cloneable
Modifier and Type | Field and Description |
---|---|
static String |
ARCHIVE
Value returned by getType() for servers that return a table containing pointers to
images and other data
|
static String |
CATALOG
Value returned by getType() for servers that return a table
|
static String |
DIRECTORY
Value returned by getType() for catalogs that return a list of other catalogs
|
static String |
IMAGE_SERVER
Value returned by getType() for servers that return an image
|
static String |
LOCAL
Value returned by getType() for local catalog files.
|
static String |
NAME_SERVER
Value returned by getType() for servers that return the RA,Dec coordinates for an object name
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Implementation of the clone method (makes a shallow copy).
|
String |
getDescription()
Return a description of the catalog, or null if not available
|
URL |
getDocURL()
Return a URL pointing to documentation for the catalog, or null if not available
|
String |
getId()
Return the Id or short 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
|
FieldDesc |
getParamDesc(int i)
Return a description of the ith query parameter
|
FieldDesc |
getParamDesc(String name)
Return a description of the named query parameter
|
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.
|
String |
getTitle()
Return a string to display as a title for the catalog in a user interface
|
String |
getType()
Return the catalog type (one of the constants: CATALOG, ARCHIVE, DIRECTORY, LOCAL, IMAGE_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.
|
QueryResult |
query(QueryArgs queryArgs)
Query the catalog using the given arguments and return the result.
|
void |
setName(String name)
Set the catalog's name
|
void |
setParent(CatalogDirectory catDir)
Set the parent catalog directory
|
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.
|
static final String CATALOG
static final String ARCHIVE
static final String IMAGE_SERVER
static final String NAME_SERVER
static final String DIRECTORY
static final String LOCAL
Object clone()
String getName()
void setName(String name)
String getId()
String getTitle()
String getDescription()
URL getDocURL()
int getNumParams()
FieldDesc getParamDesc(int i)
void setRegionArgs(QueryArgs queryArgs, CoordinateRadius region)
queryArgs
- (in/out) describes the query argumentsregion
- (in) describes the query region (center and radius range)boolean isLocal()
boolean isImageServer()
String getType()
void setParent(CatalogDirectory catDir)
CatalogDirectory getParent()
Catalog[] getPath()
QueryResult query(QueryArgs queryArgs) throws IOException
queryArgs
- An object describing the query arguments.IOException
Copyright © 2023 Central Laboratory of the Research Councils. All Rights Reserved.