org.jscience.ml.om
Interface IEyepiece

All Superinterfaces:
ISchemaElement
All Known Implementing Classes:
Eyepiece

public interface IEyepiece
extends ISchemaElement

An IEyepiece describes a optical eyepiece. The model name and the focalLength are mandatory fields which have to be set.

Since:
1.0

Field Summary
static java.lang.String XML_ELEMENT_APPARENTFOV
          Constant for XML representation: apparent field of view element name

Example:
<eyepiece>
More stuff goes here <apparentFOV>apparent field of view goes here</apparentFOV> More stuff goes here </eyepiece>

static java.lang.String XML_ELEMENT_EYEPIECE
          Constant for XML representation: eyepiece element name
static java.lang.String XML_ELEMENT_FOCALLENGTH
          Constant for XML representation: focalLength element name

Example:
<eyepiece>
More stuff goes here <focalLength>Focal length goes here</focalLength> More stuff goes here </eyepiece>

static java.lang.String XML_ELEMENT_MODEL
          Constant for XML representation: model element name

Example:
<eyepiece>
More stuff goes here <model>Model name goes here</model> More stuff goes here </eyepiece>

static java.lang.String XML_ELEMENT_VENDOR
          Constant for XML representation: vendor element name

Example:
<eyepiece>
More stuff goes here <vendor>Vendor name goes here</vendor> More stuff goes here </eyepiece>

 
Fields inherited from interface org.jscience.ml.om.ISchemaElement
XML_ELEMENT_ATTRIBUTE_ID
 
Method Summary
 org.w3c.dom.Element addAsLinkToXmlElement(org.w3c.dom.Element parent)
          Adds the eyepiece link to an given XML DOM Element The eyepiece element itself will be attached to given elements ownerDocument.
 org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element element)
          Adds this Eyepiece to a given parent XML DOM Element.
 Angle getApparentFOV()
          Returns the apparent field of view of this eyepiece.
 float getFocalLength()
          Returns the focal length of this eyepiece.
 java.lang.String getModel()
          Returns the model name of the eyepiece.
 java.lang.String getVendor()
          Returns the vendor name of the eyepiece.
 boolean setApparentFOV(Angle apparentFOV)
          Sets the apparent field of view of this eyepiece.
 void setFocalLength(float focalLength)
          Sets the focal length of the eyepiece.
 void setModel(java.lang.String modelname)
          Sets the model name for the eyepiece.
 void setVendor(java.lang.String vendorname)
          Sets the vendor name of the eyepiece.
 
Methods inherited from interface org.jscience.ml.om.ISchemaElement
getDisplayName, getID
 

Field Detail

XML_ELEMENT_EYEPIECE

static final java.lang.String XML_ELEMENT_EYEPIECE
Constant for XML representation: eyepiece element name

See Also:
Constant Field Values

XML_ELEMENT_MODEL

static final java.lang.String XML_ELEMENT_MODEL
Constant for XML representation: model element name

Example:
<eyepiece>
More stuff goes here <model>Model name goes here</model> More stuff goes here </eyepiece>

See Also:
Constant Field Values

XML_ELEMENT_VENDOR

static final java.lang.String XML_ELEMENT_VENDOR
Constant for XML representation: vendor element name

Example:
<eyepiece>
More stuff goes here <vendor>Vendor name goes here</vendor> More stuff goes here </eyepiece>

See Also:
Constant Field Values

XML_ELEMENT_FOCALLENGTH

static final java.lang.String XML_ELEMENT_FOCALLENGTH
Constant for XML representation: focalLength element name

Example:
<eyepiece>
More stuff goes here <focalLength>Focal length goes here</focalLength> More stuff goes here </eyepiece>

See Also:
Constant Field Values

XML_ELEMENT_APPARENTFOV

static final java.lang.String XML_ELEMENT_APPARENTFOV
Constant for XML representation: apparent field of view element name

Example:
<eyepiece>
More stuff goes here <apparentFOV>apparent field of view goes here</apparentFOV> More stuff goes here </eyepiece>

See Also:
Constant Field Values
Method Detail

addToXmlElement

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

Parameters:
parent - The parent element for this Eyepiece
Returns:
Returns the element given as parameter with this Eyepiece as child element.
Might return null if parent was null.
See Also:
Element

addAsLinkToXmlElement

org.w3c.dom.Element addAsLinkToXmlElement(org.w3c.dom.Element parent)
Adds the eyepiece link to an given XML DOM Element The eyepiece element itself will be attached to given elements ownerDocument. If the ownerDocument has no eyepiece container, it will be created.
Example:
<parameterElement>
<eyepieceLink>123</eyepieceLink>
</parameterElement>
More stuff of the xml document goes here
<eyepieceContainer>
<eyepiece id="123">
eyepiece description goes here
</eyepiece>
</eyepieceContainer>

Parameters:
parent - The element under which the the eyepiece link is created
Returns:
Returns the Element given as parameter with a additional eyepiece link, and the eyepiece element under the eyepiece container of the ownerDocument Might return null if element was null.
See Also:
Element

getApparentFOV

Angle getApparentFOV()
Returns the apparent field of view of this eyepiece.

Returns:
Returns the apparent field of view of this eyepiece. The Angles value cannot be negative or 0.
If null is returned the apparent field of view value was never set.
See Also:
Angle

getFocalLength

float getFocalLength()
Returns the focal length of this eyepiece. The focal length of the telescope divided by the focal length of the eyepiece equals the amplification.

Returns:
Returns the focal length of the eyepiece.

getModel

java.lang.String getModel()
Returns the model name of the eyepiece.

Returns:
Returns a String representing the eyepieces model name.
If null is returned the model name was never set.

getVendor

java.lang.String getVendor()
Returns the vendor name of the eyepiece.

Returns:
Returns a String representing the eyepieces vendor name.
If null is returned the vendor name was never set.

setApparentFOV

boolean setApparentFOV(Angle apparentFOV)
Sets the apparent field of view of this eyepiece.
The field of view Angle cannot be negative or 0.

Parameters:
apparentFOV - The new apparent field of view to be set.
Returns:
Returns true if the new apparent field of view could be set. If false is returned the parameter was null, or the Angles value was negative or 0 (apparent field of view will not be changed if false is returned).

setFocalLength

void setFocalLength(float focalLength)
Sets the focal length of the eyepiece.

Parameters:
focalLength - The new focal length to be set.

setModel

void setModel(java.lang.String modelname)
Sets the model name for the eyepiece.

Parameters:
modelname - The new model name to be set.

setVendor

void setVendor(java.lang.String vendorname)
Sets the vendor name of the eyepiece.

Parameters:
vendorname - The new vendor name to be set.