NAME
App::JobLog::Log::Note - timestamped annotation in log
VERSION
version 1.042
DESCRIPTION
A wrapper for a log line that represents a timestamped and optionally tagged note.
METHODS
new
Basic constructor. Expects single App::JobLog::Log::Line argument. Can be called on instance or class.
clone
Create a duplicate of this event.
data
Returns App::JobLog::Log::Line object on which this event is based.
start
Start of event. Is lvalue method.
tags
Tags of event (array reference). Is lvalue method.
tagged
Whether there are any tags.
tag_list
Returns tags as list rather than reference.
describe
Returns the log line's description.
exists_tag
Expects a list of tags. Returns true if event contains any of them.
all_tags
Expects a list of tags. Returns whether event contains all of them.
cmp
Used to sort events. E.g.,
my @sorted_events = sort { $a->cmp($b) } @unsorted;split_days
Returns note itself. This method is overridden by the event object and used in event summarization.
intersects
Whether this note overlaps the given period.
is_note
Whether this "note" (events are a subclass of note) is just a note.
is_open
Returns false: notes have no duration so they cannot be open.
AUTHOR
David F. Houghton <dfhoughton@gmail.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by David F. Houghton.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.