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

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.DeepSkyTargetDN
All Implemented Interfaces:
IExtendableSchemaElement, ISchemaElement, ITarget

public class DeepSkyTargetDN
extends DeepSkyTarget

DeepSkyTargetDN extends the org.jscience.ml.om.extension.deepsky.DeepSkyTarget class.
Its specialised for drak 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
DeepSkyTargetDN(org.w3c.dom.Node targetElement, IObserver[] observers)
          Constructs a new instance of a DeepSkyTargetDN from a given DOM target Element.
DeepSkyTargetDN(java.lang.String name, IObserver observer)
          Constructs a new instance of a DeepSkyTargetDN.
DeepSkyTargetDN(java.lang.String name, java.lang.String datasource)
          Constructs a new instance of a DeepSkyTargetDN.
 
Method Summary
 org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element element)
          Adds this Target to a given parent XML DOM Element.
 int getOpacity()
          Returns the opacity of the dark nebula.
 int getPositionAngle()
          Returns the position angle of the large axis of the dark nebula.
 java.lang.String getXSIType()
          Returns the XML schema instance type of the implementation.
 void setOpacity(int newOpacity)
          Sets the opacity of the dark nebula.
 void setPositionAngle(int newPosAngle)
          Sets the position angle of the large axis of the dark nebula.
 
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

DeepSkyTargetDN

public DeepSkyTargetDN(org.w3c.dom.Node targetElement,
                       IObserver[] observers)
                throws SchemaException
Constructs a new instance of a DeepSkyTargetDN 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

DeepSkyTargetDN

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

Parameters:
name - The name of the dark nebula
datasource - The datasource of the dark nebula

DeepSkyTargetDN

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

Parameters:
name - The name of the dark nebula
observer - The observer who is the originator of the dark nebula
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

getPositionAngle

public int getPositionAngle()
Returns the position angle of the large axis of the dark nebula.

Returns:
The position angle of the astronomical object as integer The returned value might be -1 if the value was never set

getOpacity

public int getOpacity()
Returns the opacity of the dark nebula. After Lynds: 1=min; 6=max

Returns:
The opacity of the dark nebula as integer between 1-6 The returned value might be -1 if the value was never set

setPositionAngle

public void setPositionAngle(int newPosAngle)
Sets the position angle of the large axis of the dark nebula. If the given new position angle is < 0 or > 359 the position angle will be unset again.

Parameters:
newPosAngle - The new position angle of the dark nebula.

setOpacity

public void setOpacity(int newOpacity)
Sets the opacity of the dark nebula. The opacity value has to be between 1 and 6. (After Lynds: 1=min; 6=max)
All other values will be interpreted as -1, which means that the value gets cleared (means: is treated like it was never set)

Parameters:
newOpacity - The new opacity of the dark nebula as int