org.britastro.grelf.astro

Class Star

java.lang.Object

org.britastro.grelf.astro.Star

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, SkyObject

public class Star
extends java.lang.Object
implements SkyObject, java.lang.Cloneable, java.io.Serializable

A star can have several ids, from different catalogues. The commonId is for the brightest stars, comprising the constellation abbreviation and Flamsteed number and/or Bayer letter. If the user enters a reference of their own it is held in the otherId field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double	xdd Recalculated for different star charts.
protected double	zdd Recalculated for different star charts.

Constructor Summary

Constructors

Constructor and Description
Star() Set the fields individually after construction, if you really must.
Star(java.lang.String commonId, java.lang.String hipparcosId, java.lang.String tychoId, RA ra, Dec dec, Epoch epoch, Magnitude magnitude, Variability variability) Generally two of the ids passed in will be expected to be null; they may get set after construction.
Star(java.lang.String commonId, java.lang.String hipparcosId, java.lang.String tychoId, RA ra, Dec dec, Epoch epoch, Magnitude magnitude, Variability variability, double xdd, double zdd) Generally two of the ids passed in will be expected to be null.
Star(java.lang.String commonId, java.lang.String hipparcosId, java.lang.String tychoId, RA ra, Dec dec, Epoch epoch, Magnitude magnitude, Variability variability, ProperMotion pm) Generally two of the ids passed in will be expected to be null; they may get set after construction.
Star(java.lang.String commonId, java.lang.String hipparcosId, java.lang.String tychoId, RA ra, Dec dec, Epoch epoch, Magnitude magnitude, Variability variability, ProperMotion pm, double xdd, double zdd) Generally two of the ids passed in will be expected to be null.
Star(java.lang.String commonId, java.lang.String hipparcosId, java.lang.String tychoId, SkyPoint position, Magnitude magnitude, Variability variability) Generally two of the ids passed in will be expected to be null; they may get set after construction.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMagnitude(Magnitude m) Add another magnitude for this star.
Star	clone()
boolean	equals(java.lang.Object other) Does not involve the fields xdd and zdd because a given star may be plotted in different positions on different StarCharts.
java.lang.String	getCommonId() Comprising the constellation abbreviation and Flamsteed number and/or Bayer letter (only brightest stars have these).
java.lang.String	getHipparcosId()
java.lang.String	getId() If the star has a commonId return that; otherwise if it has a hipparcosId return that; otherwise if it has a tychoId return that; otherwise if it has an otherId return that; otherwise return an empty string.
Magnitude	getMagnitude() Get the "principal" magnitude.
Magnitude	getMagnitude(java.lang.String bandId) Get the magnitude with given band id, or null if not found.
java.util.List<Magnitude>	getMagnitudes() Get the list of magnitudes
SkyVector	getOffsetFromTarget() Typically the offset from the centre of a star chart or the axis of a cone search.
java.lang.String	getOtherId()
java.awt.Point	getPlotPoint() Set when the object is first plotted, to avoid recalculation when redrawing.
SkyPoint	getPosition() If the star's position is unknown this returns null.
ProperMotion	getProperMotion() If the star's proper motion is unknown this returns a ProperMotion object in which both components are zero.
java.lang.String	getTychoId()
Variability	getVariability() If the star's variability is unknown this returns null, not a special value.
int	hashCode() Enable objects of this class to be used as hash keys.
void	setCommonId(java.lang.String id)
void	setHipparcosId(java.lang.String id)
void	setMagnitude(Magnitude m) For entering a manual magnitude value to replace all others (as in BlobMenu).
void	setOffsetFromTarget(SkyVector offset)
void	setOtherId(java.lang.String id) For user-entered reference of their own devising.
void	setPlotPoint(java.awt.Point pt) Set by StarChart when first plotting the star.
void	setPosition(SkyPoint pt)
void	setProperMotion(ProperMotion pm)
void	setTychoId(java.lang.String id)
void	setVariability(Variability v)
java.lang.String	toFoldedString() More detailed and more suitable for display to the user - reasonably formatted multi-line text.
java.lang.String	toString() Simplified summary

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

xdd

protected transient double xdd

Recalculated for different star charts.

zdd

protected transient double zdd

Recalculated for different star charts.

Constructor Detail

Star

public Star(java.lang.String commonId,
    java.lang.String hipparcosId,
    java.lang.String tychoId,
    RA ra,
    Dec dec,
    Epoch epoch,
    Magnitude magnitude,
    Variability variability)

Generally two of the ids passed in will be expected to be null; they may get set after construction. If magnitude or variability are unknown enter null for each.

Star

public Star(java.lang.String commonId,
    java.lang.String hipparcosId,
    java.lang.String tychoId,
    SkyPoint position,
    Magnitude magnitude,
    Variability variability)

Generally two of the ids passed in will be expected to be null; they may get set after construction. If magnitude or variability are unknown enter null for each.

Star

public Star(java.lang.String commonId,
    java.lang.String hipparcosId,
    java.lang.String tychoId,
    RA ra,
    Dec dec,
    Epoch epoch,
    Magnitude magnitude,
    Variability variability,
    double xdd,
    double zdd)

Generally two of the ids passed in will be expected to be null. They may get set after construction. If magnitude or variability are unknown enter null for each. This constructor also takes the transformed coordinates (xdd, zdd) for plotting on a star chart. See class StarChart for details of the transformation.

Star

public Star(java.lang.String commonId,
    java.lang.String hipparcosId,
    java.lang.String tychoId,
    RA ra,
    Dec dec,
    Epoch epoch,
    Magnitude magnitude,
    Variability variability,
    ProperMotion pm)

Generally two of the ids passed in will be expected to be null; they may get set after construction. If magnitude or variability are unknown enter null for each.

Star

public Star(java.lang.String commonId,
    java.lang.String hipparcosId,
    java.lang.String tychoId,
    RA ra,
    Dec dec,
    Epoch epoch,
    Magnitude magnitude,
    Variability variability,
    ProperMotion pm,
    double xdd,
    double zdd)

Generally two of the ids passed in will be expected to be null. They may get set after construction. If magnitude or variability are unknown enter null for each. This constructor also takes the transformed coordinates (xdd, zdd) for plotting on a star chart. See class StarChart for details of the transformation.

Star

public Star()

Set the fields individually after construction, if you really must.

Method Detail

getId

public java.lang.String getId()

If the star has a commonId return that; otherwise if it has a hipparcosId return that; otherwise if it has a tychoId return that; otherwise if it has an otherId return that; otherwise return an empty string.

Specified by:

getId in interface SkyObject

getCommonId

public java.lang.String getCommonId()

Comprising the constellation abbreviation and Flamsteed number and/or Bayer letter (only brightest stars have these).

Specified by:

getCommonId in interface SkyObject

setCommonId

public void setCommonId(java.lang.String id)

getHipparcosId

public java.lang.String getHipparcosId()

setHipparcosId

public void setHipparcosId(java.lang.String id)

getTychoId

public java.lang.String getTychoId()

setTychoId

public void setTychoId(java.lang.String id)

getOtherId

public java.lang.String getOtherId()

setOtherId

public void setOtherId(java.lang.String id)

For user-entered reference of their own devising.

getPosition

public SkyPoint getPosition()

If the star's position is unknown this returns null.

Specified by:

getPosition in interface SkyObject

setPosition

public void setPosition(SkyPoint pt)

Specified by:

setPosition in interface SkyObject

getMagnitudes

public java.util.List<Magnitude> getMagnitudes()

Get the list of magnitudes

addMagnitude

public void addMagnitude(Magnitude m)

Add another magnitude for this star. A star can have multiple magnitudes, in different bands.

setMagnitude

public void setMagnitude(Magnitude m)

For entering a manual magnitude value to replace all others (as in BlobMenu). NB: REPLACES ALL.

Specified by:

setMagnitude in interface SkyObject

getMagnitude

public Magnitude getMagnitude()

Get the "principal" magnitude. If the star has only one magnitude value that is returned. Otherwise the list of magnitudes is scanned. If one is found that has band id "V" or "v" that is returned. Otherwise the first one in the list is returned. If the star's magnitude is unknown (the magnitudes list is empty) this returns null, not a special value.

Specified by:

getMagnitude in interface SkyObject

getMagnitude

public Magnitude getMagnitude(java.lang.String bandId)

Get the magnitude with given band id, or null if not found.

getVariability

public Variability getVariability()

If the star's variability is unknown this returns null, not a special value.

setVariability

public void setVariability(Variability v)

getProperMotion

public ProperMotion getProperMotion()

If the star's proper motion is unknown this returns a ProperMotion object in which both components are zero.

setProperMotion

public void setProperMotion(ProperMotion pm)

equals

public boolean equals(java.lang.Object other)

Does not involve the fields xdd and zdd because a given star may be plotted in different positions on different StarCharts.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Enable objects of this class to be used as hash keys. NB: Does not involve the fields xdd and zdd because a given star may be plotted in different positions on different StarCharts.

Overrides:

hashCode in class java.lang.Object

clone

public Star clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Simplified summary

Overrides:

toString in class java.lang.Object

toFoldedString

public java.lang.String toFoldedString()

More detailed and more suitable for display to the user - reasonably formatted multi-line text.

setPlotPoint

public void setPlotPoint(java.awt.Point pt)

Set by StarChart when first plotting the star.

Specified by:

setPlotPoint in interface SkyObject

getPlotPoint

public java.awt.Point getPlotPoint()

Description copied from interface: SkyObject

Set when the object is first plotted, to avoid recalculation when redrawing.

Specified by:

getPlotPoint in interface SkyObject

setOffsetFromTarget

public void setOffsetFromTarget(SkyVector offset)

Specified by:

setOffsetFromTarget in interface SkyObject

getOffsetFromTarget

public SkyVector getOffsetFromTarget()

Description copied from interface: SkyObject

Typically the offset from the centre of a star chart or the axis of a cone search.

Specified by:

getOffsetFromTarget in interface SkyObject