org.esa.snap.core.layer

Class AbstractFigureDomConverter

java.lang.Object

org.esa.snap.core.layer.AbstractFigureDomConverter

All Implemented Interfaces:

DomConverter

public class AbstractFigureDomConverter
extends Object
implements DomConverter

Since:

BEAM 4.6

Constructor Summary

Constructors

Constructor and Description
AbstractFigureDomConverter()

Method Summary

Modifier and Type	Method and Description
org.esa.snap.core.draw.AbstractFigure	convertDomToValue(DomElement parentElement, Object figure) Converts a DOM to a (complex) value of the type returned by DomConverter.getValueType().
void	convertValueToDom(Object value, DomElement parentElement) Converts a (complex) value of the type returned by DomConverter.getValueType() to its DOM representation which may be further converted to XML.
Class<?>	getValueType() Gets the value type, which may be abstract.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFigureDomConverter

public AbstractFigureDomConverter()

Method Detail

getValueType

public Class<?> getValueType()

Description copied from interface: DomConverter

Gets the value type, which may be abstract.

Specified by:

getValueType in interface DomConverter

Returns:

The value type.

convertDomToValue

public org.esa.snap.core.draw.AbstractFigure convertDomToValue(DomElement parentElement,
                                                               Object figure)
                                                        throws ConversionException,
                                                               ValidationException

Description copied from interface: DomConverter

Converts a DOM to a (complex) value of the type returned by DomConverter.getValueType().

Specified by:

convertDomToValue in interface DomConverter

Parameters:

parentElement - The parent DOM element.

figure - The value which receives the DOM representation of the value or null. If value is null, the method is responsible for the creation of a new instance and its configuration using the DOM.

Returns:

The converted value, never null.

Throws:

ConversionException - If the conversion fails.

ValidationException - If the converted value is invalid.

convertValueToDom

public void convertValueToDom(Object value,
                              DomElement parentElement)
                       throws ConversionException

Description copied from interface: DomConverter

Converts a (complex) value of the type returned by DomConverter.getValueType() to its DOM representation which may be further converted to XML. The given value can be safely cast to the type returned by DomConverter.getValueType().

Specified by:

convertValueToDom in interface DomConverter

Parameters:

value - The value to be converted to the DOM. Never null.

parentElement - The parent DOM element, which receives the DOM representation of the value.

Throws:

ConversionException - If the conversion fails (e.g. not implemented).