public class TestCatalog extends Object implements Catalog
ARCHIVE, CATALOG, DIRECTORY, IMAGE_SERVER, LOCAL, NAME_SERVER
Constructor and Description |
---|
TestCatalog() |
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 (normally one of the Catalog 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 name of the catalog
|
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.
|
public Object clone()
public void setName(String name)
public String getName()
public String getId()
public String getTitle()
public String getDescription()
getDescription
in interface Catalog
public URL getDocURL()
public int getNumParams()
getNumParams
in interface Catalog
public FieldDesc getParamDesc(int i)
getParamDesc
in interface Catalog
public FieldDesc getParamDesc(String name)
getParamDesc
in interface Catalog
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()
public String getType()
public boolean isImageServer()
isImageServer
in interface Catalog
public QueryResult query(QueryArgs queryArgs) throws IOException
query
in interface Catalog
queryArgs
- An object describing the query arguments.IOException
public void setParent(CatalogDirectory catDir)
public CatalogDirectory getParent()
Copyright © 2023 Central Laboratory of the Research Councils. All Rights Reserved.