|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Catalog
This interface defines the common interface to all catalogs.
Field Summary | |
---|---|
static java.lang.String |
ARCHIVE
Value returned by getType() for servers that return a table containing pointers to images and other data |
static java.lang.String |
CATALOG
Value returned by getType() for servers that return a table |
static java.lang.String |
DIRECTORY
Value returned by getType() for catalogs that return a list of other catalogs |
static java.lang.String |
IMAGE_SERVER
Value returned by getType() for servers that return an image |
static java.lang.String |
LOCAL
Value returned by getType() for local catalog files. |
static java.lang.String |
NAME_SERVER
Value returned by getType() for servers that return the RA,Dec coordinates for an object name |
Method Summary | |
---|---|
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 |
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 |
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 |
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. |
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) |
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(java.lang.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. |
Field Detail |
---|
static final java.lang.String CATALOG
static final java.lang.String ARCHIVE
static final java.lang.String IMAGE_SERVER
static final java.lang.String NAME_SERVER
static final java.lang.String DIRECTORY
static final java.lang.String LOCAL
Method Detail |
---|
java.lang.Object clone()
java.lang.String getName()
void setName(java.lang.String name)
java.lang.String getId()
java.lang.String getTitle()
java.lang.String getDescription()
java.net.URL getDocURL()
int getNumParams()
FieldDesc getParamDesc(int i)
FieldDesc getParamDesc(java.lang.String name)
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()
java.lang.String getType()
void setParent(CatalogDirectory catDir)
CatalogDirectory getParent()
Catalog[] getPath()
QueryResult query(QueryArgs queryArgs) throws java.io.IOException
queryArgs
- An object describing the query arguments.
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |