SporeTarget

java.lang.Object
- util.PropertyContainer
- - util.PropertyResources
  - - target.AbstractTarget
    - - stella.xml.SporeTarget

All Implemented Interfaces:

Serializable, Cloneable, TargetDefinition, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

ParsedTarget
```
public class SporeTarget
extends AbstractTarget
implements Serializable
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SporeTarget.Constraint
Defines one constraint for target selection.

static class SporeTarget.Dump
- Nested classes/interfaces inherited from class target.AbstractTarget
  AbstractTarget.Aim, AbstractTarget.Allocation, AbstractTarget.ConstraintAdapter, AbstractTarget.FitsEntry, AbstractTarget.PickAdapter, AbstractTarget.Setup, AbstractTarget.TargetComparator
- Nested classes/interfaces inherited from class util.PropertyResources
  PropertyResources.Load, PropertyResources.URLResource

Nested Classes
Modifier and Type	Class and Description
`static class`	`SporeTarget.Constraint` Defines one constraint for target selection.
`static class`	`SporeTarget.Dump`

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) Map<String,List<String>>`	`aborting` Errors for immediate abort.
`(package private) Map<String,Object>`	`astronomy` The map of astronomical objects found in the target.
`(package private) Map<String,List<String>>`	`blocking` Errors blocking the target.
`(package private) ExpressionEvaluator`	`canrate` The expression to fulfill for a rating to take place.
`(package private) List<Appointable.Constraint>`	`constraints` A list of constraints.
`(package private) Set<String>`	`daughternames`
`(package private) boolean`	`dbread` For converting to xml, this field is true if target comes from db.
`(package private) boolean`	`dbwrite` If true, task database is updated on execution add.
`static String`	`DEFIMAGETYPE` The default parameter name giving the remaining night-time.
`(package private) Map<String,List<String>>`	`delaying` Errors delaying the target.
`(package private) Map<String,Integer>`	`delaymax` The maximum number of delayed retries allowed.
`(package private) Map<String,Long>`	`delaytime` The delay time until target is re-enabled.
`(package private) String`	`description` The abstract of the observing program.
`(package private) ExpressionEvaluator`	`duration` The duration of the observation, if explicetly given.
`(package private) List<javax.mail.Address>`	`email` A list of e-mail addresses.
`(package private) boolean`	`enabled` True if target is enabled.
`(package private) Map<String,Object>`	`fitsheader` The map of fits-header entries found.
`(package private) List<Meriting>`	`gains` The gains of the target.
`(package private) boolean`	`hdbread` For converting to xml, this field is true if history comes from db.
`(package private) boolean`	`hdbwrite` If true, history database is updated on execution add.
`(package private) List<HistoryAware.Pick>`	`history` The pick history of the target.
`(package private) int`	`historymax` The maximum size of the history list.
`(package private) boolean`	`historyover` If true, program is completed.
`(package private) Map<String,List<String>>`	`ignoring` Errors ignored.
`(package private) String`	`imagetype` The image type.
`(package private) UserProfile.Affil`	`institution` The institution the user belongs to (aka the time requestor).
`static String`	`KEY_IMAGETYPE` The key to the parameter name of the remaining night-time.
`(package private) Set<UserProfile.Notifies>`	`notify` A list of notification triggers.
`(package private) String`	`proposal` The proposal id.
`(package private) List<Appointable.Constraint>`	`rate` The list of rating constraints, if given.
`(package private) ExpressionEvaluator`	`requires` The condition required for target selection.
`(package private) Map<String,List<String>>`	`retrying` Errors sparking an immediate retry.
`(package private) Map<String,Integer>`	`retrymax` The maximum number of immediate retries allowed.
`private static long`	`serialVersionUID`
`(package private) Map<String,Object>`	`setup` The map of setups found in the target.
`(package private) Date`	`submitted` If known, the submission date.
`(package private) String`	`successorname` The successor target.
`(package private) File`	`targetfile` The target file when stored as an xml-file.
`(package private) String`	`targetname` The target name.
`(package private) String`	`targettype` The target type.
`(package private) List<String>`	`team` The cois user.
`(package private) List<Meriting>`	`timeslots` The time slot(s) of the target.
`(package private) String`	`title` The abstract of the observing program.
`(package private) String`	`user` The target user.

Fields inherited from class target.AbstractTarget
expo

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.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SporeTarget()` A no-arg constructor is needed for object serialization.
`protected`	`SporeTarget(Map<String,String> prop)` Constructor chaining.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addDaughterName(String dau)` Add a daughter to this target specifying only the name.
`void`	`clearHistory()` Deletes the entire history.
`protected Map<String,List<String>>`	`getAbortErrors()` Returns an array of mappings of exception targets to error names.
`protected Map<String,Object>`	`getAstronomicalData()` Returns all stars in this target.
`protected Map<String,List<String>>`	`getBlockErrors()` Returns an array of mappings of exception targets to error names.
`List<Appointable.Constraint>`	`getConstraints()` Returns the list of `SporeTarget.Constraint` objects this target is subject to.
`protected boolean`	`getDatabaseRead()` Returns the history database-access boolean.
`boolean`	`getDatabaseWrite()` Returns the history database-access boolean.
`protected Set<String>`	`getDaughterNames()` Returns the list of daughter targets or null if this target does not have any.
`protected Map<String,List<String>>`	`getDelayErrors()` Returns an array of mappings of exception targets to error names.
`protected Map<String,Integer>`	`getDelays()` Returns the mapping to the maximum number of retries, delays and the delay time.
`protected Map<String,Long>`	`getDelayTimes()` Returns the mapping to the maximum number of retries, delays and the delay time.
`String`	`getDescription()` Returns the observing program description.
`String`	`getDescriptionID()` Returns the observing program id.
`protected ExpressionEvaluator`	`getDuration()` Returns the expression that is used to calculate the execution time of the target.
`List<javax.mail.Address>`	`getEmailAddresses()` Returns the e-mail addresses linked to this target.
`List<HistoryAware.Pick>`	`getEntireHistory()` Returns the entire history the target is aware of.
`HistoryAware.Pick`	`getFailure(int index)` Returns the date of the failed pick with the given index.
`int`	`getFailureCount()` Returns the number of failed observations this target had.
`File`	`getFile()` Returns the file name stored in the DOM.
`HistoryAware.Pick`	`getFirstFailure()` Return the date of the first failed observation.
`HistoryAware.Pick`	`getFirstPick()` Returns the first pick.
`HistoryAware.Pick`	`getFirstSuccess()` Returns the pick of the first successful observation.
`protected Map<String,Object>`	`getFitsHeader()` Returns all fits header in this target.
`protected List<Meriting>`	`getGainMerits()` Returns the timeslot and gain merits as an array.
`boolean`	`getHistoryDatabaseRead()` Returns the history database-access boolean.
`boolean`	`getHistoryDatabaseWrite()` Returns the history database-access boolean.
`protected int`	`getHistoryMax()` Returns the maximum size of the history.
`protected Map<String,List<String>>`	`getIgnoreErrors()` Returns an array of mappings of exception targets to error names.
`Object`	`getImageType()` Returns the image type or the default value, if it was not set.
`UserProfile.Affil`	`getInstitution()` Returns the institution the target time should account to.
`HistoryAware.Pick`	`getLastFailure()` Returns the date of the last failed observation.
`HistoryAware.Pick`	`getLastPick()` Returns the last pick.
`HistoryAware.Pick`	`getLastSuccess()` Returns the pick of the last successful observation.
`String`	`getName()` Returns the Target description of the object.
`Set<UserProfile.Notifies>`	`getNotify()` Return the list of notification as tag-names.
`HistoryAware.Pick`	`getPick(int nr)` Returns the specified pick.
`int`	`getPickCount()` Returns the number of picks in the history.
`protected List<Appointable.Constraint>`	`getRateConstraints()` Returns the list of `SporeTarget.Constraint` objects this target is subject to at rating.
`protected ExpressionEvaluator`	`getRateRequires()` Returns the expression that must evaluate to true for this target to get evaluated after an observation.
`protected ExpressionEvaluator`	`getRequires()` Returns the expression that must evaluate to true for this target to get picked.
`protected Map<String,Integer>`	`getRetries()` Returns the mapping to the maximum number of retries, delays and the delay time.
`protected Map<String,List<String>>`	`getRetryErrors()` Returns an array of mappings of exception targets to error names.
`Map<String,Object>`	`getSetups()` Returns the list of `Setup` objects of this target.
`Date`	`getSubmitted()` The date the target was originally submitted.
`HistoryAware.Pick`	`getSuccess(int index)` Returns the date of the succesful pick with the given index.
`int`	`getSuccessCount()` Returns the number of succesful observations this target had.
`protected String`	`getSuccessorName()` Sets this target's successor.
`URL`	`getTargetResource()` Return the file name stored in the DOM as an url-rsource.
`Object`	`getTargetSpecific(Object idobj)` Returns a special object of target-specific definitions.
`List<String>`	`getTeam()` Returns the list of coi or null if none given.
`protected List<Meriting>`	`getTimeslotMerits()` Returns the timeslot and gain merits as an array.
`String`	`getTitle()` Returns the observing program description.
`Object`	`getType()` Returns the string value of the `DTDConstants.TARGETTYPE` attribute.
`String`	`getUser()` Returns the target user.
`boolean`	`isEnabled()` Test the `access` attribute of the Object element in the given target-`DOM`.
`boolean`	`isProgramCompleted()` Returns true if the observing program on this target is over.
`private void`	`readObject(ObjectInputStream stream)` On deserialization, first read the hidden object definitions, then the properties of this target.
`protected void`	`setAstronomicalData(Map<String,Object> astro)` Sets the map of astronomical targets.
`protected void`	`setConstraints(List<Appointable.Constraint> prevent)` Sets the target constraints.
`protected void`	`setDatabaseAccess(boolean read, boolean write)` Sets the database-access flags for read and write.
`protected void`	`setDelayAndRetry(Map<String,Integer> delmax, Map<String,Long> delfor, Map<String,Integer> retmax)` Sets the maximum number of retries, the maximum number of delays and the delay time.
`protected void`	`setDescription(String program)` Sets the observing program description.
`protected void`	`setDuration(ExpressionEvaluator durcalc)` Sets the estimated duration of target execution.
`protected void`	`setEmailAddresses(List<javax.mail.Address> address)` Sets the list of e-mail addresses.
`void`	`setEnabled(boolean to)` Sets the access attribute to `enabled`.
`protected void`	`setErrors(Map<String,List<String>> blockmap, Map<String,List<String>> delaymap, Map<String,List<String>> abortmap, Map<String,List<String>> retrymap, Map<String,List<String>> ignoremap)` Sets the error maps.
`protected void`	`setFitsHeader(Map<String,Object> fits)` Sets the map of fits headers.
`protected void`	`setHistory(List<HistoryAware.Pick> past, int max)` Sets the target history and its maximum size.
`void`	`setHistoryDatabaseAccess(boolean read, boolean write)` Sets the history database-access flags for read and write.
`protected void`	`setImageType(String itype)` Sets the image type.
`protected void`	`setInstitution(UserProfile.Affil who)` Sets the target institute.
`protected void`	`setMerits(List<Meriting> multiplicative, List<Meriting> additive)` Sets the target merits.
`protected void`	`setNotify(Set<UserProfile.Notifies> triggers)` Sets the list of notification triggers.
`void`	`setProgramCompleted(boolean over)` Returns true if the observing program on this target is over.
`protected void`	`setRateConstraints(List<Appointable.Constraint> prevent)` Sets the target constraints.
`protected void`	`setRateRequires(ExpressionEvaluator necessary)` Sets the boolean condition that is check for target availability prior to any other parameter constraints.
`protected void`	`setRequires(ExpressionEvaluator necessary)` Sets the boolean condition that is check for target availability prior to any other parameter constraints.
`protected void`	`setSetups(Map<String,Object> instrumentation)` Sets the map of setups.
`void`	`setSubmitted(Date submit)` Sets the target submission date.
`protected void`	`setSuccessorName(String suck)` Sets this target's successor name.
`void`	`setTargetFile(File xml)` Sets the target xml-file.
`void`	`setTargetName(String name, String id)` Sets the target name.
`protected void`	`setTargetType(String type)` Sets the target type.
`protected void`	`setTeam(List<String> who)` Sets the target cois.
`protected void`	`setTitle(String program)` Sets the observing program title.
`protected void`	`setUser(String who)` Sets the target user.
`long`	`sumExposures()`
`private void`	`writeObject(ObjectOutputStream stream)` We customize object serialization.

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, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - KEY_IMAGETYPE
```
public static final String KEY_IMAGETYPE
```
    The key to the parameter name of the remaining night-time.
    
    See Also:
    
    Constant Field Values
  - DEFIMAGETYPE
```
public static final String DEFIMAGETYPE
```
    The default parameter name giving the remaining night-time.
    
    See Also:
    
    Constant Field Values
  - targettype
```
String targettype
```
    The target type. Responsible for observation sequence.
  - submitted
```
Date submitted
```
    If known, the submission date. Otherwise Date(0).
  - imagetype
```
String imagetype
```
    The image type. If undefined, use #KEY_IMAGETPYE.
  - targetname
```
String targetname
```
    The target name.
  - proposal
```
String proposal
```
    The proposal id.
  - title
```
String title
```
    The abstract of the observing program.
  - description
```
String description
```
    The abstract of the observing program.
  - targetfile
```
File targetfile
```
    The target file when stored as an xml-file.
  - user
```
String user
```
    The target user.
  - team
```
List<String> team
```
    The cois user.
  - email
```
List<javax.mail.Address> email
```
    A list of e-mail addresses.
  - notify
```
Set<UserProfile.Notifies> notify
```
    A list of notification triggers.
  - institution
```
UserProfile.Affil institution
```
    The institution the user belongs to (aka the time requestor).
  - requires
```
ExpressionEvaluator requires
```
    The condition required for target selection.
  - constraints
```
List<Appointable.Constraint> constraints
```
    A list of constraints.
  - gains
```
List<Meriting> gains
```
    The gains of the target. Initialized at dom-setting.
  - timeslots
```
List<Meriting> timeslots
```
    The time slot(s) of the target. Initialized at dom-setting.
  - duration
```
ExpressionEvaluator duration
```
    The duration of the observation, if explicetly given.
  - successorname
```
String successorname
```
    The successor target. Set on construct from xml-file.
  - daughternames
```
Set<String> daughternames
```
  - setup
```
Map<String,Object> setup
```
    The map of setups found in the target.
  - astronomy
```
Map<String,Object> astronomy
```
    The map of astronomical objects found in the target.
  - fitsheader
```
Map<String,Object> fitsheader
```
    The map of fits-header entries found.
  - blocking
```
Map<String,List<String>> blocking
```
    Errors blocking the target. Mapping to this, daughter, and successor.
  - delaying
```
Map<String,List<String>> delaying
```
    Errors delaying the target. Mapping to this, daughter, and successor.
  - delaymax
```
Map<String,Integer> delaymax
```
    The maximum number of delayed retries allowed. Maps to this etc.
  - delaytime
```
Map<String,Long> delaytime
```
    The delay time until target is re-enabled.
  - retrying
```
Map<String,List<String>> retrying
```
    Errors sparking an immediate retry.
  - retrymax
```
Map<String,Integer> retrymax
```
    The maximum number of immediate retries allowed.
  - ignoring
```
Map<String,List<String>> ignoring
```
    Errors ignored. Mapping to this, daughter, and successor.
  - aborting
```
Map<String,List<String>> aborting
```
    Errors for immediate abort. Mapping to this, daughter, and successor.
  - canrate
```
ExpressionEvaluator canrate
```
    The expression to fulfill for a rating to take place.
  - rate
```
List<Appointable.Constraint> rate
```
    The list of rating constraints, if given.
  - historymax
```
int historymax
```
    The maximum size of the history list.
  - enabled
```
boolean enabled
```
    True if target is enabled. Also used in delays.
  - history
```
List<HistoryAware.Pick> history
```
    The pick history of the target. Maximum size given in xml-file.
  - historyover
```
boolean historyover
```
    If true, program is completed. Target will never get picked again.
  - dbwrite
```
boolean dbwrite
```
    If true, task database is updated on execution add.
  - dbread
```
boolean dbread
```
    For converting to xml, this field is true if target comes from db.
  - hdbwrite
```
boolean hdbwrite
```
    If true, history database is updated on execution add.
  - hdbread
```
boolean hdbread
```
    For converting to xml, this field is true if history comes from db.
- Constructor Detail
  - SporeTarget
```
protected SporeTarget()
```
    A no-arg constructor is needed for object serialization.
  - SporeTarget
```
protected SporeTarget(Map<String,String> prop)
```
    Constructor chaining.
- Method Detail
  - writeObject
```
private void writeObject(ObjectOutputStream stream)
                  throws IOException
```
    We customize object serialization. We serialize out properties at the end of the file, as otherwise only the empty properties are restored via the property container default constructor.
    
    Throws:
    
    IOException
  - readObject
```
private void readObject(ObjectInputStream stream)
                 throws IOException,
                        ClassNotFoundException
```
    On deserialization, first read the hidden object definitions, then the properties of this target. The target properties are then set using PropertyContainer.setProperties(java.util.Map<java.lang.String, java.lang.Object>).
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - getName
```
public String getName()
```
    Returns the Target description of the object. Normally an easy-to-read name.
    
    Specified by:
    
    getName in interface TargetDefinition
  - getImageType
```
public Object getImageType()
```
    Returns the image type or the default value, if it was not set.
    
    Specified by:
    
    getImageType in interface TargetDefinition
  - getTitle
```
public String getTitle()
```
    Returns the observing program description.
    
    Specified by:
    
    getTitle in interface TargetDefinition
  - getDescription
```
public String getDescription()
```
    Returns the observing program description.
    
    Specified by:
    
    getDescription in interface TargetDefinition
  - getDescriptionID
```
public String getDescriptionID()
```
    Returns the observing program id. Can be used for a proposal identifier
    
    Specified by:
    
    getDescriptionID in interface TargetDefinition
  - getFile
```
public File getFile()
```
    Returns the file name stored in the DOM. This is an optional parameter. If it is not present, the name of the target is returned.
  - getUser
```
public String getUser()
```
    Returns the target user. This user identifies the principal investigator. Used for time shares if no getInstitution() is defined.
    
    Specified by:
    
    getUser in interface TargetDefinition
  - getTeam
```
public List<String> getTeam()
```
    Returns the list of coi or null if none given.
    
    Specified by:
    
    getTeam in interface TargetDefinition
  - getEmailAddresses
```
public List<javax.mail.Address> getEmailAddresses()
```
    Returns the e-mail addresses linked to this target.
    
    Specified by:
    
    getEmailAddresses in interface TargetDefinition
  - getNotify
```
public Set<UserProfile.Notifies> getNotify()
```
    Return the list of notification as tag-names.
  - getInstitution
```
public UserProfile.Affil getInstitution()
```
    Returns the institution the target time should account to. If not specified, the getUser(), which is a required element should be used for time allocation.
    
    Specified by:
    
    getInstitution in interface TargetDefinition
  - getType
```
public Object getType()
```
    Returns the string value of the DTDConstants.TARGETTYPE attribute. This is a required attribute to the object tag and states the sequence type to load for this target.
    
    Specified by:
    
    getType in interface TargetDefinition
  - setSuccessorName
```
protected void setSuccessorName(String suck)
```
    Sets this target's successor name. The actual target is assigned once all targets have been collected in a target provider and #resolveChildren has been called.
  - getSuccessorName
```
protected String getSuccessorName()
```
    Sets this target's successor.
  - getDaughterNames
```
protected Set<String> getDaughterNames()
```
    Returns the list of daughter targets or null if this target does not have any.
  - addDaughterName
```
protected void addDaughterName(String dau)
```
    Add a daughter to this target specifying only the name.
  - setEnabled
```
public void setEnabled(boolean to)
```
    Sets the access attribute to enabled.
  - setTargetType
```
protected void setTargetType(String type)
```
    Sets the target type. Used on initial parsing.
  - setSubmitted
```
public void setSubmitted(Date submit)
```
    Sets the target submission date. Used on initial parsing.
  - setTargetName
```
public void setTargetName(String name,
                          String id)
```
    Sets the target name. Used on initial parsing.
  - setImageType
```
protected void setImageType(String itype)
```
    Sets the image type. Used on initial parsing, has default value.
  - setTargetFile
```
public void setTargetFile(File xml)
```
    Sets the target xml-file. Used on initial parsing.
  - setUser
```
protected void setUser(String who)
```
    Sets the target user. Used on initial parsing.
  - setTeam
```
protected void setTeam(List<String> who)
```
    Sets the target cois. Used on initial parsing.
  - setEmailAddresses
```
protected void setEmailAddresses(List<javax.mail.Address> address)
```
    Sets the list of e-mail addresses. Used on initial parsing.
  - setNotify
```
protected void setNotify(Set<UserProfile.Notifies> triggers)
```
    Sets the list of notification triggers. Used on initial parsing.
  - setTitle
```
protected void setTitle(String program)
```
    Sets the observing program title. Used on initial parsing.
  - setDescription
```
protected void setDescription(String program)
```
    Sets the observing program description. Used on initial parsing.
  - setInstitution
```
protected void setInstitution(UserProfile.Affil who)
```
    Sets the target institute. Used on initial parsing.
  - getHistoryMax
```
protected int getHistoryMax()
```
    Returns the maximum size of the history. Was initialized on initial parsing.
  - setErrors
```
protected void setErrors(Map<String,List<String>> blockmap,
                         Map<String,List<String>> delaymap,
                         Map<String,List<String>> abortmap,
                         Map<String,List<String>> retrymap,
                         Map<String,List<String>> ignoremap)
```
    Sets the error maps. Used on initial parsing.
  - getBlockErrors
```
protected Map<String,List<String>> getBlockErrors()
```
    Returns an array of mappings of exception targets to error names. Exception targets are strings like 'this', 'successor', or 'daughter'. The errors returned are the blocking errors on index zero, the delaying errors on index one, the aborting erros on index two, the retry-errors on index three, and the ignorable errors on index four.
    
    Returns:
    
    Array of error-map, blocking, delaying, aborting, retrying, and ignoring.
  - getDelayErrors
```
protected Map<String,List<String>> getDelayErrors()
```
    Returns an array of mappings of exception targets to error names. Exception targets are strings like 'this', 'successor', or 'daughter'. The errors returned are the blocking errors on index zero, the delaying errors on index one, the aborting erros on index two, the retry-errors on index three, and the ignorable errors on index four.
    
    Returns:
    
    Array of error-map, blocking, delaying, aborting, retrying, and ignoring.
  - getAbortErrors
```
protected Map<String,List<String>> getAbortErrors()
```
    Returns an array of mappings of exception targets to error names. Exception targets are strings like 'this', 'successor', or 'daughter'. The errors returned are the blocking errors on index zero, the delaying errors on index one, the aborting erros on index two, the retry-errors on index three, and the ignorable errors on index four.
    
    Returns:
    
    Array of error-map, blocking, delaying, aborting, retrying, and ignoring.
  - getRetryErrors
```
protected Map<String,List<String>> getRetryErrors()
```
    Returns an array of mappings of exception targets to error names. Exception targets are strings like 'this', 'successor', or 'daughter'. The errors returned are the blocking errors on index zero, the delaying errors on index one, the aborting erros on index two, the retry-errors on index three, and the ignorable errors on index four.
    
    Returns:
    
    Array of error-map, blocking, delaying, aborting, retrying, and ignoring.
  - getIgnoreErrors
```
protected Map<String,List<String>> getIgnoreErrors()
```
    Returns an array of mappings of exception targets to error names. Exception targets are strings like 'this', 'successor', or 'daughter'. The errors returned are the blocking errors on index zero, the delaying errors on index one, the aborting erros on index two, the retry-errors on index three, and the ignorable errors on index four.
    
    Returns:
    
    Array of error-map, blocking, delaying, aborting, retrying, and ignoring.
  - setDelayAndRetry
```
protected void setDelayAndRetry(Map<String,Integer> delmax,
                                Map<String,Long> delfor,
                                Map<String,Integer> retmax)
```
    Sets the maximum number of retries, the maximum number of delays and the delay time. All are maps of the target this exception applies to and the specific numer, e.g. a map from this to 3. Used on initial parsing.
    
    Parameters:
    
    delmax - Mapping of exception target to maximum delays.
    
    delfor - Mapping of exception target to delay times.
    
    retmax - Mapping of exception target to maximum retries.
  - getDelays
```
protected Map<String,Integer> getDelays()
```
    Returns the mapping to the maximum number of retries, delays and the delay time. Used in transforming the parsed target back to a Document. The maps returned are the maximum number of delay in index 0, the delay times in index one and the maximum number of retries in index two.
    
    Returns:
    
    A map array of delaymax, delaytime and retrymax.
  - getDelayTimes
```
protected Map<String,Long> getDelayTimes()
```
    Returns the mapping to the maximum number of retries, delays and the delay time. Used in transforming the parsed target back to a Document. The maps returned are the maximum number of delay in index 0, the delay times in index one and the maximum number of retries in index two.
    
    Returns:
    
    A map array of delaymax, delaytime and retrymax.
  - getRetries
```
protected Map<String,Integer> getRetries()
```
    Returns the mapping to the maximum number of retries, delays and the delay time. Used in transforming the parsed target back to a Document. The maps returned are the maximum number of delay in index 0, the delay times in index one and the maximum number of retries in index two.
    
    Returns:
    
    A map array of delaymax, delaytime and retrymax.
  - setRequires
```
protected void setRequires(ExpressionEvaluator necessary)
```
    Sets the boolean condition that is check for target availability prior to any other parameter constraints. This is an expression that will be evaluated at run-time. Used on initial parsing.
  - getRequires
```
protected ExpressionEvaluator getRequires()
```
    Returns the expression that must evaluate to true for this target to get picked.
  - setConstraints
```
protected void setConstraints(List<Appointable.Constraint> prevent)
```
    Sets the target constraints. Used on initial parsing.
  - getConstraints
```
public List<Appointable.Constraint> getConstraints()
```
    Returns the list of SporeTarget.Constraint objects this target is subject to.
  - setMerits
```
protected void setMerits(List<Meriting> multiplicative,
                         List<Meriting> additive)
```
    Sets the target merits. The merits splits in additive gains and multiplicative timeslots. Used on initial parsing.
  - getTimeslotMerits
```
protected List<Meriting> getTimeslotMerits()
```
    Returns the timeslot and gain merits as an array. First index is the timeslots list, second index is the gains list.
  - getGainMerits
```
protected List<Meriting> getGainMerits()
```
    Returns the timeslot and gain merits as an array. First index is the timeslots list, second index is the gains list.
  - setRateConstraints
```
protected void setRateConstraints(List<Appointable.Constraint> prevent)
```
    Sets the target constraints. Used on initial parsing.
  - getRateConstraints
```
protected List<Appointable.Constraint> getRateConstraints()
```
    Returns the list of SporeTarget.Constraint objects this target is subject to at rating.
  - setRateRequires
```
protected void setRateRequires(ExpressionEvaluator necessary)
```
    Sets the boolean condition that is check for target availability prior to any other parameter constraints. This is an expression that will be evaluated at run-time. Used on initial parsing.
  - getRateRequires
```
protected ExpressionEvaluator getRateRequires()
```
    Returns the expression that must evaluate to true for this target to get evaluated after an observation.
  - setDuration
```
protected void setDuration(ExpressionEvaluator durcalc)
```
    Sets the estimated duration of target execution. This is an expression that will be evaluated at run-time. Used on initial parsing.
  - getDuration
```
protected ExpressionEvaluator getDuration()
```
    Returns the expression that is used to calculate the execution time of the target. May return null.
  - setSetups
```
protected void setSetups(Map<String,Object> instrumentation)
```
    Sets the map of setups. Used on initial parsing.
  - getSetups
```
public Map<String,Object> getSetups()
```
    Returns the list of Setup objects of this target.
  - setAstronomicalData
```
protected void setAstronomicalData(Map<String,Object> astro)
```
    Sets the map of astronomical targets. Used on initial parsing.
  - getAstronomicalData
```
protected Map<String,Object> getAstronomicalData()
```
    Returns all stars in this target.
  - setFitsHeader
```
protected void setFitsHeader(Map<String,Object> fits)
```
    Sets the map of fits headers. Used on initial parsing.
  - getFitsHeader
```
protected Map<String,Object> getFitsHeader()
```
    Returns all fits header in this target.
  - getTargetResource
```
public URL getTargetResource()
```
    Return the file name stored in the DOM as an url-rsource.
    
    Specified by:
    
    getTargetResource in interface TargetDefinition
  - getTargetSpecific
```
public Object getTargetSpecific(Object idobj)
```
    Returns a special object of target-specific definitions. Currently only three elements carry an id. These are:
    - The DTDConstants.SETUP section. The object returned is a Setup instance.
    - The DTDConstants.OBJECT section. The object returned is a AbstractTarget.Aim instance.
    - The DTDConstants.FITSHEADER section. The object returned is a Collection of FitsEntry instances.
    Simple extension could return maps, derived e.g. from a DTDConstants.CONSTANT section.
    Specified by:
    
    getTargetSpecific in interface TargetDefinition
    
    Parameters:
    
    idobj - An identifier, most likely a string.
    
    Returns:
    
    Null, if the reference is not found.
  - setDatabaseAccess
```
protected void setDatabaseAccess(boolean read,
                                 boolean write)
```
    Sets the database-access flags for read and write.
  - setHistoryDatabaseAccess
```
public void setHistoryDatabaseAccess(boolean read,
                                     boolean write)
```
    Sets the history database-access flags for read and write.
  - setHistory
```
protected void setHistory(List<HistoryAware.Pick> past,
                          int max)
```
    Sets the target history and its maximum size. Used on initial parsing.
    
    Parameters:
    
    past - The pick history of the target, good and bad picks.
    
    max - The maximum size of the history list.
    
    db - The history-db access boolean.
  - setProgramCompleted
```
public void setProgramCompleted(boolean over)
```
    Returns true if the observing program on this target is over. This method differs from the Appointable.isProgramOver(globals.GlobalGrouping) method in the sense that a program completion is not bound to current observing circumstances, thus the normal action is that an appointable target whose program is over, may set this flag for fast replies.
  - getDatabaseWrite
```
public boolean getDatabaseWrite()
```
    Returns the history database-access boolean. This string is initialized during xml-parsing.
  - getDatabaseRead
```
protected boolean getDatabaseRead()
```
    Returns the history database-access boolean. This string is initialized during xml-parsing.
  - getHistoryDatabaseWrite
```
public boolean getHistoryDatabaseWrite()
```
    Returns the history database-access boolean. This string is initialized during xml-parsing.
  - getHistoryDatabaseRead
```
public boolean getHistoryDatabaseRead()
```
    Returns the history database-access boolean. This string is initialized during xml-parsing.
  - isEnabled
```
public boolean isEnabled()
```
    Test the access attribute of the Object element in the given target-DOM. Returns true if this attribute is equal to enabled.
  - getSubmitted
```
public Date getSubmitted()
```
    The date the target was originally submitted.
  - isProgramCompleted
```
public boolean isProgramCompleted()
```
    Returns true if the observing program on this target is over. This method differs from the Appointable.isProgramOver(globals.GlobalGrouping) method in the sense that a program completion is not bound to current observing circumstances, thus the normal action is that an appointable target whose program is over, may set this flag for fast replies.
  - getEntireHistory
```
public List<HistoryAware.Pick> getEntireHistory()
```
    Returns the entire history the target is aware of. This implementation always retains the first successful and unsuccessful pick (at the list head), but it might erease later picks if the maximum number of picks is exceeded.
  - clearHistory
```
public void clearHistory()
```
    Deletes the entire history.
  - getPickCount
```
public int getPickCount()
```
    Returns the number of picks in the history.
  - getPick
```
public HistoryAware.Pick getPick(int nr)
```
    Returns the specified pick. The index is not the index in the list, but specifies how many recent pick should be skipped.
  - getFirstPick
```
public HistoryAware.Pick getFirstPick()
```
    Returns the first pick. This is the first entry, regardless if successful or failure.
  - getLastPick
```
public HistoryAware.Pick getLastPick()
```
    Returns the last pick. This is the most recent entry, regardless if successful or failure.
  - getSuccessCount
```
public int getSuccessCount()
```
    Returns the number of succesful observations this target had. If no succesful observations had been made, zero is returned.
    Implementation note: This means that the entire history is traversed which may lead to certain delays.
  - getFailureCount
```
public int getFailureCount()
```
    Returns the number of failed observations this target had.
  - getFirstSuccess
```
public HistoryAware.Pick getFirstSuccess()
```
    Returns the pick of the first successful observation. If no succesful observation has been made, null is returned.
  - getLastSuccess
```
public HistoryAware.Pick getLastSuccess()
```
    Returns the pick of the last successful observation. If no successful observation has been made, null is returned.
  - getSuccess
```
public HistoryAware.Pick getSuccess(int index)
```
    Returns the date of the succesful pick with the given index. If this index is invalid (i.e. less succesful observations made than required), null is returned.
  - getFirstFailure
```
public HistoryAware.Pick getFirstFailure()
```
    Return the date of the first failed observation.
    
    Returns:
    
    null if no failed observations exist.
  - getLastFailure
```
public HistoryAware.Pick getLastFailure()
```
    Returns the date of the last failed observation.
    
    Returns:
    
    null if no failed observations exist.
  - getFailure
```
public HistoryAware.Pick getFailure(int index)
```
    Returns the date of the failed pick with the given index. If this index is invalid (i.e. less observations failed than required), null is returned.
  - sumExposures
```
public long sumExposures()
```

Class SporeTarget

Nested Class Summary

Nested classes/interfaces inherited from class target.AbstractTarget

Nested classes/interfaces inherited from class util.PropertyResources

Field Summary

Fields inherited from class target.AbstractTarget

Fields inherited from class util.PropertyResources

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.ResourceSupplying

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class util.PropertyResources

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Methods inherited from interface util.PropertySupplying

Field Detail

serialVersionUID

KEY_IMAGETYPE

DEFIMAGETYPE

targettype

submitted

imagetype

targetname

proposal

title

description

targetfile

user

team

email

notify

institution

requires

constraints

gains

timeslots

duration

successorname

daughternames

setup

astronomy

fitsheader

blocking

delaying

delaymax

delaytime

retrying

retrymax

ignoring

aborting

canrate

rate

historymax

enabled

history

historyover

dbwrite

dbread

hdbwrite

hdbread

Constructor Detail

SporeTarget

SporeTarget

Method Detail

writeObject

readObject

getName

getImageType

getTitle

getDescription

getDescriptionID

getFile

getUser

getTeam

getEmailAddresses

getNotify

getInstitution

getType

setSuccessorName