de.lehmannet.om
Interface IFilter

All Superinterfaces:

ISchemaElement

All Known Implementing Classes:

Filter

public interface IFilter
extends ISchemaElement

An IFilter describes a optical filter used during the observation.
This includes all kind of filters like color filters, band filter, ...
The model name and the type are mandatory fields which have to be set.

Since:

1.5

Author:

doergn@users.sourceforge.net

Field Summary

static java.lang.String	FILTER_COLOR_BLUE Filter colors (only valid for filter type color)
static java.lang.String	FILTER_COLOR_DEEPBLUE
static java.lang.String	FILTER_COLOR_DEEPRED
static java.lang.String	FILTER_COLOR_DEEPYELLOW
static java.lang.String	FILTER_COLOR_GREEN
static java.lang.String	FILTER_COLOR_LIGHTGREEN
static java.lang.String	FILTER_COLOR_LIGHTRED
static java.lang.String	FILTER_COLOR_LIGHTYELLOW
static java.lang.String	FILTER_COLOR_MEDIUMBLUE
static java.lang.String	FILTER_COLOR_ORANGE
static java.lang.String	FILTER_COLOR_PALEBLUE
static java.lang.String	FILTER_COLOR_RED
static java.lang.String	FILTER_COLOR_VIOLET
static java.lang.String	FILTER_COLOR_YELLOW
static java.lang.String	FILTER_COLOR_YELLOWGREEN
static java.lang.String	FILTER_TYPE_BROADBAND Filter types
static java.lang.String	FILTER_TYPE_COLOR
static java.lang.String	FILTER_TYPE_CORRECTIVE
static java.lang.String	FILTER_TYPE_HALPHA
static java.lang.String	FILTER_TYPE_HBETA
static java.lang.String	FILTER_TYPE_NARROWBAND
static java.lang.String	FILTER_TYPE_NEUTRAL
static java.lang.String	FILTER_TYPE_OIII
static java.lang.String	FILTER_TYPE_OTHER
static java.lang.String	FILTER_TYPE_SOLAR
static java.lang.String	XML_ELEMENT_COLOR Constant for XML representation: color element name Example: <filter> More stuff goes here <color>Vendor name goes here</color> More stuff goes here </filter>
static java.lang.String	XML_ELEMENT_FILTER Constant for XML representation: filter element name
static java.lang.String	XML_ELEMENT_MODEL Constant for XML representation: model element name Example: <filter> More stuff goes here <model>Model name goes here</model> More stuff goes here </filter>
static java.lang.String	XML_ELEMENT_SCHOTT Constant for XML representation: apparent field of view element name Example: <filter> More stuff goes here <schott>apparent field of view goes here</schott> More stuff goes here </filter>
static java.lang.String	XML_ELEMENT_TYPE Constant for XML representation: filter type element name Example: <filter> More stuff goes here <type>Model name goes here</type> More stuff goes here </filter>
static java.lang.String	XML_ELEMENT_WRATTEN Constant for XML representation: wratten element name Example: <filter> More stuff goes here <wratten>Focal length goes here</wratten> More stuff goes here </filter>

Fields inherited from interface de.lehmannet.om.ISchemaElement

XML_ELEMENT_ATTRIBUTE_ID

Method Summary

org.w3c.dom.Element	addAsLinkToXmlElement(org.w3c.dom.Element element) Adds the filter link to an given XML DOM Element The filter element itself will be attached to given elements ownerDocument.
org.w3c.dom.Element	addToXmlElement(org.w3c.dom.Element element) Adds this Filter to a given parent XML DOM Element.
java.lang.String	getColor() Returns the color of this filter.
java.lang.String	getModel() Returns the model of this filter.
java.lang.String	getSchott() Returns the schott value of this filter.
java.lang.String	getType() Returns the filter type.
java.lang.String	getWratten() Returns the wratten value of this filter.
void	setColor(java.lang.String color) Sets the color of this filter.
void	setModel(java.lang.String model) Sets the model name for the filter.
void	setSchott(java.lang.String schott) Sets the schott value for the filter.
void	setType(java.lang.String type) Sets the filter type.
void	setWratten(java.lang.String wratten) Sets the wratten value for the filter.

Methods inherited from interface de.lehmannet.om.ISchemaElement

getDisplayName, getID

Field Detail

XML_ELEMENT_FILTER

static final java.lang.String XML_ELEMENT_FILTER

Constant for XML representation: filter 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:
<filter>
More stuff goes here <model>Model name goes here</model> More stuff goes here </filter>

See Also:

Constant Field Values

XML_ELEMENT_TYPE

static final java.lang.String XML_ELEMENT_TYPE

Constant for XML representation: filter type element name Example:
<filter>
More stuff goes here <type>Model name goes here</type> More stuff goes here </filter>

See Also:

Constant Field Values

XML_ELEMENT_COLOR

static final java.lang.String XML_ELEMENT_COLOR

Constant for XML representation: color element name Example:
<filter>
More stuff goes here <color>Vendor name goes here</color> More stuff goes here </filter>

See Also:

Constant Field Values

XML_ELEMENT_WRATTEN

static final java.lang.String XML_ELEMENT_WRATTEN

Constant for XML representation: wratten element name Example:
<filter>
More stuff goes here <wratten>Focal length goes here</wratten> More stuff goes here </filter>

See Also:

Constant Field Values

XML_ELEMENT_SCHOTT

static final java.lang.String XML_ELEMENT_SCHOTT

Constant for XML representation: apparent field of view element name Example:
<filter>
More stuff goes here <schott>apparent field of view goes here</schott> More stuff goes here </filter>

See Also:

Constant Field Values

FILTER_TYPE_BROADBAND

static final java.lang.String FILTER_TYPE_BROADBAND

Filter types

See Also:

Constant Field Values

FILTER_TYPE_COLOR

static final java.lang.String FILTER_TYPE_COLOR

See Also:

Constant Field Values

FILTER_TYPE_CORRECTIVE

static final java.lang.String FILTER_TYPE_CORRECTIVE

See Also:

Constant Field Values

FILTER_TYPE_HALPHA

static final java.lang.String FILTER_TYPE_HALPHA

See Also:

Constant Field Values

FILTER_TYPE_HBETA

static final java.lang.String FILTER_TYPE_HBETA

See Also:

Constant Field Values

FILTER_TYPE_NARROWBAND

static final java.lang.String FILTER_TYPE_NARROWBAND

See Also:

Constant Field Values

FILTER_TYPE_NEUTRAL

static final java.lang.String FILTER_TYPE_NEUTRAL

See Also:

Constant Field Values

FILTER_TYPE_OIII

static final java.lang.String FILTER_TYPE_OIII

See Also:

Constant Field Values

FILTER_TYPE_OTHER

static final java.lang.String FILTER_TYPE_OTHER

See Also:

Constant Field Values

FILTER_TYPE_SOLAR

static final java.lang.String FILTER_TYPE_SOLAR

See Also:

Constant Field Values

FILTER_COLOR_BLUE

static final java.lang.String FILTER_COLOR_BLUE

Filter colors (only valid for filter type color)

See Also:

Constant Field Values

FILTER_COLOR_DEEPBLUE

static final java.lang.String FILTER_COLOR_DEEPBLUE

See Also:

Constant Field Values

FILTER_COLOR_DEEPRED

static final java.lang.String FILTER_COLOR_DEEPRED

See Also:

Constant Field Values

FILTER_COLOR_DEEPYELLOW

static final java.lang.String FILTER_COLOR_DEEPYELLOW

See Also:

Constant Field Values

FILTER_COLOR_GREEN

static final java.lang.String FILTER_COLOR_GREEN

See Also:

Constant Field Values

FILTER_COLOR_LIGHTGREEN

static final java.lang.String FILTER_COLOR_LIGHTGREEN

See Also:

Constant Field Values

FILTER_COLOR_LIGHTRED

static final java.lang.String FILTER_COLOR_LIGHTRED

See Also:

Constant Field Values

FILTER_COLOR_LIGHTYELLOW

static final java.lang.String FILTER_COLOR_LIGHTYELLOW

See Also:

Constant Field Values

FILTER_COLOR_MEDIUMBLUE

static final java.lang.String FILTER_COLOR_MEDIUMBLUE

See Also:

Constant Field Values

FILTER_COLOR_ORANGE

static final java.lang.String FILTER_COLOR_ORANGE

See Also:

Constant Field Values

FILTER_COLOR_PALEBLUE

static final java.lang.String FILTER_COLOR_PALEBLUE

See Also:

Constant Field Values

FILTER_COLOR_RED

static final java.lang.String FILTER_COLOR_RED

See Also:

Constant Field Values

FILTER_COLOR_VIOLET

static final java.lang.String FILTER_COLOR_VIOLET

See Also:

Constant Field Values

FILTER_COLOR_YELLOW

static final java.lang.String FILTER_COLOR_YELLOW

See Also:

Constant Field Values

FILTER_COLOR_YELLOWGREEN

static final java.lang.String FILTER_COLOR_YELLOWGREEN

See Also:

Constant Field Values

Method Detail

addToXmlElement

org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element element)

Adds this Filter to a given parent XML DOM Element. The Filter element will be set as a child element of the passed element.

Parameters:

parent - The parent element for this Filter

Returns:

Returns the element given as parameter with this Filter as child element.
Might return null if parent was null.

See Also:

Element

addAsLinkToXmlElement

org.w3c.dom.Element addAsLinkToXmlElement(org.w3c.dom.Element element)

Adds the filter link to an given XML DOM Element The filter element itself will be attached to given elements ownerDocument. If the ownerDocument has no filter container, it will be created.
Example:
<parameterElement>
<filter>123</filter>
</parameterElement>
More stuff of the xml document goes here
<filterContainer>
<filter id="123">
filter description goes here
</filter>
</filterContainer>

Parameters:

element - The element under which the the filter link is created

Returns:

Returns the Element given as parameter with a additional filter link, and the filter element under the filter container of the ownerDocument Might return null if element was null.

See Also:

Element

getColor

java.lang.String getColor()

Returns the color of this filter.

Returns:

Returns a String representing the filters color, or null if the color was never set (e.g. filter type is not IFilter.FILTER_TYPE_COLOR).

setColor

void setColor(java.lang.String color)

Sets the color of this filter.
In case the current filter type is not IFilter.FILTER_TYPE_COLOR a IllegalArgumentException is thrown, so make sure to set Filter type to color first.
Valid color values can be retrieved from IFilter constants.

Parameters:

color - The new color of the filter.

Throws:

java.lang.IllegalArgumentException - if filter type is not IFilter.FILTER_TYPE_COLOR, or the given color is empty null or does not contain a valid value.

See Also:

IFilter

getModel

java.lang.String getModel()

Returns the model of this filter.

Returns:

Returns a String representing the filter model.

setModel

void setModel(java.lang.String model)

Sets the model name for the filter.

Parameters:

model - The new model name to be set.

Throws:

java.lang.IllegalArgumentException - if modelname was null

getSchott

java.lang.String getSchott()

Returns the schott value of this filter.

Returns:

Returns a String representing the schott value of the filter, or null if the value was never set.

setSchott

void setSchott(java.lang.String schott)

Sets the schott value for the filter.

Parameters:

schott - The new schott value to be set.

getType

java.lang.String getType()

Returns the filter type.

Returns:

Returns a String representing the filter type.

setType

void setType(java.lang.String type)

Sets the filter type.
The filter type must be a value from the types defined in IFilter.
If the old filter type was IFilter.FILTER_TYPE_COLOR and the new filter type is not, then the filters color is reset to null.

Parameters:

type - The new filter type to be set.

Throws:

java.lang.IllegalArgumentException - if type was empty, null or does not contain a valid value (see IFilter constants).

See Also:

IFilter

getWratten

java.lang.String getWratten()

Returns the wratten value of this filter.

Returns:

Returns a String representing the wratten value of the filter, or null if the value was never set.

setWratten

void setWratten(java.lang.String wratten)

Sets the wratten value for the filter.

Parameters:

schott - The new wratten value to be set.