org.gjt.universe
Class GalaxyBase

java.lang.Object
  |
  +--org.gjt.universe.DBItem
        |
        +--org.gjt.universe.GalaxyBase

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GalaxyGliese, GalaxyStd, GalaxyTest, GalaxyUndefined

public abstract class GalaxyBase

extends DBItem

Abstract class from which all concrete classes used to represent galaxies in the game are to be derived. This class contains implementation of basic primitive methods for the storage and manipulation of standard galaxy attributes. Subclasses merely have to override the generateSystems method to ensure that star systems and their planets are created as per the nature of the galaxy (e.g. randomly determined, loaded from a data file, a combination of the above, etc.).

See Also:

GalaxyStd, GalaxyGliese, Serialized Form

Field Summary

private static GalaxyID	currentID
private VectorSystemID	GalaxySystems
private boolean	HasGeneratedSystems
private GalaxyID	ID
private java.lang.String	name

Constructor Summary

(package private)	GalaxyBase() Designated constructor - generates unique ID for the galaxy object and adds it to the list of galaxies in the game.
(package private)	GalaxyBase(boolean dummy) Constructor for GalaxyUndefined.

Method Summary

void	addSystem(SystemID SID) Adds a star system to the galaxy.
void	generateSystems(float[] planetDistribution) This method should be extended by subclasses to causes the receiving galaxy to generate the collection of star systems and associated planets which it will contain.
VectorSystemID	getGalaxySystems() Returns the galaxy's system list.
GalaxyID	getID() Return the ID
Index	getIndex() See getID() in the subclasses for a typed version.
java.lang.String	getName()
SystemBase	getRandomSystem() This method returns a star system randomly selected from those prsent in the galaxy.
SystemID	getRandomSystemID() This method returns the ID of a star system randomly selected from those present in the galaxy.
VectorSystemID	getRandomSystemIDs(int n) This method returns a list of distinct IDs of a star system randomly selected from those present in the galaxy.
boolean	hasGeneratedSystems() Returns true if the galaxy has been populated with star systems and their planets, and false if this has not yet been done.
void	setName(java.lang.String in_name)

Methods inherited from class org.gjt.universe.DBItem

getLocation, getOwner, specificDisplayDebug

Methods inherited from class java.lang.Object

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

Field Detail

currentID

private static GalaxyID currentID

ID

private GalaxyID ID

name

private java.lang.String name

GalaxySystems

private VectorSystemID GalaxySystems

HasGeneratedSystems

private boolean HasGeneratedSystems

Constructor Detail

GalaxyBase

GalaxyBase()

Designated constructor - generates unique ID for the galaxy object and adds it to the list of galaxies in the game. Subclasses must call this method in their constructor to ensure proper registration with the game.

GalaxyBase

GalaxyBase(boolean dummy)

Constructor for GalaxyUndefined. N.B. Does not register this instance with the game as one present in the game since its used to represent bogus or unknown galaxy information.

Method Detail

getID

public GalaxyID getID()

Return the ID

getIndex

public Index getIndex()

Description copied from class: DBItem

See getID() in the subclasses for a typed version.

Specified by:

getIndex in class DBItem

getName

public java.lang.String getName()

Specified by:

getName in class DBItem

setName

public void setName(java.lang.String in_name)

addSystem

public void addSystem(SystemID SID)

Adds a star system to the galaxy.

Parameters:

SID - The unique ID of the system to be added.

getGalaxySystems

public VectorSystemID getGalaxySystems()

Returns the galaxy's system list.

hasGeneratedSystems

public boolean hasGeneratedSystems()

Returns true if the galaxy has been populated with star systems and their planets, and false if this has not yet been done.

This method is primarily used as a guard to prevent the calling of generateSystems() more than once.

See Also:

generateSystems( float[] planetDistribution )

getRandomSystemID

public SystemID getRandomSystemID()

This method returns the ID of a star system randomly selected from those present in the galaxy. This method is slightly more efficient than getRandomSystem() and, therefore, should be used when only an ID, and not the actual system object, is needed. If the galaxy contains no star systems this method returns null.

See Also:

getRandomSystem()

getRandomSystem

public SystemBase getRandomSystem()

This method returns a star system randomly selected from those prsent in the galaxy. This method is implemented by calling getRandomSystemID and then looking up the system by the returned ID. If the galaxy contains no star systems this method returns null.

See Also:

getRandomSystemID()

getRandomSystemIDs

public VectorSystemID getRandomSystemIDs(int n)

This method returns a list of distinct IDs of a star system randomly selected from those present in the galaxy.

Parameters:

n - The number distinct system IDs desired.

See Also:

getRandomSystemID()

generateSystems

public void generateSystems(float[] planetDistribution)
                     throws SchemeUnknownException,
                            java.lang.InterruptedException

This method should be extended by subclasses to causes the receiving galaxy to generate the collection of star systems and associated planets which it will contain. Calls to this method after the galaxy is already populated with star systems should have no effect, and it is the responsiblity of subclasses to do this by checking the value returned from the hasGeneratedSystems method.

Parameters:

planetDistribution - Array of floating point values representing the probability of planetary mass at successive distances from its primary.

Throws:

SchemeUnknownException - If unable to determine a ID of the galaxy to which systems are to be added.

java.lang.InterruptedException - If access to a resource needed for star system generation has been interrupted.

See Also:

hasGeneratedSystems()