Observation (Observation Manager Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.lehmannet.om
Class Observation

java.lang.Object
  de.lehmannet.om.SchemaElement
      de.lehmannet.om.Observation

All Implemented Interfaces:: IObservation, ISchemaElement

public class Observation
extends SchemaElement
implements IObservation
extends SchemaElement
implements IObservation

An IObservation describes an astronomical oberservation of exactly one celestial object (target).
The observation must have one start date to be correct, but does not have to have an end date (as the end date might be lost in older observations).
Inside the XML Schema the Observation is the central entry point for accessing all other kinds of data. (See: XML Schema Doc) Therefore the IObservation provides access to almost all other XML Schema elements.

Since:: 1.0
Author:: doergn@users.sourceforge.net

Field Summary

Fields inherited from interface de.lehmannet.om.IObservation
`XML_ELEMENT_ACCESSORIES, XML_ELEMENT_BEGIN, XML_ELEMENT_END, XML_ELEMENT_FAINTESTSTAR, XML_ELEMENT_IMAGE, XML_ELEMENT_MAGNIFICATION, XML_ELEMENT_OBSERVATION, XML_ELEMENT_SEEING, XML_ELEMENT_SKYQUALITY`

Fields inherited from interface de.lehmannet.om.ISchemaElement
`XML_ELEMENT_ATTRIBUTE_ID`

Constructor Summary
`Observation(java.util.Calendar begin, java.util.Calendar end, float faintestStar, float sq, int seeing, float magnification, ITarget target, IObserver observer, ISite site, IScope scope, java.lang.String accessories, IEyepiece eyepiece, IFilter filter, IImager imager, ILens lens, ISession session, IFinding result)` Constructs a new instance of an Observation.
`Observation(java.util.Calendar begin, java.util.Calendar end, float faintestStar, float sq, int seeing, float magnification, ITarget target, IObserver observer, ISite site, IScope scope, java.lang.String accessories, IEyepiece eyepiece, IFilter filter, IImager imager, ILens lens, ISession session, java.util.List results)` Constructs a new instance of an Observation.
`Observation(java.util.Calendar begin, java.util.Calendar end, ITarget target, IObserver observer, IFinding result)` Constructs a new instance of an Observation.
`Observation(java.util.Calendar begin, java.util.Calendar end, ITarget target, IObserver observer, java.util.List results)` Constructs a new instance of an Observation.
`Observation(java.util.Calendar begin, ITarget target, IObserver observer, IFinding result)` Constructs a new instance of an Observation.
`Observation(java.util.Calendar begin, ITarget target, IObserver observer, java.util.List results)` Constructs a new instance of an Observation.
`Observation(org.w3c.dom.Node observation, ITarget[] targets, IObserver[] observers, ISite[] sites, IScope[] scopes, ISession[] sessions, IEyepiece[] eyepieces, IFilter[] filters, IImager[] imagers, ILens[] lenses)` Constructs a new Observation instance from a given XML Schema Node.

Method Summary
`void`	`addImage(java.lang.String imagePath)` Adds a new image (path) to this observation.
`boolean`	`addImages(java.util.List images)` Adds a List of image paths (String) to this observation.
`void`	`addResult(IFinding result)` Adds a new result to this observation.
`boolean`	`addResults(java.util.List results)` Adds a List of results for this observation.
`org.w3c.dom.Element`	`addToXmlElement(org.w3c.dom.Element parent)` Adds this Observation to a given parent XML DOM Element.
`java.lang.String`	`getAccessories()` Returns the accessories used for this observation.
`java.util.Calendar`	`getBegin()` Returns the start date of the observation.
`java.lang.String`	`getDisplayName()` Returns a display name for this element.
`java.util.Calendar`	`getEnd()` Returns the end date of the observation.
`IEyepiece`	`getEyepiece()` Returns the eyepiece with which the observation was made.
`float`	`getFaintestStar()` Returns the magnitude of the faintest star that could be seen during observation time with the unaided eye.
`IFilter`	`getFilter()` Returns the filter which was used for this observation Might return `null` if no filter was used at all.
`IImager`	`getImager()` Returns the imager that was used for this observation.
`java.util.List`	`getImages()` Returns a list of images (relativ path to images), taken at this observation.
`ILens`	`getLens()` Returns the lens with which the observation was made.
`float`	`getMagnification()` Returns the magnification used for this observation.
`IObserver`	`getObserver()` Returns the observer who made the observation.
`java.util.List`	`getResults()` Returns a List with one or more results of the observation.
`IScope`	`getScope()` Returns the scope that was used for the observation.
`int`	`getSeeing()` Returns the seeing during this observation.
`ISession`	`getSession()` Returns the session this observation belongs to.
`ISite`	`getSite()` Returns the site where the observation took place.
`float`	`getSkyQuality()` Returns the sky quality meter value given in magnitudes per square arcsecond Might return `Float.NaN` if no value was set at all.
`ITarget`	`getTarget()` Returns the target which was observed.
`void`	`setAccessories(java.lang.String accessories)` Sets the accessories used during the observation.
`void`	`setBegin(java.util.Calendar begin)` Sets the start date of the observation.
`void`	`setEnd(java.util.Calendar end)` Sets the end date of the observation.
`void`	`setEyepiece(IEyepiece eyepiece)` Sets the eyepiece of the observation.
`void`	`setFaintestStar(float faintestStar)` Sets the magnitude value of the faintest star which could be seen with the unaided eye during the observation.
`void`	`setFilter(IFilter filter)` Sets the filter used during this observation.
`void`	`setImager(IImager imager)` Sets an imager used for this observation.
`boolean`	`setImages(java.util.List imagesList)` Sets a List of images (path as String) for this observation.
`void`	`setLens(ILens lens)` Sets the lens of the observation.
`void`	`setMagnification(float magnification)` Sets the magnification used at the observation.
`void`	`setObserver(IObserver observer)` Sets the observer of the observation.
`boolean`	`setResult(IFinding result)` Sets a single IFinding as result for this observation.
`boolean`	`setResults(java.util.List results)` Sets a List of results for this observation.
`void`	`setScope(IScope scope)` Sets the scope of the observation.
`void`	`setSeeing(int seeing)` Sets the seeing during this observation.
`void`	`setSession(ISession session)` Sets the session which this observation belongs to.
`void`	`setSite(ISite site)` Sets the site where this observation took place.
`void`	`setSkyQuality(float sq)` Sets the sky quality meter value that was determined during the observation.
`void`	`setTarget(ITarget target)` Sets the target of this observation.
`java.lang.String`	`toString()` Overwrittes toString() method from java.lang.Object.

Methods inherited from class de.lehmannet.om.SchemaElement
`equals, getID, setID`

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

Methods inherited from interface de.lehmannet.om.ISchemaElement
`getID`

Constructor Detail

Observation

public Observation(org.w3c.dom.Node observation,
                   ITarget[] targets,
                   IObserver[] observers,
                   ISite[] sites,
                   IScope[] scopes,
                   ISession[] sessions,
                   IEyepiece[] eyepieces,
                   IFilter[] filters,
                   IImager[] imagers,
                   ILens[] lenses)
            throws SchemaException,
                   java.lang.IllegalArgumentException

Constructs a new Observation instance from a given XML Schema Node. Normally this constructor is only used by de.lehmannet.om.util.SchemaLoader
Please mind: As a Observation can have multiple subelements (e.g. ,,...) that link to their implementing elements somewhere else in the xml. Because of that this constructor requires several arrays of these subelements to check whether their implementing element exists. If a Observation Node has no subelement of a specific type (cause its optional by XML Schema specification), the according array parameter can be empty or null.

Parameters:: observation - the XML Schema Node that represents this Observation object; targets - Array of ITarget that might be linked from this observation; observers - Array of IObserver that might be linked from this observation; sites - Array of ISite that might be linked from this observation; scopes - Array of IScope that might be linked from this observation (as Site is optional by XML Schema, this parameter can be NULL if passed Observation Node has no subelement); sessions - Array of ISession that might be linked from this observation (as Session is optional by XML Schema, this parameter can be NULL if passed Observation Node has no subelement); eyepieces - Array of IEyepiece that might be linked from this observation (as Eyepiece is optional by XML Schema, this parameter can be NULL if passed Observation Node has no subelement); filters - Array of IFilter that might be linked from this observation (as Filter is optional by XML Schema, this parameter can be NULL if passed Observation Node has no subelement); imagers - Array of IImagers that might be linked from this observation (as Imager is optional by XML Schema, this parameter can be NULL if passed Observation Node has no subelement); lenses - Array of ILens that might be linked from this observation (as Lens is optional by XML Schema, this parameter can be NULL if passed Observation Node has no subelement)
Throws:: java.lang.IllegalArgumentException - if parameter observation is null or Observation Node has subelements of which no according array was passed (or the passed array was empty).; SchemaException - if the given Node does not match the XML Schema specifications

Observation

public Observation(java.util.Calendar begin,
                   ITarget target,
                   IObserver observer,
                   IFinding result)
            throws java.lang.IllegalArgumentException

Constructs a new instance of an Observation.
Simplest constructor as all parameters are mandatory.

Parameters:: begin - Start date of observation; target - The target of the observation; observer - The observer who made the observation; result - The result of this observation
Throws:: java.lang.IllegalArgumentException - if one of the parameters is null