net.aerith.misao.catalog.star
Class SaoStar

java.lang.Object
  |
  +--net.aerith.misao.util.Position
        |
        +--net.aerith.misao.util.star.StarPosition
              |
              +--net.aerith.misao.util.star.Star
                    |
                    +--net.aerith.misao.util.star.CatalogStar
                          |
                          +--net.aerith.misao.catalog.star.SaoStar

public class SaoStar
extends CatalogStar

The SaoStar represents a star data in the SAO Star Catalog.


Field Summary
protected  int number
          The star number.
protected  float p_mag
          The p magnitude.
protected  java.lang.Float prop_decl
          The proper motion in Decl.
protected  java.lang.Float prop_ra
          The proper motion in R.A.
protected  java.lang.String spectrum
          The spectrum.
protected  float v_mag
          The V magnitude.
 
Fields inherited from class net.aerith.misao.util.star.CatalogStar
detailed_output
 
Fields inherited from class net.aerith.misao.util.star.Star
color, container_pair, coor
 
Fields inherited from class net.aerith.misao.util.star.StarPosition
mag
 
Fields inherited from class net.aerith.misao.util.Position
x, y
 
Constructor Summary
SaoStar()
          Constructs an empty SaoStar.
SaoStar(int number, Coor coor)
          Constructs a SaoStar with data read from the catalog file.
 
Method Summary
 java.lang.String[] getAvailableMagnitudeSystems()
          Gets the list of magnitude systems supported by this catalog.
 java.lang.String getCatalogAcronym()
          Gets the acronym of the catalog.
 java.lang.String getCatalogCategory()
          Gets the category of the catalog.
 java.lang.String getCatalogCode()
          Gets the code of the catalog.
 java.lang.String getCatalogFolderCode()
          Gets the folder string of the catalog.
 java.lang.String getCatalogName()
          Gets the name of the catalog.
 byte getCoorAccuracy()
          Gets the accuracy of R.A.
 PlotProperty getDefaultProperty()
          Gets the default property to plot stars.
 java.util.Vector getHierarchicalFolders()
          Gets the list of the hierarchical folders.
 KeyAndValue[] getKeyAndValues()
          Gets an array of keys and values to output.
 KeyAndValue[] getKeyAndValuesForPhotometry()
          Gets an array of keys and values related to the photometry.
 double getMagnitude(java.lang.String system)
          Gets the magnitude of the specified system.
 java.lang.String getMagnitudeString(java.lang.String system)
          Gets the magnitude string of the specified system to output.
 java.lang.String getName()
          Gets the name of this star.
 java.lang.String getStarFolder()
          Gets the folder string of the star.
 java.lang.String getVsnetName()
          Gets the name of this star in a format for the VSNET (Variable Star Network).
 void setKeyAndValue(KeyAndValue key_and_value)
          Sets the value of the specified key.
 void setName(java.lang.String name)
          Sets the name of this star.
 void setPMagnitude(double p_mag)
          Sets the p magnitude.
 void setProperMotionInDecl(double prop)
          Sets the proper motion in Decl.
 void setProperMotionInRA(double prop)
          Sets the proper motion in R.A.
 void setSpectrum(java.lang.String spectrum)
          Sets the spectrum.
 void setVMagnitude(double v_mag)
          Sets the V magnitude.
 boolean supportsAstrometry()
          Returns true if the catalog contains accurate R.A.
 boolean supportsMagnitude()
          Returns true if the catalog contains magnitude data.
 
Methods inherited from class net.aerith.misao.util.star.CatalogStar
getBMagnitude, getBVDifference, getCatalogNamesWithMagnitudeSystem, getCatalogNameWithMagnitudeSystem, getCoorString, getCoorStringWithoutUnit, getDate, getHelpMessage, getIcMagnitude, getMagnitude, getMagnitudeSystem, getMaximumPositionErrorInArcsec, getPhotometryHelpMessage, getPositionErrorInArcsec, getRcMagnitude, getUMagnitude, getVMagnitude, isDescriptionEdittable, reduceOutput, setCoorAccuracy, supportsPhotometry
 
Methods inherited from class net.aerith.misao.util.star.Star
equals, getColor, getCoor, getDecl, getItemDelimiter, getKeyAndValueDelimiter, getOutputString, getOutputStringsWithXY, getOutputStringWithoutName, getOutputStringWithXY, getPair, getPositionString, getPxfString, getPxfStringsWithXY, getPxfStringWithXY, getRA, mapCoordinatesToXY, mapCoordinatesToXY, mapXYToCoordinates, mapXYToCoordinates, setColor, setCoor, setPair
 
Methods inherited from class net.aerith.misao.util.star.StarPosition
getMag, getOutputStrings, paramString, setMag, toString
 
Methods inherited from class net.aerith.misao.util.Position
add, getDistanceFrom, getPositionAngleTo, getX, getY, rescale, setPosition, setX, setY
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

number

protected int number
The star number.

p_mag

protected float p_mag
The p magnitude.

v_mag

protected float v_mag
The V magnitude.

spectrum

protected java.lang.String spectrum
The spectrum.

prop_ra

protected java.lang.Float prop_ra
The proper motion in R.A. (s/yr).

prop_decl

protected java.lang.Float prop_decl
The proper motion in Decl. ("/yr).
Constructor Detail

SaoStar

public SaoStar()
Constructs an empty SaoStar. It is used in StarClass#newInstance to review the XML data.

SaoStar

public SaoStar(int number,
               Coor coor)
Constructs a SaoStar with data read from the catalog file.
Parameters:
number - the number.
coor - the R.A. and Decl.
Method Detail

getName

public java.lang.String getName()
Gets the name of this star. This method returns such a string as SAO 1234.
Overrides:
getName in class Star
Returns:
the name of this star.

getVsnetName

public java.lang.String getVsnetName()
Gets the name of this star in a format for the VSNET (Variable Star Network). This method returns such a string as SAO1234.
Overrides:
getVsnetName in class Star
Returns:
the name of this star.

setName

public void setName(java.lang.String name)
Sets the name of this star.
Overrides:
setName in class CatalogStar
Parameters:
name - the name to set.

getCatalogName

public java.lang.String getCatalogName()
Gets the name of the catalog. It must be unique among all subclasses.
Overrides:
getCatalogName in class CatalogStar
Returns:
the name of the catalog.

getCatalogAcronym

public java.lang.String getCatalogAcronym()
Gets the acronym of the catalog.
Overrides:
getCatalogAcronym in class CatalogStar
Returns:
the acronym of the catalog.

getCatalogCode

public java.lang.String getCatalogCode()
Gets the code of the catalog. It must be unique among all subclasses.
Overrides:
getCatalogCode in class CatalogStar
Returns:
the code of the catalog.

getCatalogFolderCode

public java.lang.String getCatalogFolderCode()
Gets the folder string of the catalog. It must be unique among all subclasses.
Overrides:
getCatalogFolderCode in class CatalogStar
Returns:
the folder string of the catalog.

getCatalogCategory

public java.lang.String getCatalogCategory()
Gets the category of the catalog.
Overrides:
getCatalogCategory in class CatalogStar
Returns:
the category of the catalog.

getHierarchicalFolders

public java.util.Vector getHierarchicalFolders()
Gets the list of the hierarchical folders.
Overrides:
getHierarchicalFolders in class CatalogStar
Returns:
the list of the hierarchical folders.

getStarFolder

public java.lang.String getStarFolder()
Gets the folder string of the star.
Overrides:
getStarFolder in class CatalogStar
Returns:
the folder string of the star.

getCoorAccuracy

public byte getCoorAccuracy()
Gets the accuracy of R.A. and Decl.
Overrides:
getCoorAccuracy in class CatalogStar
Returns:
the accuracy of R.A. and Decl.

supportsMagnitude

public boolean supportsMagnitude()
Returns true if the catalog contains magnitude data.
Overrides:
supportsMagnitude in class CatalogStar
Returns:
true if the catalog contains magnitude data.

supportsAstrometry

public boolean supportsAstrometry()
Returns true if the catalog contains accurate R.A. and Decl. enough for astrometry.
Overrides:
supportsAstrometry in class CatalogStar
Returns:
true if the catalog contains accurate R.A. and Decl. enough for astrometry.

setPMagnitude

public void setPMagnitude(double p_mag)
Sets the p magnitude.
Parameters:
p_mag - the p magnitude.

setVMagnitude

public void setVMagnitude(double v_mag)
Sets the V magnitude.
Parameters:
v_mag - the V magnitude.

setSpectrum

public void setSpectrum(java.lang.String spectrum)
Sets the spectrum.
Parameters:
spectrum - the spectrum.

setProperMotionInRA

public void setProperMotionInRA(double prop)
Sets the proper motion in R.A. (s/yr).
Parameters:
prop - the proper motion in R.A. (s/yr).

setProperMotionInDecl

public void setProperMotionInDecl(double prop)
Sets the proper motion in Decl. ("/yr).
Parameters:
prop - the proper motion in Decl. ("/yr).

getAvailableMagnitudeSystems

public java.lang.String[] getAvailableMagnitudeSystems()
Gets the list of magnitude systems supported by this catalog.
Overrides:
getAvailableMagnitudeSystems in class CatalogStar
Returns:
the list of magnitude systems supported by this catalog.

getMagnitude

public double getMagnitude(java.lang.String system)
                    throws UnsupportedMagnitudeSystemException
Gets the magnitude of the specified system.
Overrides:
getMagnitude in class CatalogStar
Parameters:
system - the magnitude system.
Returns:
the magnitude of the specified system.
Throws:
UnsupportedMagnitudeSystemException - if the specified magnitude system is not supported.

getMagnitudeString

public java.lang.String getMagnitudeString(java.lang.String system)
                                    throws UnsupportedMagnitudeSystemException
Gets the magnitude string of the specified system to output.
Overrides:
getMagnitudeString in class CatalogStar
Parameters:
system - the magnitude system.
Returns:
the magnitude string of the specified system.
Throws:
UnsupportedMagnitudeSystemException - if the specified magnitude system is not supported.

getDefaultProperty

public PlotProperty getDefaultProperty()
Gets the default property to plot stars.
Overrides:
getDefaultProperty in class CatalogStar
Returns:
the default property to plot stars.

getKeyAndValues

public KeyAndValue[] getKeyAndValues()
Gets an array of keys and values to output.
Overrides:
getKeyAndValues in class Star
Returns:
an array of keys and values to output.

setKeyAndValue

public void setKeyAndValue(KeyAndValue key_and_value)
Sets the value of the specified key.
Overrides:
setKeyAndValue in class Star
Parameters:
key_and_value - the key and value to set.

getKeyAndValuesForPhotometry

public KeyAndValue[] getKeyAndValuesForPhotometry()
Gets an array of keys and values related to the photometry.
Overrides:
getKeyAndValuesForPhotometry in class CatalogStar
Returns:
an array of keys and values related to the photometry.