globals.parameter

Class AbstractParameter

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

All Implemented Interfaces:

Parameter, Cloneable, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

AbstractCachedParameter, AbstractDatabaseParameter, AbstractRemoteParameter, AbstractTargetParameter, AbstractTrigger, AbstractValue, AdcOffset, AdcPosition, ConstantOffset, DateFromJd, DerotatorCenter, FlatAndScienceGroup, FlatGroup, FlatPointing, FocusQuality, HostAddress, LookupParameter, Moon, ParameterStub, PointingModelOffset, SimpleParameter, SnapshotParameter, TargetList, WatchController, WcsString

public abstract class AbstractParameter
extends PropertyResources
implements Parameter, ExitCleaning, Initializable

An abstract base class for all parameter. Provides a protected constructor out of a Map object and a createParameter(java.util.Map<java.lang.String, java.lang.String>) method to construct a parameter.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_FORMAT The (decimal) formatter used for getFormatted().
static String	KEY_NAME The key to the unique trigger name.
static String	KEY_PRESERVE Convenience parameter for StatePreserving parameters.
static String	UNKNOWN The unknown identifier.

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

Modifier	Constructor and Description
protected	AbstractParameter() Protected empty constructor.
protected	AbstractParameter(Map<String,String> info) Constructs a new trigger.

Method Summary

Modifier and Type	Method and Description
static Parameter	createParameter(Map<String,String> prop) Creates a new trigger instance using the class key found in the properties.
protected static boolean	delivers(Parameter p) Checks if the parameter handed over is non-null and delivers non-null values.
void	exit() If we preserve our state, we do this at exit.
String	getFormatted() A formatted string representation of the value of this paramter.
String	getFormatted(Object myval) Returns the formatted version of a given object.
String	getName() Scans the properties of this global for the KEY_NAME key.
protected File	getPreserveFile(boolean onlyexisting) For state preserving parameters that use a file, this method returns the file the KEY_PRESERVE parameter points to.
String	getString() A string representation of the value of this paramter.
protected String	getString(Object myval) A string representation of the given object.
void	init() Initializes the parameter with its class name.
protected static Map<String,String>	overrideDefaultName(String defname, Map<String,String> prop)
protected static boolean	register(Parameter p, Class<?> as, String name) Checks if the parameter is of the required class type and has the correct name.
protected double	rescanned(String key, String old, String newval) If we have a known format set, we try to parse from that class.
protected void	setName(String newname) Sets the name of the parameter.
String	toString() A string representation of this paramter.

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 globals.Parameter

get, set

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_NAME

public static final String KEY_NAME

The key to the unique trigger name.

See Also:

Constant Field Values

KEY_FORMAT

public static final String KEY_FORMAT

The (decimal) formatter used for getFormatted().

See Also:

Constant Field Values

KEY_PRESERVE

public static final String KEY_PRESERVE

Convenience parameter for StatePreserving parameters.

See Also:

Constant Field Values

UNKNOWN

public static final String UNKNOWN

The unknown identifier.

See Also:

Constant Field Values

Constructor Detail

AbstractParameter

protected AbstractParameter()

Protected empty constructor.

AbstractParameter

protected AbstractParameter(Map<String,String> info)

Constructs a new trigger. All its functionality is stored in the properties. Use of this constructor ensures that the PropertySupplying.KEY_CLASS property is set. To not spoil any default name setting, the name (KEY_NAME) remains unassigned.

Method Detail

overrideDefaultName

protected static Map<String,String> overrideDefaultName(String defname,
                                                        Map<String,String> prop)

createParameter

public static final Parameter createParameter(Map<String,String> prop)

Creates a new trigger instance using the class key found in the properties. If the PropertySupplying.KEY_CLASS property is defined, a new Trigger with the stated class name is created, the supplied properties used as an argument in the constructor.

rescanned

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

If we have a known format set, we try to parse from that class.

Overrides:

rescanned in class PropertyContainer

getName

public String getName()

Scans the properties of this global for the KEY_NAME key. Returns the mapped value or null if undefined.

Specified by:

getName in interface Parameter

setName

protected void setName(String newname)

Sets the name of the parameter.

init

public void init()
          throws InitException

Initializes the parameter with its class name.

Specified by:

init in interface Initializable

Throws:

InitException

exit

public void exit()

If we preserve our state, we do this at exit.

Specified by:

exit in interface ExitCleaning

toString

public String toString()

A string representation of this paramter.

Overrides:

toString in class PropertyContainer

getString

public String getString()

A string representation of the value of this paramter.

Specified by:

getString in interface Parameter

getString

protected String getString(Object myval)

A string representation of the given object.

getFormatted

public String getFormatted()

A formatted string representation of the value of this paramter.

Specified by:

getFormatted in interface Parameter

getFormatted

public String getFormatted(Object myval)

Returns the formatted version of a given object.

getPreserveFile

protected File getPreserveFile(boolean onlyexisting)

For state preserving parameters that use a file, this method returns the file the KEY_PRESERVE parameter points to.

Parameters:

onlyexisting - If true, file must also exist and be readable.

delivers

protected static boolean delivers(Parameter p)

Checks if the parameter handed over is non-null and delivers non-null values.

register

protected static boolean register(Parameter p,
                                  Class<?> as,
                                  String name)

Checks if the parameter is of the required class type and has the correct name.