File Coverage

blib/lib/Geo/OSM/MapFeatures/Feature.pm

Criterion	Covered	Total	%
statement	21	46	45.6
branch	0	4	0.0
condition	0	3	0.0
subroutine	7	9	77.7
pod	1	2	50.0
total	29	64	45.3

package Geo::OSM::MapFeatures::Feature;

use warnings;
use strict;

use Geo::OSM::MapFeatures::Feature::Key;
use Geo::OSM::MapFeatures::Feature::Value;
use Geo::OSM::MapFeatures::Feature::Type;

use overload '""' => \&stringify;

use base qw(Class::Accessor);
__PACKAGE__->mk_accessors(qw(key values types description));

=head1 NAME

Geo::OSM::MapFeatures::Feature - Represents a feature on map features

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.02';


=head1 SYNOPSIS

A feature corresponds to one row on map features. It has a key, one or
more values, one or more feature types and a description.

=head1 FUNCTIONS

=head2 key

=head2 values

=head2 types

Feature type: area, way or node

=head2 description

=cut

sub new {
    my $pkg = shift;
    my $class = ref $pkg || $pkg;
    my $self = bless( {}, $class);

    my $key = shift;
    my $values = shift;
    my @types = @{shift()};
    my $description = shift;

    #
    # Key
    #

    $self->key( new Geo::OSM::MapFeatures::Feature::Key($key) );

    #
    # Value
    #

    # Hack for empty value list
    if( @$values < 1 ){
	    push( @$values, '' );
    }

    foreach my $value ( @$values ){
	    push( @{$self->{values}}, new Geo::OSM::MapFeatures::Feature::Value($value) );
    }

    #
    # Types
    #

    unless( @types ){
	    Carp::croak(sprintf("Trying to construct feature without element types. key=%s value(s)=%s", $self->key, join(' / ', @{$self->values})));
    }
    foreach my $type ( @types ){
        #FIXME: use accessor instead
        push( @{$self->{types}}, new Geo::OSM::MapFeatures::Feature::Type($type) );
    }

    #
    # Description
    #

    $self->description($description);

    return $self;
}

sub stringify {
    my $self = shift;

    return sprintf("%s = %s", $self->{key}, join(' / ', @{ $self->{values} }));
}

=head1 AUTHOR

Knut Arne Bjørndal, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.




=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Geo::OSM::MapFeatures


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 COPYRIGHT & LICENSE

Copyright 2008-2009 Knut Arne Bjørndal, all rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.


=cut

1; # End of Geo::OSM::MapFeatures::Feature