org.h2gis.functions.io.kml.KMLWriterDriver Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of h2gis Show documentation
Show all versions of h2gis Show documentation
Main module of the H2GIS distribution. It extends H2 by adding spatial storage and analysis
capabilities.
The newest version!
/**
* H2GIS is a library that brings spatial support to the H2 Database Engine
* http://www.h2database.com. H2GIS is developed by CNRS
* http://www.cnrs.fr/.
*
* This code is part of the H2GIS project. H2GIS is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* Lesser General Public License as published by the Free Software Foundation;
* version 3.0 of the License.
*
* H2GIS is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details kmlFields;
private int columnCount = -1;
private String tableName;
public KMLWriterDriver(Connection connection, File fileName, String encoding, boolean deleteFile) {
this.connection = connection;
this.fileName = fileName;
this.encoding=encoding;
this.deleteFile=deleteFile;
}
/**
* Write spatial table or sql query to kml or kmz file format.
*
* @param tableName the name of table or a select query
* @param progress progress monitor
* @throws SQLException
* @throws java.io.IOException
*/
public void write( String tableName, ProgressVisitor progress) throws SQLException, IOException {
String regex = ".*(?i)\\b(select|from)\\b.*";
Pattern pattern = Pattern.compile(regex);
Matcher matcher = pattern.matcher(tableName);
if (matcher.find()) {
if (tableName.startsWith("(") && tableName.endsWith(")")) {
if (FileUtilities.isExtensionWellFormated(fileName, "kml")) {
if(deleteFile){
Files.deleteIfExists(fileName.toPath());
} else if (fileName.exists()) {
throw new IOException("The kml file already exist.");
}
PreparedStatement ps = connection.prepareStatement(tableName, ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_READ_ONLY);
ResultSet resultSet = ps.executeQuery();
Tuple spatialFieldName = GeometryTableUtilities.getFirstGeometryColumnNameAndIndex(resultSet);
int rowCount = 0;
int type = resultSet.getType();
if (type == ResultSet.TYPE_SCROLL_INSENSITIVE || type == ResultSet.TYPE_SCROLL_SENSITIVE) {
resultSet.last();
rowCount = resultSet.getRow();
resultSet.beforeFirst();
}
this.tableName = "QUERY_"+System.currentTimeMillis();
writeKML(progress.subProcess(rowCount), fileName,resultSet, spatialFieldName.first(), encoding);
}else if (FileUtilities.isExtensionWellFormated(fileName, "kmz")) {
if(deleteFile){
Files.deleteIfExists(fileName.toPath());
} else if (fileName.exists()) {
throw new IOException("The kmz file already exist.");
}
PreparedStatement ps = connection.prepareStatement(tableName, ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_READ_ONLY);
ResultSet resultSet = ps.executeQuery();
Tuple spatialFieldName = GeometryTableUtilities.getFirstGeometryColumnNameAndIndex(resultSet);
int rowCount = 0;
int type = resultSet.getType();
if (type == ResultSet.TYPE_SCROLL_INSENSITIVE || type == ResultSet.TYPE_SCROLL_SENSITIVE) {
resultSet.last();
rowCount = resultSet.getRow();
resultSet.beforeFirst();
}
this.tableName = "QUERY_"+System.currentTimeMillis();
String name = fileName.getName();
int pos = name.lastIndexOf(".");
writeKMZ(progress.subProcess(rowCount), fileName, name.substring(0, pos) + ".kmz", resultSet, spatialFieldName.first(),encoding);
} else {
throw new SQLException("Please use the extensions .kml or kmz.");
}
} else {
throw new SQLException("The select query must be enclosed in parenthesis: '(SELECT * FROM ORDERS)'.");
}
} else {
//Write table
Statement st = connection.createStatement() ;
ResultSet resultSet = st.executeQuery(String.format("select * from %s", tableName));
// Read Geometry Index and type
Tuple spatialFieldName = GeometryTableUtilities.getFirstGeometryColumnNameAndIndex(resultSet);
this.tableName=tableName;
if (FileUtilities.isExtensionWellFormated(fileName, "kml")) {
if(deleteFile){
Files.deleteIfExists(fileName.toPath());
}
else if (fileName.exists()) {
throw new IOException("The kml file already exist.");
}
writeKML(progress, fileName,resultSet, spatialFieldName.first(), encoding);
}else if (FileUtilities.isExtensionWellFormated(fileName, "kmz")) {
if(deleteFile){
Files.deleteIfExists(fileName.toPath());
}else if (fileName.exists()) {
throw new IOException("The kmz file already exist.");
}
String name = fileName.getName();
int pos = name.lastIndexOf(".");
writeKMZ(progress, fileName, name.substring(0, pos) + ".kmz", resultSet, spatialFieldName.first(),encoding);
}else {
throw new SQLException("The select query must be enclosed in parenthesis: '(SELECT * FROM ORDERS)'.");
}
}
}
/**
* Write the spatial table to a KML format
*
* @param progress
* @throws SQLException
*/
private void writeKML(ProgressVisitor progress,File fileName,ResultSet rs,String geomField, String encoding) throws SQLException {
FileOutputStream fos = null;
try {
fos = new FileOutputStream(fileName);
writeKMLDocument(progress, fos, rs,geomField,encoding);
} catch (FileNotFoundException ex) {
throw new SQLException(ex);
} finally {
try {
if (fos != null) {
fos.close();
}
} catch (IOException ex) {
throw new SQLException(ex);
}
}
}
/**
* Write the spatial table to a KMZ format
*
* @param progress
* @param fileNameWithExtension
* @throws SQLException
*/
private void writeKMZ(ProgressVisitor progress,File fileName, String fileNameWithExtension, ResultSet rs,String geomField, String encoding) throws SQLException {
ZipOutputStream zos = null;
try {
zos = new ZipOutputStream(new FileOutputStream(fileName));
// Create a zip entry for the main KML file
zos.putNextEntry(new ZipEntry(fileNameWithExtension));
writeKMLDocument(progress, zos, rs, geomField, encoding);
} catch (FileNotFoundException ex) {
throw new SQLException(ex);
} catch (IOException ex) {
throw new SQLException(ex);
} finally {
try {
if (zos != null) {
zos.closeEntry();
zos.finish();
}
} catch (IOException ex) {
throw new SQLException(ex);
} finally {
try {
if (zos != null) {
zos.close();
}
} catch (IOException ex) {
throw new SQLException(ex);
}
}
}
}
/**
* Write the KML document Note the document stores only the first geometry
* column in the placeMark element. The other geomtry columns are ignored.
*
* @param progress
* @param outputStream
* @throws SQLException
*/
private void writeKMLDocument(ProgressVisitor progress, OutputStream outputStream, ResultSet rs, String geomField, String encoding) throws SQLException {
try {
final XMLOutputFactory streamWriterFactory = XMLOutputFactory.newFactory();
streamWriterFactory.setProperty("escapeCharacters", false);
String newEncoding = encoding;
if (newEncoding == null || newEncoding.isEmpty()) {
newEncoding = "UTF-8";
}
XMLStreamWriter xmlOut = streamWriterFactory.createXMLStreamWriter(
new BufferedOutputStream(outputStream), newEncoding);
xmlOut.writeStartDocument(newEncoding, "1.0");
xmlOut.writeStartElement("kml");
xmlOut.writeDefaultNamespace("http://www.opengis.net/kml/2.2");
xmlOut.writeNamespace("atom", "http://www.w3.org/2005/Atom");
xmlOut.writeNamespace("kml", "http://www.opengis.net/kml/2.2");
xmlOut.writeNamespace("gx", "http://www.google.com/kml/ext/2.2");
xmlOut.writeNamespace("xal", "urn:oasis:names:tc:ciq:xsdschema:xAL:2.0");
xmlOut.writeStartElement("Document");
try {
ResultSetMetaData resultSetMetaData = rs.getMetaData();
writeSchema(xmlOut, resultSetMetaData);
xmlOut.writeStartElement("Folder");
xmlOut.writeStartElement("name");
xmlOut.writeCharacters(tableName);
xmlOut.writeEndElement();//Name
while (rs.next()) {
writePlacemark(xmlOut, rs, geomField);
progress.endStep();
}
} finally {
rs.close();
}
xmlOut.writeEndElement();//Folder
xmlOut.writeEndElement();//KML
xmlOut.writeEndDocument();//DOC
xmlOut.close();
} catch (XMLStreamException ex) {
throw new SQLException(ex);
}
}
/**
* Specifies a custom KML schema that is used to add custom data to KML
* Features. The "id" attribute is required and must be unique within the
* KML file.
* is always a child of .
*
* Syntax :
*
*
*
* ...
*
*
*
* @param xmlOut
* @param metaData
*/
private void writeSchema(XMLStreamWriter xmlOut, ResultSetMetaData metaData) throws XMLStreamException, SQLException {
columnCount = metaData.getColumnCount();
//The schema is writing only if there is more than one column
if (columnCount > 1) {
xmlOut.writeStartElement("Schema");
xmlOut.writeAttribute("name", tableName);
xmlOut.writeAttribute("id", tableName);
//Write column metadata
kmlFields = new HashMap();
for (int fieldId = 1; fieldId <= columnCount; fieldId++) {
final String fieldTypeName = metaData.getColumnTypeName(fieldId);
if (!fieldTypeName.toLowerCase().startsWith("geometry")) {
String fieldName = metaData.getColumnName(fieldId);
writeSimpleField(xmlOut, fieldName, getKMLType(metaData.getColumnType(fieldId), fieldTypeName));
kmlFields.put(fieldId, fieldName);
}
}
xmlOut.writeEndElement();//Write schema
}
}
/**
* The declaration of the custom field, which must specify both the type and
* the name of this field. If either the type or the name is omitted, the
* field is ignored. The type can be one of the following : string, int,
* uint, short, ushort, float, double, bool.
*
* Syntax :
*
*
*
* @param xmlOut
* @param columnName
* @param columnType
* @throws XMLStreamException
*/
private void writeSimpleField(XMLStreamWriter xmlOut, String columnName, String columnType) throws XMLStreamException {
xmlOut.writeStartElement("SimpleField");
xmlOut.writeAttribute("name", columnName);
xmlOut.writeAttribute("type", columnType);
xmlOut.writeEndElement();//Write schema
}
/**
* A Placemark is a Feature with associated Geometry.Syntax :
* {@code
*
*
* ...
* 1
* 0
* ...
* ...
* ...
* ...
* ...
* ...
* ...
* ...
* ...
* ...
* ...
* ...
*
* ...
*
* }
*
* @param xmlOut
* @param rs
* @param geomField
*/
public void writePlacemark(XMLStreamWriter xmlOut, ResultSet rs, String geomField) throws XMLStreamException, SQLException {
xmlOut.writeStartElement("Placemark");
if (columnCount > 1) {
writeExtendedData(xmlOut, rs);
}
StringBuilder sb = new StringBuilder();
Geometry geom = (Geometry) rs.getObject(geomField);
int inputSRID = geom.getSRID();
if (inputSRID == 0) {
throw new SQLException("A coordinate reference system must be set to save the KML file");
} else if (inputSRID != 4326) {
throw new SQLException("The kml format supports only the WGS84 projection.");
}
KMLGeometry.toKMLGeometry(geom, ExtrudeMode.NONE, AltitudeMode.NONE, sb);
//Write geometry
xmlOut.writeCharacters(sb.toString());
xmlOut.writeEndElement();//Write Placemark
}
/**
* The ExtendedData element offers three techniques for adding custom data
* to a KML Feature (NetworkLink, Placemark, GroundOverlay, PhotoOverlay,
* ScreenOverlay, Document, Folder). These techniques are
*
* Adding untyped data/value pairs using the {@code Data} element (basic)
* Declaring new typed fields using the {@code Schema} element and then instancing
* them using the {@code } element (advanced) Referring to XML elements
* defined in other namespaces by referencing the external namespace within
* the KML file (basic)
*
* These techniques can be combined within a single KML file or Feature for
* different pieces of data.
*
* Syntax :
* {@code
*
*
* ...
* ...
*
*
* ...
*
* ...
*
* }
*
* @param xmlOut
*/
public void writeExtendedData(XMLStreamWriter xmlOut, ResultSet rs) throws XMLStreamException, SQLException {
xmlOut.writeStartElement("ExtendedData");
xmlOut.writeStartElement("SchemaData");
xmlOut.writeAttribute("schemaUrl", "#" + tableName);
for (Map.Entry entry : kmlFields.entrySet()) {
Integer fieldIndex = entry.getKey();
String fieldName = entry.getValue();
writeSimpleData(xmlOut, fieldName, rs.getString(fieldIndex));
}
xmlOut.writeEndElement();//Write SchemaData
xmlOut.writeEndElement();//Write ExtendedData
}
/**
*
* @param xmlOut
*/
public void writeSimpleData(XMLStreamWriter xmlOut, String columnName, String value) throws XMLStreamException {
xmlOut.writeStartElement("SimpleData");
xmlOut.writeAttribute("name", columnName);
xmlOut.writeCharacters(value);
xmlOut.writeEndElement();//Write ExtendedData
}
/**
* Return the kml type representation from SQL data type
*
* @param sqlTypeId
* @param sqlTypeName
* @return
* @throws SQLException
*/
private static String getKMLType(int sqlTypeId, String sqlTypeName) throws SQLException {
switch (sqlTypeId) {
case Types.BOOLEAN:
return "bool";
case Types.DOUBLE:
return "double";
case Types.FLOAT:
return "float";
case Types.INTEGER:
case Types.BIGINT:
return "int";
case Types.SMALLINT:
return "short";
case Types.DATE:
case Types.VARCHAR:
case Types.NCHAR:
case Types.CHAR:
return "string";
default:
throw new SQLException("Field type not supported by KML : " + sqlTypeName);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy