globals.value

Class Moon

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.value.Moon

All Implemented Interfaces:

Parameter, ParameterDepending, Cloneable, ExitCleaning, Initializable, PropertySupplying, Reloadable, ResourceSupplying

public class Moon
extends AbstractParameter
implements ParameterDepending, Reloadable

A parameter representing the moon for a given time. This parameter combines a sack full of moon data, packed together as a Lunar object, which is this parameter's return value from a call to the get() method. Other parameters (i.e. Values) might peal out a single value from this composite.

This parameter is based on the AstroLib package provided by Mark Huss.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Moon.Test A test class.

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFNAME The name of this global (sidereal).
private static String	DEFTIME The name of this global (sidereal).
static String	KEY_TIME The name of the latitude to use.
private Lunar	moon The lunar instance served by this parameter.
private Value	time The UT time in ms.

Fields inherited from class globals.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors

Constructor and Description
Moon(Map<String,String> prop) Constructs a new moon parameter.

Method Summary

Modifier and Type	Method and Description
Object	get() Returns the astrometric data of the moon.
void	registerParameter(Parameter what) Registers the required additional globals for the sidereal time.
double	rescanned(String key, String old, String newval) As any parameter depending instance we fail if the parameter we depend on is now a different one.
Object	set(Object val) Sets the sidereal time.

Methods inherited from class globals.parameter.AbstractParameter

createParameter, delivers, exit, getFormatted, getFormatted, getName, getPreserveFile, getString, getString, init, overrideDefaultName, register, setName, toString

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, reload, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface util.Reloadable

reload

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Field Detail

KEY_TIME

public static final String KEY_TIME

The name of the latitude to use.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The name of this global (sidereal).

See Also:

Constant Field Values

DEFTIME

private static final String DEFTIME

The name of this global (sidereal).

See Also:

Constant Field Values

time

private Value time

The UT time in ms.

moon

private final Lunar moon

The lunar instance served by this parameter.

Constructor Detail

Moon

public Moon(Map<String,String> prop)

Constructs a new moon parameter. As soon as the time has been registered to this parameter, data retrieval may start.

Method Detail

set

public Object set(Object val)
           throws UnsupportedOperationException

Sets the sidereal time. The sidereal time is a read-only variable, therefore this method throws an UnsupportedOperationException.

Specified by:

set in interface Parameter

Returns:

The previous value of this parameter.

Throws:

UnsupportedOperationException - If this parameter is read-only.

get

public Object get()

Returns the astrometric data of the moon. Note that this method returns null if the globals denoting the time is missing.

Specified by:

get in interface Parameter

registerParameter

public void registerParameter(Parameter what)

Registers the required additional globals for the sidereal time. For this particular object, latitude and UT is required. Note that the argumental global is checked for being of instance types of CurrentTime or Longitude, rather than querrying for the global name.

Specified by:

registerParameter in interface ParameterDepending

rescanned

public double rescanned(String key,
                        String old,
                        String newval)

As any parameter depending instance we fail if the parameter we depend on is now a different one.

Specified by:

rescanned in interface Reloadable

Overrides:

rescanned in class AbstractParameter