org.jscience.ml.om
Interface IImager

All Superinterfaces:
ISchemaElement
All Known Implementing Classes:
CCDImager, Imager

public interface IImager
extends ISchemaElement

An IImager describes a camera. The model name is a mandatory field which has to be set.

Since:
1.3

Field Summary
static java.lang.String CCD
          CCD type constant for imager
static java.lang.String FILM
          Film/chemical type constant for imager
static java.lang.String XML_ELEMENT_IMAGER
          Constant for XML representation: imager element name
static java.lang.String XML_ELEMENT_MODEL
          Constant for XML representation: model element name

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

static java.lang.String XML_ELEMENT_REMARKS
          Constant for XML representation: remarks element name

Example:
<imager>
More stuff goes here <remarks>Vendor name goes here</remarks> More stuff goes here </imager>

static java.lang.String XML_ELEMENT_TYPE
          Constant for XML representation: type element name

Example:
<imager>
More stuff goes here <type>Type goes here</type> More stuff goes here </imager>

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

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

 
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 IImager element itself will be attached to given elements ownerDocument.
 org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element element)
          Adds this IImager to a given parent XML DOM Element.
 java.lang.String getModel()
          Returns the model name of this imager.
 java.lang.String getRemarks()
          Returns the remarks to this imager.
 java.lang.String getType()
          Returns the type of this imager.
 java.lang.String getVendor()
          Returns the vendor name of this imager.
 void setModel(java.lang.String modelname)
          Sets the model name for the imager.
 void setRemarks(java.lang.String remarks)
          Sets the remarks for this imager.
 void setType(java.lang.String type)
          Sets the type for this imager.
 void setVendor(java.lang.String vendor)
          Sets the vendor name for the imager.
 
Methods inherited from interface org.jscience.ml.om.ISchemaElement
getDisplayName, getID
 

Field Detail

XML_ELEMENT_IMAGER

static final java.lang.String XML_ELEMENT_IMAGER
Constant for XML representation: imager 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:
<imager>
More stuff goes here <model>Model name goes here</model> More stuff goes here </imager>

See Also:
Constant Field Values

XML_ELEMENT_TYPE

static final java.lang.String XML_ELEMENT_TYPE
Constant for XML representation: type element name

Example:
<imager>
More stuff goes here <type>Type goes here</type> More stuff goes here </imager>

See Also:
Constant Field Values

XML_ELEMENT_VENDOR

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

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

See Also:
Constant Field Values

XML_ELEMENT_REMARKS

static final java.lang.String XML_ELEMENT_REMARKS
Constant for XML representation: remarks element name

Example:
<imager>
More stuff goes here <remarks>Vendor name goes here</remarks> More stuff goes here </imager>

See Also:
Constant Field Values

CCD

static final java.lang.String CCD
CCD type constant for imager

See Also:
Constant Field Values

FILM

static final java.lang.String FILM
Film/chemical type constant for imager

See Also:
Constant Field Values
Method Detail

addToXmlElement

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

Parameters:
parent - The parent element for this IImager
Returns:
Returns the element given as parameter with this IImager 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 IImager element itself will be attached to given elements ownerDocument. If the ownerDocument has no IImager container, it will be created.
Example:
<parameterElement>
<imagerLink>123</imagerLink>
</parameterElement>
More stuff of the xml document goes here
<imagerContainer>
<imager id="123">
imager description goes here
</imager>
</imagerContainer>

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

getModel

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

Returns:
Returns the model name of this imager.

getVendor

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

Returns:
Returns the vendor name of this imager or NULL if vendor name was not set.

getType

java.lang.String getType()
Returns the type of this imager.
Only two types are allowed:
- IImager.CCD
- IImager.Film

Returns:
Returns the type imager or NULL if type was not set.

getRemarks

java.lang.String getRemarks()
Returns the remarks to this imager.

Returns:
Returns the remarks to this imager or NULL if no remarks were set.

setModel

void setModel(java.lang.String modelname)
              throws java.lang.IllegalArgumentException
Sets the model name for the imager.

Parameters:
modelname - The new model name to be set.
Throws:
java.lang.IllegalArgumentException - if new modelname is null or empty string

setVendor

void setVendor(java.lang.String vendor)
Sets the vendor name for the imager.

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

setType

void setType(java.lang.String type)
Sets the type for this imager.
Only two types are allowed:
- IImager.CCD
- IImager.Film
If some other type is given, no change will take place.

Parameters:
type - The new image type.

setRemarks

void setRemarks(java.lang.String remarks)
Sets the remarks for this imager.

Parameters:
remarks - The new remarks.