|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--net.aerith.misao.catalog.io.CatalogReader
The CatalogReader
is an abstract class of catalog
reader.
R.A. and Decl. of the center, and field of view are required. In
order to read all stars in the specified area, invoke
read
method. In order to read stars in the specified
area one by one, invoke open
method at first, then
invoke readNext
method repeatedly until it returns
null. Finally invoke close
method.
The (x,y) position must be set properly so that (0,0) represents the specified R.A. and Decl. to open method and (1,1) represents the position 1 deg to the west and 1 deg to the north.
Field Summary | |
protected Coor |
center_coor
The R.A. |
protected JulianDay |
date
The date. |
protected double |
limiting_mag
The limiting magnitude to read. |
protected URLSet |
url_set
The set of urls where to read data. |
Constructor Summary | |
CatalogReader()
|
Method Summary | |
void |
addURL(java.net.URL new_url)
Adds URL where to read data. |
abstract void |
close()
Closes a catalog. |
double |
getDateLimit()
Gets the limit on the date. |
java.lang.String |
getDateLimitMessage()
Gets the message for limit on the date. |
double |
getFovLimit()
Gets the limit on the field of view. |
java.lang.String |
getFovLimitMessage()
Gets the message for limit on the field of view. |
java.lang.String |
getHelpMessage()
Gets the help message. |
double |
getMaximumPositionErrorInArcsec()
Gets the maximum error of position in arcsec. |
abstract java.lang.String |
getName()
Gets the catalog name. |
boolean |
hasDateLimit()
Returns true if the reader has limit on the date. |
boolean |
hasFovLimit()
Returns true if the reader has limit on the field of view. |
boolean |
isDateDependent()
Checks if the catalog depends on the date. |
boolean |
isFile()
Checks if the catalog data is a file. |
boolean |
isInDirectory()
Checks if the catalog data is in a directory. |
void |
open()
Opens a catalog to read all star data. |
abstract void |
open(Coor coor,
double fov)
Opens a catalog. |
CatalogStarList |
read(Coor coor,
double fov)
Reads all star data in the specified area. |
abstract CatalogStar |
readNext()
Reads one star from the opened catalog. |
void |
setDate(JulianDay date)
Sets the date. |
protected void |
setDefaultURL()
Sets the default catalog path. |
void |
setLimitingMagnitude(double new_limiting_mag)
Sets the limiting magnitude to read. |
boolean |
supportsExamination()
Checks if the catalog supports the use in PIXY examination. |
Methods inherited from class java.lang.Object |
|
Field Detail |
protected URLSet url_set
protected Coor center_coor
protected double limiting_mag
protected JulianDay date
Constructor Detail |
public CatalogReader()
Method Detail |
protected void setDefaultURL()
public void addURL(java.net.URL new_url)
new_url
- the new URL to read data.public abstract java.lang.String getName()
public boolean isInDirectory()
public boolean isFile()
public boolean supportsExamination()
public boolean isDateDependent()
public void setDate(JulianDay date)
date
- the date.public boolean hasFovLimit()
public double getFovLimit()
public java.lang.String getFovLimitMessage()
public boolean hasDateLimit()
public double getDateLimit()
public java.lang.String getDateLimitMessage()
public double getMaximumPositionErrorInArcsec()
public java.lang.String getHelpMessage()
public void setLimitingMagnitude(double new_limiting_mag)
new_limiting_mag
- the new limiting magnitude.public void open() throws java.io.IOException, java.io.FileNotFoundException, CdromNotFoundException
public abstract void open(Coor coor, double fov) throws java.io.IOException, java.io.FileNotFoundException, CdromNotFoundException
coor
- the R.A. and Decl. of the center.fov
- the field of view to read in degree.public abstract CatalogStar readNext() throws java.io.IOException, java.io.FileNotFoundException, CdromNotFoundException, QueryFailException
public abstract void close() throws java.io.IOException
public CatalogStarList read(Coor coor, double fov) throws java.io.IOException, java.io.FileNotFoundException, CdromNotFoundException, QueryFailException
coor
- the R.A. and Decl. of the center.fov
- the field of view to read in degree.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |