Package org.esa.snap.core.dataio.placemark

Class PlacemarkIO

java.lang.Object

org.esa.snap.core.dataio.placemark.PlacemarkIO

public class PlacemarkIO
extends Object

Utility class, that reads and writes placemarks from and to various plain text formats.

Since:

BEAM 1.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILE_EXTENSION_FLAT_OLD
static String	FILE_EXTENSION_FLAT_TEXT
static String	FILE_EXTENSION_KMZ
static String	FILE_EXTENSION_PLACEMARK
static String	FILE_EXTENSION_XML_OLD
static String	TAG_FILL_COLOR
static String	TAG_OUTLINE_COLOR

Method Summary

Modifier and Type	Method	Description
static SnapFileFilter	createKmzFileFilter()
static Placemark	createPlacemark(org.jdom2.Element element, PlacemarkDescriptor descriptor, GeoCoding geoCoding)	Creates a new placemark from an XML element and a given symbol.
static SnapFileFilter	createPlacemarkFileFilter()
static SnapFileFilter	createTextFileFilter()
static List<Placemark>	readPlacemarks(Reader reader, GeoCoding geoCoding, PlacemarkDescriptor placemarkDescriptor)
static void	writeColor(String tagName, int indent, Color color, XmlWriter writer)
static void	writePlacemarkKmzFile(OutputStream os, List<PlacemarkData> placemarks, ProgressMonitor pm)
static void	writePlacemarksFile(Writer writer, List<Placemark> placemarks)
static void	writePlacemarksWithAdditionalData(Writer writer, String roleLabel, String productName, List<Placemark> placemarkList, List<Object[]> valueList, String[] standardColumnNames, String[] additionalColumnNames)
static void	writeXML(Placemark placemark, XmlWriter writer, int indent)

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXTENSION_FLAT_OLD

public static final String FILE_EXTENSION_FLAT_OLD

See Also:

Constant Field Values

FILE_EXTENSION_XML_OLD

public static final String FILE_EXTENSION_XML_OLD

See Also:

Constant Field Values

FILE_EXTENSION_FLAT_TEXT

public static final String FILE_EXTENSION_FLAT_TEXT

See Also:

Constant Field Values

FILE_EXTENSION_PLACEMARK

public static final String FILE_EXTENSION_PLACEMARK

See Also:

Constant Field Values

FILE_EXTENSION_KMZ

public static final String FILE_EXTENSION_KMZ

See Also:

Constant Field Values

TAG_FILL_COLOR

public static final String TAG_FILL_COLOR

See Also:

Constant Field Values

TAG_OUTLINE_COLOR

public static final String TAG_OUTLINE_COLOR

See Also:

Constant Field Values

Method Detail

readPlacemarks

public static List<Placemark> readPlacemarks(Reader reader,
                                             GeoCoding geoCoding,
                                             PlacemarkDescriptor placemarkDescriptor)
                                      throws IOException

Throws:

IOException

writePlacemarksWithAdditionalData

public static void writePlacemarksWithAdditionalData(Writer writer,
                                                     String roleLabel,
                                                     String productName,
                                                     List<Placemark> placemarkList,
                                                     List<Object[]> valueList,
                                                     String[] standardColumnNames,
                                                     String[] additionalColumnNames)

writePlacemarksFile

public static void writePlacemarksFile(Writer writer,
                                       List<Placemark> placemarks)
                                throws IOException

Throws:

IOException

writePlacemarkKmzFile

public static void writePlacemarkKmzFile(OutputStream os,
                                         List<PlacemarkData> placemarks,
                                         ProgressMonitor pm)
                                  throws IOException

Throws:

IOException

createTextFileFilter

public static SnapFileFilter createTextFileFilter()

createPlacemarkFileFilter

public static SnapFileFilter createPlacemarkFileFilter()

createKmzFileFilter

public static SnapFileFilter createKmzFileFilter()

createPlacemark

public static Placemark createPlacemark(org.jdom2.Element element,
                                        PlacemarkDescriptor descriptor,
                                        GeoCoding geoCoding)

Creates a new placemark from an XML element and a given symbol.

Parameters:

element - the element.

descriptor - the descriptor of the placemark.

geoCoding - the geoCoding to used by the placemark. Can be null.

Returns:

the placemark created.

Throws:

NullPointerException - if element is null

IllegalArgumentException - if element is invalid

writeXML

public static void writeXML(Placemark placemark,
                            XmlWriter writer,
                            int indent)

writeColor

public static void writeColor(String tagName,
                              int indent,
                              Color color,
                              XmlWriter writer)