/ 
Geo-KML-0.03
/ Geo::KML

NAME

Geo::KML - produce GoogleEarth KML/KMZ files

INHERITANCE

Geo::KML
  is a XML::Compile::Cache

SYNOPSIS

use Geo::KML;
my $kml = Geo::KML->new(version => '2.2.0');
$kml->writeKML($data);

my ($ns, $data) = Geo::KML->from('a.kmz');
defined $ns && $ns eq NS_KML_21
    or die "don't understand file content\n";

DESCRIPTION

KML is the information format for GoogleEarth, an abbreviation of Keyhole Markup Language. Keyhole was the company bought by Google, which had developed the initial version of the GoogleEarth browser. The first version of KML was XML without specs, but version 2 has clean schemas to it.

WARNING: it seems that GoogleEarth is very forgiving for the message structure, for instance the order of elements. XML::Compile, the base for this module, is not. So: reading kml files may not always work, even when the GoogleEarth application accepts it.

This module is intended to grow with knowledge and features about KML. Please contribute algorithms.

METHODS

Geo::KML->new(OPTIONS)

    Option     --Default
compression  <filename dependent>
format       <depends>
version      <required>

    . compression => 0..9

      The compression to be used to write the KMZ ZIP-archives. 9 is best, 0 means uncompressed. The default is 6. See the COMPRESSION_LEVEL_* constants defined by Archive::Zip.

    . format => 0..2

      Output format. A value of '0' means: as compact as possible. When compression is on, then the default is '0' (compact), otherwise '1' (readable).

    . version => STRING

      Which version of KML to read and/or write.

Accessors

$obj->compression([BOOLEAN])

    The level of compression (-1, 0..8) for the writer. The optional BOOLEAN changes the setting.

$obj->format([0..2])

    The output format. With '0', it is optimally compact.

$obj->version

    KML version, for instance '2.2.0'.

Compilers

Geo::KML->from(XMLDATA, OPTIONS)

    [release 0.03] Read KML from a source, which can be anything XML::Compile subroutine dataToXML accepts: filename, filehandle, scalar, and more. Returned is a list of two: the type of the KML structure and it parsed content.

    You call use ALL options which are provided by XML::Compile::Schema subroutine compile, for instance sloppy_integers and sloppy_floats.

    Option       --Default
is_compressed  <auto>

    . is_compressed => BOOLEAN

      When possible, automatically detected from the XMLDATA. However, when the XMLDATA is a file-handle, you may need to set this flag.

    example:

    my ($ns, $data) = Geo::KML->readKML('/tmp/a.kml');
my ($ns, $data) = Geo::KML->readKML(\*STDIN, is_compressed => 1);
if($ns eq NS_KML_220) ...

$obj->writeKML(DATA, FILENAME|FILEHANDLE, [ZIPPED])

    If ZIPPED is true, or the filename ends with "kmz", a zip archive will get produced. That archive will contain a single doc.kml file.

    You may skip the top-level Document element in the DATA structure.

SEE ALSO

This module is part of Geo-KML distribution version 0.03, built on March 19, 2009. Website: http://perl.overmeer.net/geo-kml All modules in this suite: "Geo::Point", "Geo::Proj4", "Geo::WKT", "Math::Polygon", "Geo::GML", "Geo::ISO19139", "Geo::EOP", "Geo::Format::Envisat", and "Geo::Format::Landsat".

Please post questions or ideas to the mailinglist at http://geo-perl@list.hut.fi

LICENSE

Copyrights 2008-2009 by Mark Overmeer. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html