The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Data::Timeline - Timelines

SYNOPSIS

    my $timeline = Data::Timeline->new;
    $timeline->entries_push(Data::Timeline::Entry->new(...));
    $timeline->merge_timeline($other_timeline);

DESCRIPTION

This class represents a timeline, which is a collection of timeline entry objects (see Data::Timeline::Entry).

Data::Timeline inherits from Class::Accessor::Complex, Class::Accessor::Constructor, and Class::Accessor::Constructor::Base.

The superclass Class::Accessor::Complex defines these methods and functions:

    carp(), cluck(), croak(), flatten(), mk_abstract_accessors(),
    mk_array_accessors(), mk_boolean_accessors(),
    mk_class_array_accessors(), mk_class_hash_accessors(),
    mk_class_scalar_accessors(), mk_concat_accessors(),
    mk_forward_accessors(), mk_hash_accessors(), mk_integer_accessors(),
    mk_new(), mk_object_accessors(), mk_scalar_accessors(),
    mk_set_accessors(), mk_singleton()

The superclass Class::Accessor defines these methods and functions:

    _carp(), _croak(), _mk_accessors(), accessor_name_for(),
    best_practice_accessor_name_for(), best_practice_mutator_name_for(),
    follow_best_practice(), get(), make_accessor(), make_ro_accessor(),
    make_wo_accessor(), mk_accessors(), mk_ro_accessors(),
    mk_wo_accessors(), mutator_name_for(), set()

The superclass Class::Accessor::Installer defines these methods and functions:

    install_accessor(), subname()

The superclass Class::Accessor::Constructor defines these methods and functions:

    NO_DIRTY(), WITH_DIRTY(), _make_constructor(), mk_constructor(),
    mk_constructor_with_dirty(), mk_singleton_constructor()

The superclass Data::Inherited defines these methods and functions:

    every_hash(), every_list(), flush_every_cache_by_key()

The superclass Class::Accessor::Constructor::Base defines these methods and functions:

    HYGIENIC(), STORE(), clear_dirty(), clear_hygienic(),
    clear_unhygienic(), contains_hygienic(), contains_unhygienic(),
    delete_hygienic(), delete_unhygienic(), dirty(), dirty_clear(),
    dirty_set(), elements_hygienic(), elements_unhygienic(), hygienic(),
    hygienic_clear(), hygienic_contains(), hygienic_delete(),
    hygienic_elements(), hygienic_insert(), hygienic_is_empty(),
    hygienic_size(), insert_hygienic(), insert_unhygienic(),
    is_empty_hygienic(), is_empty_unhygienic(), set_dirty(),
    size_hygienic(), size_unhygienic(), unhygienic(), unhygienic_clear(),
    unhygienic_contains(), unhygienic_delete(), unhygienic_elements(),
    unhygienic_insert(), unhygienic_is_empty(), unhygienic_size()

The superclass Tie::StdHash defines these methods and functions:

    CLEAR(), DELETE(), EXISTS(), FETCH(), FIRSTKEY(), NEXTKEY(), SCALAR(),
    TIEHASH()

METHODS

new
    my $obj = Data::Timeline->new;
    my $obj = Data::Timeline->new(%args);

Creates and returns a new object. The constructor will accept as arguments a list of pairs, from component name to initial value. For each pair, the named component is initialized by calling the method of the same name with the given value. If called with a single hash reference, it is dereferenced and its key/value pairs are set as described before.

clear_entries
    $obj->clear_entries;

Deletes all elements from the array.

count_entries
    my $count = $obj->count_entries;

Returns the number of elements in the array.

entries
    my @values    = $obj->entries;
    my $array_ref = $obj->entries;
    $obj->entries(@values);
    $obj->entries($array_ref);

Get or set the array values. If called without an arguments, it returns the array in list context, or a reference to the array in scalar context. If called with arguments, it expands array references found therein and sets the values.

entries_clear
    $obj->entries_clear;

Deletes all elements from the array.

entries_count
    my $count = $obj->entries_count;

Returns the number of elements in the array.

entries_index
    my $element   = $obj->entries_index(3);
    my @elements  = $obj->entries_index(@indices);
    my $array_ref = $obj->entries_index(@indices);

Takes a list of indices and returns the elements indicated by those indices. If only one index is given, the corresponding array element is returned. If several indices are given, the result is returned as an array in list context or as an array reference in scalar context.

entries_pop
    my $value = $obj->entries_pop;

Pops the last element off the array, returning it.

entries_push
    $obj->entries_push(@values);

Pushes elements onto the end of the array.

entries_set
    $obj->entries_set(1 => $x, 5 => $y);

Takes a list of index/value pairs and for each pair it sets the array element at the indicated index to the indicated value. Returns the number of elements that have been set.

entries_shift
    my $value = $obj->entries_shift;

Shifts the first element off the array, returning it.

entries_splice
    $obj->entries_splice(2, 1, $x, $y);
    $obj->entries_splice(-1);
    $obj->entries_splice(0, -1);

Takes three arguments: An offset, a length and a list.

Removes the elements designated by the offset and the length from the array, and replaces them with the elements of the list, if any. In list context, returns the elements removed from the array. In scalar context, returns the last element removed, or undef if no elements are removed. The array grows or shrinks as necessary. If the offset is negative then it starts that far from the end of the array. If the length is omitted, removes everything from the offset onward. If the length is negative, removes the elements from the offset onward except for -length elements at the end of the array. If both the offset and the length are omitted, removes everything. If the offset is past the end of the array, it issues a warning, and splices at the end of the array.

entries_unshift
    $obj->entries_unshift(@values);

Unshifts elements onto the beginning of the array.

index_entries
    my $element   = $obj->index_entries(3);
    my @elements  = $obj->index_entries(@indices);
    my $array_ref = $obj->index_entries(@indices);

Takes a list of indices and returns the elements indicated by those indices. If only one index is given, the corresponding array element is returned. If several indices are given, the result is returned as an array in list context or as an array reference in scalar context.

pop_entries
    my $value = $obj->pop_entries;

Pops the last element off the array, returning it.

push_entries
    $obj->push_entries(@values);

Pushes elements onto the end of the array.

set_entries
    $obj->set_entries(1 => $x, 5 => $y);

Takes a list of index/value pairs and for each pair it sets the array element at the indicated index to the indicated value. Returns the number of elements that have been set.

shift_entries
    my $value = $obj->shift_entries;

Shifts the first element off the array, returning it.

splice_entries
    $obj->splice_entries(2, 1, $x, $y);
    $obj->splice_entries(-1);
    $obj->splice_entries(0, -1);

Takes three arguments: An offset, a length and a list.

Removes the elements designated by the offset and the length from the array, and replaces them with the elements of the list, if any. In list context, returns the elements removed from the array. In scalar context, returns the last element removed, or undef if no elements are removed. The array grows or shrinks as necessary. If the offset is negative then it starts that far from the end of the array. If the length is omitted, removes everything from the offset onward. If the length is negative, removes the elements from the offset onward except for -length elements at the end of the array. If both the offset and the length are omitted, removes everything. If the offset is past the end of the array, it issues a warning, and splices at the end of the array.

unshift_entries
    $obj->unshift_entries(@values);

Unshifts elements onto the beginning of the array.

merge_timeline
    $timeline->merge_timeline($other_timeline);

Takes a timeline object and merges its entries into this timeline. The resulting entry collection is sorted by timestamp.

filter_timeline_by_type
    my $other_timeline = $timeline->filter_timeline_by_type('iscrobbler');

Takes a string argument and returns a new timeline object containing only those entries that match the given entry type.

Returns a new timeline object

filter_timeline_by_date
    my $other_timeline = $timeline->filter_timeline_by_date($from, $to);

Takes two DateTime objects and returns a new timeline object containing only those entries that occurred at or after the first argument and at or before the second argument.

TAGS

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the datatimeline tag.

VERSION

This document describes version 0.02 of Data::Timeline.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to <bug-data-timeline@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2007 by Marcel Grünauer

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