org.jscience.ml.om
Interface IFinding

All Superinterfaces:
IExtendableSchemaElement, ISchemaElement
All Known Implementing Classes:
DeepSkyFinding, Finding, GenericFinding

public interface IFinding
extends ISchemaElement, IExtendableSchemaElement

A IFinding describes the impressions a observer had during a observation of an astronomical object.
A IFinding is a very general description without observation or object typical parameters. Subclasses of IFinding have to provide a specialised way to describe different astronmical observartions or obejects (e.g. variable Stars, DeepSky, Planets...).

Since:
1.0

Field Summary
static java.lang.String XML_ELEMENT_DESCRIPTION
          Constant for XML representation: Description element name.
static java.lang.String XML_ELEMENT_FINDING
          Constant for XML representation: IFinding element name.
 
Fields inherited from interface org.jscience.ml.om.ISchemaElement
XML_ELEMENT_ATTRIBUTE_ID
 
Fields inherited from interface org.jscience.ml.om.IExtendableSchemaElement
XML_XSI_TYPE
 
Method Summary
 org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element parent)
          Adds the IFinding implementation to an given parent XML DOM Element.
 java.lang.String getDescription()
          Returns the description of the IFinding.
 void setDescription(java.lang.String description)
          Sets the description of the IFinding.
 
Methods inherited from interface org.jscience.ml.om.ISchemaElement
getDisplayName, getID
 
Methods inherited from interface org.jscience.ml.om.IExtendableSchemaElement
getXSIType
 

Field Detail

XML_ELEMENT_FINDING

static final java.lang.String XML_ELEMENT_FINDING
Constant for XML representation: IFinding element name.
Example:
<result>More stuff goes here</result>

See Also:
Constant Field Values

XML_ELEMENT_DESCRIPTION

static final java.lang.String XML_ELEMENT_DESCRIPTION
Constant for XML representation: Description element name.
Example:
<result>
More stuff goes here <description>Finding description goes here</description> More stuff goes here </result>

See Also:
Constant Field Values
Method Detail

addToXmlElement

org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element parent)
Adds the IFinding implementation to an given parent XML DOM Element. The finding Element will be set as a child element of the passed Element.
Example:
<parentElement>
<result>
More stuff goes here
</result>
</parentElement>

Parameters:
parent - The parent element for the IFinding implementation
Returns:
Returns the Element given as parameter with the IFinding implementation as child Element.
See Also:
Element

getDescription

java.lang.String getDescription()
Returns the description of the IFinding. The string describes the impressions the observer had during the observation of an object.

Returns:
The description of the finding.

setDescription

void setDescription(java.lang.String description)
Sets the description of the IFinding. The string should describe the impressions the observer had during the observation of an object.

Parameters:
description - A description of the finding.