net.aerith.misao.catalog.star
Class UserStar

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.UserStar

Direct Known Subclasses:

AstrometricaStar

public class UserStar

extends CatalogStar

The UserStar represents a star data with the name, R.A. and Decl., and the magnitude.

Field Summary

protected java.lang.String

name The name.

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

UserStar()
Constructs an empty UserStar.

UserStar(java.lang.String name, Coor coor, double mag)
Constructs a UserStar with initial data.

Method Summary

java.lang.String[]	getAvailableMagnitudeSystems() Gets the list of magnitude systems supported by this 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.
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.
boolean	isDescriptionEdittable() Returns true if the catalog description of astrometry and photometry is edittable.
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.
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, getCatalogAcronym, getCatalogNamesWithMagnitudeSystem, getCatalogNameWithMagnitudeSystem, getCoorAccuracy, getCoorString, getCoorStringWithoutUnit, getDate, getHelpMessage, getIcMagnitude, getMagnitude, getMagnitudeSystem, getMaximumPositionErrorInArcsec, getPhotometryHelpMessage, getPositionErrorInArcsec, getRcMagnitude, getUMagnitude, getVMagnitude, 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, getVsnetName, 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

name

protected java.lang.String name

The name.

Constructor Detail

UserStar

public UserStar()

Constructs an empty UserStar. It is used in StarClass#newInstance to review the XML data.

UserStar

public UserStar(java.lang.String name,
                Coor coor,
                double mag)

Constructs a UserStar with initial data.

Parameters:

name - the name, which can be null.

coor - the R.A. and Decl.

mag - the magnitude.

Method Detail

getName

public java.lang.String getName()

Gets the name of this star. If no proper name is specified by the user, it returns such a name as J123456.78+123456.7.

Overrides:

getName 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.

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.

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.

isDescriptionEdittable

public boolean isDescriptionEdittable()

Returns true if the catalog description of astrometry and photometry is edittable. If not, the description is the catalog name.

Overrides:

isDescriptionEdittable in class CatalogStar

Returns:

true if the catalog description of astrometry and photometry is edittable.

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.