org.jeospace.designation
Class ReferenceFrameFactory

java.lang.Object
  org.jeospace.designation.ReferenceFrameFactory

public class ReferenceFrameFactory

extends java.lang.Object

Factory for producing ReferenceFrames. Instantiation of concrete instances is consolidated in this factory to ensure that only a single instance of a particular reference frame object is produced and that comparisons of the instantiated objects may be performed by reference.

Version:

$Revision: 1.1.1.1 $

Author:

Rex Melton

Constructor Summary

protected

ReferenceFrameFactory() Protected constructor

Method Summary

static ReferenceFrameFactory	getInstance() Return the factory instance
PlatformReferenceFrame	getPlatform(java.lang.String systemID, java.lang.String frameID, java.lang.String platformID) Return a PlatformReferenceFrame cooresponding to the argument identifiers.
RootReferenceFrame	getRoot(java.lang.String rootID) Return a RootReferenceFrame for the argument identifier.
SystemReferenceFrame	getSystem(java.lang.String systemID, java.lang.String frameID) Return a SystemReferenceFrame cooresponding to the argument identifiers.
SystemReferenceFrame	getSystem(java.lang.String systemID, SystemFrame frame) Return a SystemReferenceFrame cooresponding to the argument identifiers.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceFrameFactory

protected ReferenceFrameFactory()

Protected constructor

Method Detail

getInstance

public static ReferenceFrameFactory getInstance()

Return the factory instance

Returns:

the factory instance

getRoot

public RootReferenceFrame getRoot(java.lang.String rootID)

Return a RootReferenceFrame for the argument identifier. If the identifier is null, null will be returned.

Parameters:

rootID - The root identifier

Returns:

a RootReferenceFrame for the argument identifier

getSystem

public SystemReferenceFrame getSystem(java.lang.String systemID,
                                      SystemFrame frame)

Return a SystemReferenceFrame cooresponding to the argument identifiers. If either argument identifier is null, null will be returned.

Parameters:

systemID - The system identifier

frame - The SystemFrame identifier

Returns:

a SystemReferenceFrame cooresponding to the argument identifiers.

getSystem

public SystemReferenceFrame getSystem(java.lang.String systemID,
                                      java.lang.String frameID)

Return a SystemReferenceFrame cooresponding to the argument identifiers. If either argument identifier is null, null will be returned.

Parameters:

systemID - The system identifier

frameID - The system frame identifier

Returns:

a SystemReferenceFrame cooresponding to the argument identifiers.

getPlatform

public PlatformReferenceFrame getPlatform(java.lang.String systemID,
                                          java.lang.String frameID,
                                          java.lang.String platformID)

Return a PlatformReferenceFrame cooresponding to the argument identifiers. If any argument identifier is null, null will be returned.

Parameters:

systemID - The system identifier

frameID - The system frame identifier

platformID - The platform frame identifier

Returns:

a PlatformReferenceFrame cooresponding to the argument identifiers.