org.jscience.ml.om.extension.deepsky
Class DeepSkyTargetPN

java.lang.Object
  extended by org.jscience.ml.om.SchemaElement
      extended by org.jscience.ml.om.Target
          extended by org.jscience.ml.om.extension.deepsky.DeepSkyTarget
              extended by org.jscience.ml.om.extension.deepsky.DeepSkyTargetPN
All Implemented Interfaces:
IExtendableSchemaElement, ISchemaElement, ITarget

public class DeepSkyTargetPN
extends DeepSkyTarget

DeepSkyTargetPN extends the org.jscience.ml.om.extension.deepsky.DeepSkyTarget class.
Its specialised for planetary nebulaes.

Since:
1.0

Field Summary
 
Fields inherited from interface org.jscience.ml.om.ITarget
XML_ELEMENT_ALIASNAME, XML_ELEMENT_CONSTELLATION, XML_ELEMENT_DATASOURCE, XML_ELEMENT_NAME, XML_ELEMENT_TARGET, XML_XSI_TYPE
 
Fields inherited from interface org.jscience.ml.om.ISchemaElement
XML_ELEMENT_ATTRIBUTE_ID
 
Constructor Summary
DeepSkyTargetPN(org.w3c.dom.Node targetElement, IObserver[] observers)
          Constructs a new instance of a DeepSkyTargetPN from a given DOM target Element.
DeepSkyTargetPN(java.lang.String name, IObserver observer)
          Constructs a new instance of a DeepSkyTargetPN.
DeepSkyTargetPN(java.lang.String name, java.lang.String datasource)
          Constructs a new instance of a DeepSkyTargetPN.
 
Method Summary
 org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element element)
          Adds this Target to a given parent XML DOM Element.
 double getCentralStarMagnitude()
          Returns the magnitude of the central star
 java.lang.String getXSIType()
          Returns the XML schema instance type of the implementation.
 void setCentralStarMagnitude(double newMagnitude)
          Sets the magnitude of the central star
 
Methods inherited from class org.jscience.ml.om.extension.deepsky.DeepSkyTarget
createXmlDeepSkyTargetElement, equals, getLargeDiameter, getSmallDiameter, getSurfaceBrightness, getVisibleMagnitude, setLargeDiameter, setSmallDiameter, setSurfaceBrightness, setVisibleMagnitude, toString
 
Methods inherited from class org.jscience.ml.om.Target
addAliasName, addAliasNames, addAsLinkToXmlElement, createXmlTargetElement, getAliasNames, getConstellation, getDatasource, getDisplayName, getName, getObserver, getPosition, removeAliasName, setAliasNames, setConstellation, setDatasource, setName, setObserver, setPosition
 
Methods inherited from class org.jscience.ml.om.SchemaElement
getID, setID
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.jscience.ml.om.ISchemaElement
getID
 

Constructor Detail

DeepSkyTargetPN

public DeepSkyTargetPN(org.w3c.dom.Node targetElement,
                       IObserver[] observers)
                throws SchemaException
Constructs a new instance of a DeepSkyTargetPN from a given DOM target Element.
Normally this constructor is called by org.jscience.ml.om.util.SchemaLoader. Please mind that Target has to have a element, or a element. If a element is set, a array with Observers must be passed to check, whether the link is valid.

Parameters:
observers - Array of IObserver that might be linked from this observation, can be NULL if datasource element is set
targetElement - The origin XML DOM Element
Throws:
SchemaException - if given targetElement was null

DeepSkyTargetPN

public DeepSkyTargetPN(java.lang.String name,
                       java.lang.String datasource)
Constructs a new instance of a DeepSkyTargetPN.

Parameters:
name - The name of the planetary nebulae
datasource - The datasource of the planetary nebulae

DeepSkyTargetPN

public DeepSkyTargetPN(java.lang.String name,
                       IObserver observer)
Constructs a new instance of a DeepSkyTargetPN.

Parameters:
name - The name of the planetary nebulae
observer - The observer who is the originator of the planetary nebulae
Method Detail

addToXmlElement

public org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element element)
Adds this Target to a given parent XML DOM Element. The Target element will be set as a child element of the passed element.

Specified by:
addToXmlElement in interface ITarget
Specified by:
addToXmlElement in class DeepSkyTarget
Parameters:
parent - The parent element for this Target
Returns:
Returns the element given as parameter with this Target as child element.
Might return null if parent was null.
See Also:
Element

getXSIType

public java.lang.String getXSIType()
Returns the XML schema instance type of the implementation.
Example:


Specified by:
getXSIType in interface IExtendableSchemaElement
Specified by:
getXSIType in class DeepSkyTarget
Returns:
The xsi:type value of this implementation

getCentralStarMagnitude

public double getCentralStarMagnitude()
Returns the magnitude of the central star

Returns:
The magnitude of the central star The returned value might be Double.NaN if the value was never set

setCentralStarMagnitude

public void setCentralStarMagnitude(double newMagnitude)
Sets the magnitude of the central star

Parameters:
newMagnitude - The new magnitude of the central star