net.aerith.misao.catalog.io
Class VizieRUsnoAReader

java.lang.Object
  |
  +--net.aerith.misao.catalog.io.CatalogReader
        |
        +--net.aerith.misao.catalog.io.VizieRUsnoAReader

public class VizieRUsnoAReader

extends CatalogReader

The VizieRUsnoAReader is a class to read the query result of the USNO-A1.0/2.0 catalog at the VizieR Service saved as a text file.

The (x,y) position is also 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 CircumArea	circum_area The circum area to read stars.
protected java.io.BufferedReader	reader The input stream reader.
protected int	version The version of the USNO-A catalog.

Fields inherited from class net.aerith.misao.catalog.io.CatalogReader

center_coor, date, limiting_mag, url_set

Constructor Summary

VizieRUsnoAReader()
Constructs an empty VizieRUsnoAReader.

VizieRUsnoAReader(java.net.URL url)
Constructs a VizieRUsnoAReader with URL of the data file.

Method Summary

void	close() Closes a catalog.
java.lang.String	getHelpMessage() Gets the help message.
double	getMaximumPositionErrorInArcsec() Gets the maximum error of position in arcsec.
java.lang.String	getName() Gets the catalog name.
boolean	isFile() Checks if the catalog data is a file.
void	open(Coor coor, double fov) Opens a catalog.
CatalogStar	readNext() Reads one data from the opened catalog.
boolean	supportsExamination() Checks if the catalog supports the use in PIXY examination.

Methods inherited from class net.aerith.misao.catalog.io.CatalogReader

addURL, getDateLimit, getDateLimitMessage, getFovLimit, getFovLimitMessage, hasDateLimit, hasFovLimit, isDateDependent, isInDirectory, open, read, setDate, setDefaultURL, setLimitingMagnitude

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

reader

protected java.io.BufferedReader reader

The input stream reader.

circum_area

protected CircumArea circum_area

The circum area to read stars.

version

protected int version

The version of the USNO-A catalog.

Constructor Detail

VizieRUsnoAReader

public VizieRUsnoAReader()

Constructs an empty VizieRUsnoAReader.

VizieRUsnoAReader

public VizieRUsnoAReader(java.net.URL url)

Constructs a VizieRUsnoAReader with URL of the data file.

Parameters:

url - the URL of the data file.

Method Detail

getName

public java.lang.String getName()

Gets the catalog name. It must be unique among all subclasses.

Overrides:

getName in class CatalogReader

Returns:

the catalog name.

isFile

public boolean isFile()

Checks if the catalog data is a file.

Overrides:

isFile in class CatalogReader

Returns:

true if the catalog data is a file.

supportsExamination

public boolean supportsExamination()

Checks if the catalog supports the use in PIXY examination.

Overrides:

supportsExamination in class CatalogReader

Returns:

true if the catalog can be used in PIXY examination.

getMaximumPositionErrorInArcsec

public double getMaximumPositionErrorInArcsec()

Gets the maximum error of position in arcsec. It is the search area size to identify with other stars.

Overrides:

getMaximumPositionErrorInArcsec in class CatalogReader

Returns:

the maximum error of position in arcsec.

getHelpMessage

public java.lang.String getHelpMessage()

Gets the help message.

Overrides:

getHelpMessage in class CatalogReader

Returns:

the help message.

open

public void open(Coor coor,
                 double fov)
          throws java.io.IOException,
                 java.io.FileNotFoundException,
                 CdromNotFoundException

Opens a catalog. This method must be invoked at first.

Overrides:

open in class CatalogReader

Parameters:

coor - the R.A. and Decl. of the center.

fov - the field of view to read in degree.

Throws:

java.io.IOException - if a file cannot be accessed.

java.io.FileNotFoundException - if a file does not exists in any URL, and the file is in any CD-ROMs.

CdromNotFoundException - if a file does not exists in any URL, and the file is in a CD-ROM.

readNext

public CatalogStar readNext()
                     throws java.io.IOException,
                            java.io.FileNotFoundException,
                            CdromNotFoundException,
                            QueryFailException

Reads one data from the opened catalog. After this method is invoked, the cursor is promoted to tne next star. When every data is read, it returns null.

Overrides:

readNext in class CatalogReader

Returns:

a star data.

Throws:

java.io.IOException - if a file cannot be accessed.

java.io.FileNotFoundException - if a file does not exists in any URL, and the file is in any CD-ROMs.

CdromNotFoundException - if a file does not exists in any URL, and the file is in a CD-ROM.

QueryFailException - if the query to the server is failed.

close

public void close()
           throws java.io.IOException

Closes a catalog. This method must be invoked finally.

Overrides:

close in class CatalogReader

Throws:

java.io.IOException - if a file cannot be accessed.