org.jeospace.simulation
Class SystemNode

java.lang.Object
  org.jeospace.simulation.SystemNode

All Implemented Interfaces:

ChildNode, ParentNode, SimNode

public class SystemNode

extends java.lang.Object

implements ParentNode, ChildNode

A hierarchically organized container for World and SystemStructure of an orbital object representing a world. A world may be:

• the gravitational center (a.k.a. parent) of an orbital system
• the descendant (a.k.a. child) of an orbital system

SystemNode contains methods for acquiring the parent and children of this system.

Version:

$Revision: 1.1.1.1 $

Author:

Rex Melton

See Also:

SimNode, World, Structure, SystemStructure

Constructor Summary

SystemNode(World world)
Construct an instance initialized with the primary world of this system.

SystemNode(World world, SimNode parent)
Construct an instance initialized with the primary world of this system.

Method Summary

void	addChild(ChildNode node) Add a new descendant ChildNode to this system's list of orbital objects.
ChildNode	getChild(java.lang.String id) Return the descendant ChildNode.
java.util.List	getChildren() Return the List of the descendant ChildNodes.
java.lang.String	getID() Return the identifier of this SystemNode
SimNode	getParent() Return the parent SimNode of this system.
SatelliteNode	getSatelliteNode(java.lang.String id) Return the SatelliteNode matching the search parameters.
java.util.List	getSatelliteNodes() Return the List of this system's SatelliteNodes.
Structure	getStructure() Return the Structure for the primary world of this system.
SystemNode	getSystemNode(java.lang.String id) Return the descendant SystemNode.
java.util.List	getSystemNodes() Return the List of the descendant SystemNodes.
SystemStructure	getSystemStructure() Return the SystemStructure for the primary world of this system.
World	getWorld() Return the properties for the primary world of this system.
boolean	hasChildren() Return a flag indicating whether this node has children
void	removeChild(ChildNode node) Remove an existing descendant ChildNode from this system's list of orbital objects.
void	setSystemStructure(SystemStructure structure) Set the SystemStructure for the primary world of this system.
java.lang.String	toString() Return the String identifier of this SystemNode

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemNode

public SystemNode(World world)

Construct an instance initialized with the primary world of this system.

Parameters:

world - the properties for the primary world of this system.

SystemNode

public SystemNode(World world,
                  SimNode parent)

Construct an instance initialized with the primary world of this system.

Parameters:

world - the properties for the primary world of this system.

parent - the parent node for this system.

Method Detail

getID

public java.lang.String getID()

Return the identifier of this SystemNode

Specified by:

getID in interface SimNode

Returns:

the identifier of this SystemNode

getStructure

public Structure getStructure()

Return the Structure for the primary world of this system.

Specified by:

getStructure in interface SimNode

Returns:

the Structure for the primary world of this system.

getParent

public SimNode getParent()

Return the parent SimNode of this system.

Specified by:

getParent in interface ChildNode

Returns:

the parent SimNode of this system.

addChild

public void addChild(ChildNode node)

Add a new descendant ChildNode to this system's list of orbital objects.

Specified by:

addChild in interface ParentNode

Parameters:

node - the new descendant SystemNode

removeChild

public void removeChild(ChildNode node)

Remove an existing descendant ChildNode from this system's list of orbital objects.

Specified by:

removeChild in interface ParentNode

Parameters:

node - the descendant ChildNode to remove

getChild

public ChildNode getChild(java.lang.String id)

Return the descendant ChildNode.

Specified by:

getChild in interface ParentNode

Parameters:

id - the identifier of the descendant ChildNode to return.

Returns:

the descendant ChildNode

getChildren

public java.util.List getChildren()

Return the List of the descendant ChildNodes. If no descendants are defined, null will be returned.

Specified by:

getChildren in interface ParentNode

Returns:

the List of descendant SystemNodes

hasChildren

public boolean hasChildren()

Return a flag indicating whether this node has children

Specified by:

hasChildren in interface ParentNode

Returns:

true if this node has children, false if not.

getWorld

public World getWorld()

Return the properties for the primary world of this system.

Returns:

the properties for the primary world of this system.

getSystemStructure

public SystemStructure getSystemStructure()

Return the SystemStructure for the primary world of this system.

Returns:

the SystemStructure for the primary world of this system.

setSystemStructure

public void setSystemStructure(SystemStructure structure)

Set the SystemStructure for the primary world of this system.

Parameters:

structure - SystemStructure for the primary world of this system.

getSystemNode

public SystemNode getSystemNode(java.lang.String id)

Return the descendant SystemNode.

Parameters:

id - the identifier of the descendant SystemNode to return.

Returns:

the descendant SystemNode

getSystemNodes

public java.util.List getSystemNodes()

Return the List of the descendant SystemNodes. If no descendant systems are defined, null will be returned. The returned list SHOULD NOT be changed by the application.

Returns:

the List of descendant SystemNodes

getSatelliteNode

public SatelliteNode getSatelliteNode(java.lang.String id)

Return the SatelliteNode matching the search parameters. If none is found, null will be returned.

Parameters:

id - the unique identifier of the satellite

Returns:

the SatelliteNode

getSatelliteNodes

public java.util.List getSatelliteNodes()

Return the List of this system's SatelliteNodes. If none are currently defined, null will be returned.

Returns:

the List of the system's SatelliteNodes

toString

public java.lang.String toString()

Return the String identifier of this SystemNode

Returns:

the String identifier of this SystemNode