|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjsky.catalog.skycat.TestCatalog
public class TestCatalog
Used for testing. This class provides a dummy catalog class that can be used for testing.
Field Summary |
---|
Fields inherited from interface jsky.catalog.Catalog |
---|
ARCHIVE, CATALOG, DIRECTORY, IMAGE_SERVER, LOCAL, NAME_SERVER |
Constructor Summary | |
---|---|
TestCatalog()
|
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 (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(java.lang.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. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TestCatalog()
Method Detail |
---|
public java.lang.Object clone()
clone
in interface Catalog
clone
in class java.lang.Object
public void setName(java.lang.String name)
setName
in interface Catalog
public java.lang.String getName()
getName
in interface Catalog
public java.lang.String getId()
getId
in interface Catalog
public java.lang.String getTitle()
getTitle
in interface Catalog
public java.lang.String getDescription()
getDescription
in interface Catalog
public java.net.URL getDocURL()
getDocURL
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 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 java.lang.String getType()
getType
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
public void setParent(CatalogDirectory catDir)
setParent
in interface Catalog
public CatalogDirectory getParent()
getParent
in interface Catalog
public Catalog[] getPath()
getPath
in interface Catalog
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |