gramps/src/plugins/StatisticsChart.py

985 lines
37 KiB
Python
Raw Normal View History

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2003-2006 Donald N. Allingham
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Statistics plugin (w) 2004-2005 by Eero Tamminen with lots of help
# from Alex Roitman.
#
# To see things still missing, search for "TODO"...
#
# $Id$
"""
Statistics Chart report
"""
#------------------------------------------------------------------------
#
# python modules
#
#------------------------------------------------------------------------
import time
from TransUtils import sgettext as _
#------------------------------------------------------------------------
#
# GNOME/gtk
#
#------------------------------------------------------------------------
import gtk
#------------------------------------------------------------------------
#
# GRAMPS modules
#
#------------------------------------------------------------------------
# Person and relation types
from RelLib import Person, Family
# gender and report type names
import BaseDoc
from PluginUtils import Report, ReportOptions, ReportUtils, register_report
import GenericFilter
import DateHandler
from Utils import ProgressMeter, format_event
#------------------------------------------------------------------------
#
# Global options and their names
#
#------------------------------------------------------------------------
class _options:
# sort type identifiers
SORT_VALUE = 0
SORT_KEY = 1
sorts = [
(SORT_VALUE, "Item count", _("Item count")),
(SORT_KEY, "Item name", _("Item name"))
]
genders = [
(Person.UNKNOWN, "Both", _("Both")),
(Person.MALE, "Men", _("Men")),
(Person.FEMALE, "Women", _("Women"))
]
#------------------------------------------------------------------------
#
# Data extraction methods from the database
#
#------------------------------------------------------------------------
class Extract:
def __init__(self):
"""Methods for extracting statistical data from the database"""
# key, non-localized name, localized name, type method, data method
self.extractors = {
'data_title': ("Title", _("person|Title"),
self.get_person, self.get_title),
2005-12-06 12:08:09 +05:30
'data_sname': ("Surname", _("Surname"),
self.get_person, self.get_surname),
2005-12-06 12:08:09 +05:30
'data_fname': ("Forename", _("Forename"),
self.get_person, self.get_forename),
2005-12-06 12:08:09 +05:30
'data_gender': ("Gender", _("Gender"),
self.get_person, self.get_gender),
2005-12-06 12:08:09 +05:30
'data_byear': ("Birth year", _("Birth year"),
self.get_birth, self.get_year),
2005-12-06 12:08:09 +05:30
'data_dyear': ("Death year", _("Death year"),
self.get_death, self.get_year),
2005-12-06 12:08:09 +05:30
'data_bmonth': ("Birth month", _("Birth month"),
self.get_birth, self.get_month),
2005-12-06 12:08:09 +05:30
'data_dmonth': ("Death month", _("Death month"),
self.get_death, self.get_month),
2005-12-06 12:08:09 +05:30
'data_dcause': ("Cause of death", _("Cause of death"),
self.get_death, self.get_cause),
2005-12-06 12:08:09 +05:30
'data_bplace': ("Birth place", _("Birth place"),
self.get_birth, self.get_place),
2005-12-06 12:08:09 +05:30
'data_dplace': ("Death place", _("Death place"),
self.get_death, self.get_place),
2005-12-06 12:08:09 +05:30
'data_mplace': ("Marriage place", _("Marriage place"),
self.get_marriage_handles, self.get_places),
'data_mcount': ("Number of relationships", _("Number of relationships"),
self.get_family_handles, self.get_handle_count),
2005-12-06 12:08:09 +05:30
'data_fchild': ("Age when first child born", _("Age when first child born"),
self.get_child_handles, self.get_first_child_age),
2005-12-06 12:08:09 +05:30
'data_lchild': ("Age when last child born", _("Age when last child born"),
self.get_child_handles, self.get_last_child_age),
'data_ccount': ("Number of children", _("Number of children"),
self.get_child_handles, self.get_handle_count),
2005-12-06 12:08:09 +05:30
'data_mage': ("Age at marriage", _("Age at marriage"),
self.get_marriage_handles, self.get_event_ages),
2005-12-06 12:08:09 +05:30
'data_dage': ("Age at death", _("Age at death"),
self.get_person, self.get_death_age),
2005-12-06 12:08:09 +05:30
'data_age': ("Age", _("Age"),
self.get_person, self.get_person_age),
2005-12-06 12:08:09 +05:30
'data_etypes': ("Event type", _("Event type"),
self.get_event_handles, self.get_event_type)
}
2005-01-11 05:58:53 +05:30
# ----------------- data extraction methods --------------------
# take an object and return a list of strings
2005-01-11 05:58:53 +05:30
def get_title(self, person):
"return title for given person"
# TODO: return all titles, not just primary ones...
2005-01-11 05:58:53 +05:30
title = person.get_primary_name().get_title()
if title:
return [title]
else:
return [_("(Preferred) title missing")]
2005-01-11 05:58:53 +05:30
def get_forename(self, person):
"return forenames for given person"
# TODO: return all forenames, not just primary ones...
2005-01-11 05:58:53 +05:30
firstnames = person.get_primary_name().get_first_name().strip()
if firstnames:
return [name.capitalize() for name in firstnames.split()]
else:
return [_("(Preferred) forename missing")]
def get_surname(self, person):
"return surnames for given person"
# TODO: return all surnames, not just primary ones...
surnames = person.get_primary_name().get_surname().strip()
if surnames:
return [name.capitalize() for name in surnames.split()]
else:
return [_("(Preferred) surname missing")]
def get_gender(self, person):
"return gender for given person"
2005-01-11 05:58:53 +05:30
# TODO: why there's no Person.getGenderName?
# It could be used by getDisplayInfo & this...
if person.gender == Person.MALE:
return [_("Men")]
if person.gender == Person.FEMALE:
return [_("Women")]
return [_("Gender unknown")]
def get_year(self, event):
"return year for given event"
date = event.get_date_object()
if date:
year = date.get_year()
if year:
return [str(year)]
return [_("Date(s) missing")]
def get_month(self, event):
"return month for given event"
date = event.get_date_object()
if date:
month = date.get_month()
if month:
return [DateHandler.displayer._months[month]]
return [_("Date(s) missing")]
def get_cause(self, event):
"return cause for given event"
cause = event.get_cause()
if cause:
return [cause]
return [_("Cause missing")]
def get_place(self, event):
"return place for given event"
place_handle = event.get_place_handle()
if place_handle:
place = self.db.get_place_from_handle(place_handle).get_title()
if place:
return [place]
return [_("Place missing")]
def get_places(self, data):
"return places for given (person,event_handles)"
places = []
person, event_handles = data
for event_handle in event_handles:
event = self.db.get_event_from_handle(event_handle)
place_handle = event.get_place_handle()
if place_handle:
place = self.db.get_place_from_handle(place_handle).get_title()
if place:
places.append(place)
else:
places.append(_("Place missing"))
return places
def get_person_age(self, person):
"return age for given person, if alive"
death_ref = person.get_death_ref()
if not death_ref:
return [self.estimate_age(person)]
return [_("Already dead")]
def get_death_age(self, person):
"return age at death for given person, if dead"
death_ref = person.get_death_ref()
if death_ref:
return [self.estimate_age(person, death_ref.ref)]
return [_("Still alive")]
def get_event_ages(self, data):
"return ages at given (person,event_handles)"
ages = []
person, event_handles = data
for event_handle in event_handles:
ages.append(self.estimate_age(person, event_handle))
if ages:
return ages
return [_("Events missing")]
def get_event_type(self, data):
"return event types at given (person,event_handles)"
types = []
person, event_handles = data
for event_handle in event_handles:
event = self.db.get_event_from_handle(event_handle)
evtType = format_event( event.get_type() )
types.append(evtType)
if types:
return types
return [_("Events missing")]
def get_first_child_age(self, data):
"return age when first child in given (person,child_handles) was born"
ages, errors = self.get_sorted_child_ages(data)
if ages:
errors.append(ages[0])
return errors
return [_("Children missing")]
def get_last_child_age(self, data):
"return age when last child in given (person,child_handles) was born"
ages, errors = self.get_sorted_child_ages(data)
if ages:
errors.append(ages[-1])
return errors
return [_("Children missing")]
def get_handle_count(self, data):
"return number of handles in given (person,handle_list) used for child count, family count"
return [str(len(data[1]))]
# ------------------- utility methods -------------------------
def get_sorted_child_ages(self, data):
"return (sorted_ages,errors) for given (person,child_handles)"
ages = []
errors = []
person, child_handles = data
for child_handle in child_handles:
child = self.db.get_person_from_handle(child_handle)
birth_ref = child.get_birth_ref()
if birth_ref:
ages.append(self.estimate_age(person, birth_ref.ref))
else:
errors.append(_("Birth missing"))
continue
ages.sort()
return (ages, errors)
def estimate_age(self, person, end=None, begin=None):
"""return estimated age (range) for given person or error message.
age string is padded with spaces so that it can be sorted"""
age = ReportUtils.estimate_age(self.db, person, end, begin)
if age[0] < 0 or age[1] < 0:
# inadequate information
return _("Date(s) missing")
if age[0] == age[1]:
# exact year
return "%3d" % age[0]
else:
# minimum and maximum
return "%3d-%d" % (age[0], age[1])
# ------------------- type methods -------------------------
# take db and person and return suitable gramps object(s)
def get_person(self, person):
"return person"
return person
def get_birth(self, person):
"return birth event for given person or None"
birth_ref = person.get_birth_ref()
if birth_ref:
return self.db.get_event_from_handle(birth_ref.ref)
return None
def get_death(self, person):
"return death event for given person or None"
death_ref = person.get_death_ref()
if death_ref:
return self.db.get_event_from_handle(death_ref.ref)
return None
def get_child_handles(self, person):
"return list of child handles for given person or None"
children = []
for fam_handle in person.get_family_handle_list():
fam = self.db.get_family_from_handle(fam_handle)
for child_handle in fam.get_child_handle_list():
children.append(child_handle)
# TODO: it would be good to return only biological children,
# but GRAMPS doesn't offer any efficient way to check that
# (I don't want to check each children's parent family mother
# and father relations as that would make this *much* slower)
if children:
return (person, children)
return None
def get_marriage_handles(self, person):
"return list of marriage event handles for given person or None"
marriages = []
for family_handle in person.get_family_handle_list():
family = self.db.get_family_from_handle(family_handle)
if family.get_relationship() == Family.MARRIED:
for event_handle in family.get_event_list():
if event_handle:
event = self.db.get_event_from_handle(event_handle)
if event.get_name() == "Marriage":
marriages.append(event_handle)
if marriages:
return (person, marriages)
return None
def get_family_handles(self, person):
"return list of family handles for given person or None"
families = person.get_family_handle_list()
if families:
return (person, families)
return None
def get_event_handles(self, person):
"return list of event handles for given person or None"
events = []
for event_ref in person.get_event_ref_list():
events.append( event_ref.get_reference_handle())
if events:
return (person, events)
return None
# ----------------- data collection methods --------------------
def get_person_data(self, person, collect):
"""Adds data from the database to 'collect' for the given person,
using methods rom the 'collect' data dict tuple
"""
for chart in collect:
# get the information
type_func = chart[2]
data_func = chart[3]
obj = type_func(person) # e.g. get_date()
if obj:
value = data_func(obj) # e.g. get_year()
else:
value = [_("Personal information missing")]
# list of information found
for key in value:
if key in chart[1].keys():
chart[1][key] += 1
else:
chart[1][key] = 1
def collect_data(self, db, filter_func, options, genders,
year_from, year_to, no_years):
"""goes through the database and collects the selected personal
2005-01-11 05:58:53 +05:30
data persons fitting the filter and birth year criteria. The
arguments are:
db - the GRAMPS database
filter_func - filtering function selected by the StatisticsDialog
options - report options_dict which sets which methods are used
genders - which gender(s) to include into statistics
year_from - use only persons who've born this year of after
year_to - use only persons who've born this year or before
2005-05-24 18:38:06 +05:30
no_years - use also people without known birth year
Returns an array of tuple of:
- Extraction method title
- Dict of values with their counts
(- Method)
2005-01-11 05:58:53 +05:30
"""
self.db = db # store for use by methods
data = []
ext = self.extractors
# which methods to use
for key in options:
if options[key] and key in self.extractors:
# localized data title, value dict, type and data method
data.append((ext[key][1], {}, ext[key][2], ext[key][3]))
2005-01-11 05:58:53 +05:30
# go through the people and collect data
for person_handle in filter_func.apply(db, db.get_person_handles(sort_handles=False)):
person = db.get_person_from_handle(person_handle)
# check whether person has suitable gender
if person.gender != genders and genders != Person.UNKNOWN:
2005-01-11 05:58:53 +05:30
continue
# check whether birth year is within required range
birth = self.get_birth(person)
if birth:
birthdate = birth.get_date_object()
if birthdate.get_year_valid():
year = birthdate.get_year()
2005-01-11 05:58:53 +05:30
if not (year >= year_from and year <= year_to):
continue
else:
# if death before range, person's out of range too...
death = self.get_death(person)
if death:
deathdate = death.get_date_object()
if deathdate.get_year_valid() and deathdate.get_year() < year_from:
2005-01-11 05:58:53 +05:30
continue
if not no_years:
# do not accept people who are not known to be in range
continue
self.get_person_data(person, data)
return data
2005-01-12 02:01:51 +05:30
# GLOBAL: required so that we get access to _Extract.extractors[]
# Unfortunately class variables cannot reference instance methods :-/
_Extract = Extract()
#------------------------------------------------------------------------
#
# Statistics report
#
#------------------------------------------------------------------------
class StatisticsChart(Report.Report):
def __init__(self, database, person, options_class):
"""
Creates the Statistics object that produces the report.
2005-01-11 05:58:53 +05:30
Uses the Extractor class to extract the data from the database.
The arguments are:
database - the GRAMPS database instance
person - currently selected person
options_class - instance of the Options class for this report
2005-01-11 05:58:53 +05:30
To see what the options are, check the options help in the options class.
"""
Report.Report.__init__(self,database,person,options_class)
2005-01-11 05:58:53 +05:30
filter_num = options_class.get_filter_number()
filters = options_class.get_report_filters(person)
filters.extend(GenericFilter.CustomFilters.get_filters())
filterfun = filters[filter_num]
2005-01-12 02:01:51 +05:30
options = options_class.handler.options_dict
self.bar_items = options['bar_items']
2005-01-12 02:01:51 +05:30
year_from = options['year_from']
year_to = options['year_to']
gender = options['gender']
2005-01-11 05:58:53 +05:30
# title needs both data extraction method name + gender name
if gender == Person.MALE:
genders = _("Men")
elif gender == Person.FEMALE:
genders = _("Women")
2005-01-11 05:58:53 +05:30
else:
genders = None
# needed for keyword based localization
mapping = {
'genders': genders,
'year_from': year_from,
'year_to': year_to
}
2005-12-06 12:08:09 +05:30
self.progress = ProgressMeter(_('Statistics Charts'))
2005-01-11 05:58:53 +05:30
# extract requested items from the database and count them
2005-12-06 12:08:09 +05:30
self.progress.set_pass(_('Collecting data...'), 1)
tables = _Extract.collect_data(database, filterfun, options,
gender, year_from, year_to, options['no_years'])
2005-12-06 12:08:09 +05:30
self.progress.step()
2005-01-11 05:58:53 +05:30
2005-12-06 12:08:09 +05:30
self.progress.set_pass(_('Sorting data...'), len(tables))
self.data = []
sortby = options['sortby']
reverse = options['reverse']
for table in tables:
# generate sorted item lookup index index
lookup = self.index_items(table[1], sortby, reverse)
# document heading
mapping['chart_title'] = table[0]
if genders:
heading = _("%(genders)s born %(year_from)04d-%(year_to)04d: %(chart_title)s") % mapping
else:
heading = _("Persons born %(year_from)04d-%(year_to)04d: %(chart_title)s") % mapping
2005-12-06 12:08:09 +05:30
self.data.append((heading, table[0], table[1], lookup))
self.progress.step()
#DEBUG
#print heading
#print table[1]
def lookup_compare(self, a, b):
"compare given keys according to corresponding lookup values"
return cmp(self.lookup_items[a], self.lookup_items[b])
def index_items(self, data, sort, reverse):
2005-01-11 05:58:53 +05:30
"""creates & stores a sorted index for the items"""
# sort by item keys
index = data.keys()
2005-01-11 05:58:53 +05:30
index.sort()
if reverse:
index.reverse()
if sort == _options.SORT_VALUE:
2005-01-11 05:58:53 +05:30
# set for the sorting function
self.lookup_items = data
2005-01-11 05:58:53 +05:30
# then sort by value
index.sort(self.lookup_compare)
2005-01-11 05:58:53 +05:30
if reverse:
index.reverse()
return index
2005-01-11 05:58:53 +05:30
def define_graphics_styles(self):
"""
Define the graphics styles used by the report. Paragraph definitions
have already been defined in the document. The styles used are:
SC-title - Contains the SC-Title paragraph style used for
the title of the document
SC-text - Contains the SC-Name paragraph style used for
the individual's name
SC-color-N - The colors for drawing pies.
SC-bar - A red bar with 0.5pt black line.
"""
2005-01-11 05:58:53 +05:30
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style("SC-Title")
g.set_color((0,0,0))
g.set_fill_color((255,255,255))
g.set_line_width(0)
g.set_width(self.doc.get_usable_width())
self.doc.add_draw_style("SC-title",g)
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style("SC-Text")
g.set_color((0,0,0))
g.set_fill_color((255,255,255))
g.set_line_width(0)
self.doc.add_draw_style("SC-text",g)
width = 0.8
self.colors = 7
# red
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style('SC-Text')
g.set_color((0,0,0))
g.set_fill_color((255,0,0))
g.set_line_width(width)
self.doc.add_draw_style("SC-color-0",g)
2005-02-03 02:20:14 +05:30
# orange
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style('SC-Text')
g.set_color((0,0,0))
2005-02-03 02:20:14 +05:30
g.set_fill_color((255,158,33))
g.set_line_width(width)
self.doc.add_draw_style("SC-color-1",g)
2005-02-03 02:20:14 +05:30
# green
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style('SC-Text')
g.set_color((0,0,0))
2005-02-03 02:20:14 +05:30
g.set_fill_color((0,178,0))
g.set_line_width(width)
self.doc.add_draw_style("SC-color-2",g)
2005-02-03 02:20:14 +05:30
# violet
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style('SC-Text')
g.set_color((0,0,0))
2005-02-03 02:20:14 +05:30
g.set_fill_color((123,0,123))
g.set_line_width(width)
self.doc.add_draw_style("SC-color-3",g)
2005-02-03 02:20:14 +05:30
# yellow
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style('SC-Text')
g.set_color((0,0,0))
2005-02-03 02:20:14 +05:30
g.set_fill_color((255,255,0))
g.set_line_width(width)
self.doc.add_draw_style("SC-color-4",g)
2005-02-03 02:20:14 +05:30
# blue
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style('SC-Text')
g.set_color((0,0,0))
2005-02-03 02:20:14 +05:30
g.set_fill_color((0,105,214))
g.set_line_width(width)
self.doc.add_draw_style("SC-color-5",g)
# gray
g = BaseDoc.GraphicsStyle()
g.set_paragraph_style('SC-Text')
g.set_color((0,0,0))
2005-02-03 02:20:14 +05:30
g.set_fill_color((210,204,210))
g.set_line_width(width)
self.doc.add_draw_style("SC-color-6",g)
g = BaseDoc.GraphicsStyle()
g.set_color((0,0,0))
g.set_fill_color((255,0,0))
g.set_line_width(width)
self.doc.add_draw_style("SC-bar",g)
def write_report(self):
2005-01-11 05:58:53 +05:30
"output the selected statistics..."
2005-12-06 12:08:09 +05:30
self.progress.set_pass(_('Saving charts...'), len(self.data))
for data in self.data:
self.doc.start_page()
if len(data[2]) < self.bar_items:
2005-12-06 12:08:09 +05:30
self.output_piechart(data[0], data[1], data[2], data[3])
else:
2005-12-06 12:08:09 +05:30
self.output_barchart(data[0], data[1], data[2], data[3])
self.doc.end_page()
self.progress.step()
self.progress.close()
2005-12-06 12:08:09 +05:30
def output_piechart(self, title, typename, data, lookup):
# set layout variables
middle = self.doc.get_usable_width() / 2
# start output
self.doc.center_text('SC-title', title, middle, 0)
yoffset = ReportUtils.pt2cm(self.doc.style_list['SC-Title'].get_font().get_size())
# collect data for output
color = 0
chart_data = []
for key in lookup:
style = "SC-color-%d" % color
2005-12-06 12:08:09 +05:30
text = "%s (%d)" % (key, data[key])
# graphics style, value, and it's label
2005-12-06 12:08:09 +05:30
chart_data.append((style, data[key], text))
color = (color+1) % self.colors
2005-12-06 12:08:09 +05:30
margin = 1.0
legendx = 2.0
# output data...
2005-12-06 12:08:09 +05:30
radius = middle - 2*margin
yoffset = yoffset + margin + radius
ReportUtils.draw_pie_chart(self.doc, middle, yoffset, radius, chart_data, -90)
2005-12-06 12:08:09 +05:30
yoffset = yoffset + radius + margin
text = _("%s (persons):") % typename
ReportUtils.draw_legend(self.doc, legendx, yoffset, chart_data, text)
2005-12-06 12:08:09 +05:30
def output_barchart(self, title, typename, data, lookup):
pt2cm = ReportUtils.pt2cm
font = self.doc.style_list['SC-Text'].get_font()
2005-01-11 05:58:53 +05:30
# set layout variables
width = self.doc.get_usable_width()
row_h = pt2cm(font.get_size())
2005-01-11 05:58:53 +05:30
max_y = self.doc.get_usable_height() - row_h
pad = row_h * 0.5
2005-12-06 12:08:09 +05:30
# check maximum value
2005-01-11 05:58:53 +05:30
max_value = 0
for key in lookup:
max_value = max(data[key], max_value)
2005-01-11 05:58:53 +05:30
# horizontal area for the gfx bars
2005-12-06 12:08:09 +05:30
margin = 1.0
middle = width/2.0
textx = middle + margin/2.0
stopx = middle - margin/2.0
maxsize = stopx - margin
2005-01-11 05:58:53 +05:30
# start output
2005-12-06 12:08:09 +05:30
self.doc.center_text('SC-title', title, middle, 0)
yoffset = pt2cm(self.doc.style_list['SC-Title'].get_font().get_size())
#print title
2005-01-11 05:58:53 +05:30
2005-12-06 12:08:09 +05:30
# header
yoffset += (row_h + pad)
text = _("%s (persons):") % typename
self.doc.draw_text('SC-text', text, textx, yoffset)
for key in lookup:
2005-01-11 05:58:53 +05:30
yoffset += (row_h + pad)
if yoffset > max_y:
# for graphical report, page_break() doesn't seem to work
self.doc.end_page()
self.doc.start_page()
yoffset = 0
2005-12-06 12:08:09 +05:30
# right align bar to the text
value = data[key]
2005-12-06 12:08:09 +05:30
startx = stopx - (maxsize * value / max_value)
path = ((startx, yoffset),
(stopx, yoffset),
(stopx, yoffset + row_h),
(startx, yoffset + row_h))
2005-01-11 05:58:53 +05:30
self.doc.draw_path('SC-bar', path)
2005-12-06 12:08:09 +05:30
# text after bar
text = "%s (%d)" % (key, data[key])
self.doc.draw_text('SC-text', text, textx, yoffset)
#print key + ":",
2005-01-11 05:58:53 +05:30
return
#------------------------------------------------------------------------
#
# Statistics report options
#
#------------------------------------------------------------------------
class StatisticsChartOptions(ReportOptions.ReportOptions):
"""
Defines options and provides their handling interface.
"""
def __init__(self,name, person_id=None):
ReportOptions.ReportOptions.__init__(self, name, person_id)
def set_new_options(self):
2005-01-11 05:58:53 +05:30
# Options specific for this report
self.options_dict = {
'gender' : Person.UNKNOWN,
'sortby' : _options.SORT_VALUE,
2005-01-12 02:01:51 +05:30
'reverse' : 0,
'year_from' : 1700,
'year_to' : time.localtime()[0],
'no_years' : 0,
'bar_items' : 8
}
for key in _Extract.extractors:
self.options_dict[key] = 0
self.options_dict['data_gender'] = 1
self.options_help = {
'gender' : ("=num", "Genders included",
["%d\t%s" % (item[0], item[1]) for item in _options.genders],
False),
'sortby' : ("=num", "Sort chart items by",
["%d\t%s" % (item[0], item[1]) for item in _options.sorts],
2005-01-12 04:31:54 +05:30
False),
'reverse' : ("=0/1", "Whether to sort in reverse order",
["Do not sort in reverse", "Sort in reverse"],
True),
2005-01-12 02:01:51 +05:30
'year_from' : ("=num", "Birth year from which to include people",
"Earlier than 'year_to' value"),
2005-01-12 02:01:51 +05:30
'year_to' : ("=num", "Birth year until which to include people",
"Smaller than %d" % self.options_dict['year_to']),
2005-05-24 18:38:06 +05:30
'no_years' : ("=0/1", "Whether to include people without known birth years",
["Do not include", "Include"], True),
'bar_items' : ("=num", "Use barchart instead of piechart with this many or more items",
"Number of items with which piecharts still look good...")
}
for key in _Extract.extractors:
self.options_help[key] = ("=0/1", _Extract.extractors[key][0],
2005-12-06 12:08:09 +05:30
["Leave chart with this data out", "Include chart with this data"],
True)
def enable_options(self):
# Semi-common options that should be enabled for this report
self.enable_dict = {
'filter' : 0,
}
2005-01-11 05:58:53 +05:30
def make_default_style(self, default_style):
2005-01-11 05:58:53 +05:30
"""Make the default output style for the Statistics report."""
f = BaseDoc.FontStyle()
f.set_size(10)
f.set_type_face(BaseDoc.FONT_SERIF)
p = BaseDoc.ParagraphStyle()
p.set_font(f)
p.set_alignment(BaseDoc.PARA_ALIGN_RIGHT)
p.set_description(_("The style used for the items and values."))
default_style.add_style("SC-Text",p)
f = BaseDoc.FontStyle()
f.set_size(14)
f.set_type_face(BaseDoc.FONT_SANS_SERIF)
p = BaseDoc.ParagraphStyle()
p.set_font(f)
p.set_alignment(BaseDoc.PARA_ALIGN_CENTER)
p.set_description(_("The style used for the title of the page."))
default_style.add_style("SC-Title",p)
def get_report_filters(self, person):
2005-01-11 05:58:53 +05:30
"""Set up the list of possible content filters."""
if person:
name = person.get_primary_name().get_name()
gramps_id = person.get_gramps_id()
2005-01-11 05:58:53 +05:30
else:
name = 'PERSON'
gramps_id = ''
2005-01-11 05:58:53 +05:30
all = GenericFilter.GenericFilter()
all.set_name(_("Entire Database"))
all.add_rule(GenericFilter.Everyone([]))
des = GenericFilter.GenericFilter()
des.set_name(_("Descendants of %s") % name)
des.add_rule(GenericFilter.IsDescendantOf([gramps_id, 1]))
2005-01-11 05:58:53 +05:30
ans = GenericFilter.GenericFilter()
ans.set_name(_("Ancestors of %s") % name)
ans.add_rule(GenericFilter.IsAncestorOf([gramps_id, 1]))
2005-01-11 05:58:53 +05:30
com = GenericFilter.GenericFilter()
com.set_name(_("People with common ancestor with %s") % name)
com.add_rule(GenericFilter.HasCommonAncestorWith([gramps_id]))
2005-01-11 05:58:53 +05:30
return [all, des, ans, com]
def add_user_options(self, dialog):
"""
Override the base class add_user_options task to add
2005-01-11 05:58:53 +05:30
report specific options
"""
2005-01-11 05:58:53 +05:30
# how to sort the data
self.sort_menu = gtk.combo_box_new_text()
for item_idx in range(len(_options.sorts)):
item = _options.sorts[item_idx]
self.sort_menu.append_text(item[2])
if item[0] == self.options_dict['sortby']:
self.sort_menu.set_active(item_idx)
2005-01-11 05:58:53 +05:30
tip = _("Select how the statistical data is sorted.")
dialog.add_option(_("Sort chart items by"), self.sort_menu, tip)
2005-01-11 05:58:53 +05:30
# sorting order
tip = _("Check to reverse the sorting order.")
2005-01-12 02:01:51 +05:30
self.reverse = gtk.CheckButton(_("Sort in reverse order"))
self.reverse.set_active(self.options_dict['reverse'])
dialog.add_option(None, self.reverse, tip)
self.reverse.show()
2005-01-11 05:58:53 +05:30
# year range
from_adj = gtk.Adjustment(value=self.options_dict['year_from'],
lower=1, upper=time.localtime()[0],
step_incr=1, page_incr=100)
self.from_box = gtk.SpinButton(adjustment=from_adj, digits=0)
to_adj = gtk.Adjustment(value=self.options_dict['year_to'],
lower=1, upper=time.localtime()[0],
step_incr=1, page_incr=100)
self.to_box = gtk.SpinButton(adjustment=to_adj, digits=0)
2005-01-11 05:58:53 +05:30
box = gtk.HBox()
box.add(self.from_box)
box.add(gtk.Label("-"))
box.add(self.to_box)
tip = _("Select year range within which people need to be born to be selected for statistics.")
dialog.add_option(_('People born between'), box, tip)
box.show_all()
2005-05-24 18:38:06 +05:30
# include people without known birth year?
tip = _("Check this if you want people who have no known birth date or year to be accounted also in the statistics.")
self.no_years = gtk.CheckButton(_("Include people without known birth years"))
self.no_years.set_active(self.options_dict['no_years'])
dialog.add_option(None, self.no_years, tip)
self.no_years.show()
2005-01-11 05:58:53 +05:30
# gender selection
self.gender_menu = gtk.combo_box_new_text()
for item_idx in range(len(_options.genders)):
item = _options.genders[item_idx]
self.gender_menu.append_text(item[2])
if item[0] == self.options_dict['gender']:
self.gender_menu.set_active(item_idx)
2005-01-11 05:58:53 +05:30
tip = _("Select which genders are included into statistics.")
2005-01-12 02:01:51 +05:30
dialog.add_option(_("Genders included"), self.gender_menu, tip)
# max. pie item selection
tip = _("With fewer items pie chart and legend will be used instead of a bar chart.")
pie_adj = gtk.Adjustment(value=self.options_dict['bar_items'],
lower=0, upper=20, step_incr=1)
self.bar_items = gtk.SpinButton(adjustment=pie_adj, digits=0)
2005-05-24 18:38:06 +05:30
dialog.add_option(_("Max. items for a pie"), self.bar_items, tip)
# -------------------------------------------------
# List of available charts on a separate option tab
idx = 0
half = (len(_Extract.extractors)+1)/2
hbox = gtk.HBox()
vbox = gtk.VBox()
self.charts = {}
for key in _Extract.extractors:
check = gtk.CheckButton(_Extract.extractors[key][1])
check.set_active(self.options_dict[key])
self.charts[key] = check
vbox.add(check)
idx += 1
if idx == half:
hbox.add(vbox)
vbox = gtk.VBox()
hbox.add(vbox)
tip = _("Mark checkboxes to add charts with indicated data")
2005-12-06 12:08:09 +05:30
dialog.add_frame_option(_("Charts"), "", hbox, tip)
hbox.show_all()
# Note about children
label = gtk.Label(_("Note that both biological and adopted children are taken into account."))
2005-12-06 12:08:09 +05:30
dialog.add_frame_option(_("Charts"), "", label)
def parse_user_options(self, dialog):
"""
Parses the custom options that we have added.
"""
self.options_dict['sortby'] = _options.sorts[self.sort_menu.get_active()][0]
2005-01-12 02:01:51 +05:30
self.options_dict['reverse'] = int(self.reverse.get_active())
self.options_dict['year_to'] = int(self.to_box.get_value_as_int())
self.options_dict['year_from'] = int(self.from_box.get_value_as_int())
2005-01-11 05:58:53 +05:30
self.options_dict['no_years'] = int(self.no_years.get_active())
self.options_dict['gender'] = _options.genders[self.gender_menu.get_active()][0]
self.options_dict['bar_items'] = int(self.bar_items.get_value_as_int())
for key in _Extract.extractors:
self.options_dict[key] = int(self.charts[key].get_active())
#------------------------------------------------------------------------
#
# Register report/options
#
#------------------------------------------------------------------------
register_report(
name = 'statistics_chart',
2005-12-06 12:08:09 +05:30
category = Report.CATEGORY_DRAW,
report_class = StatisticsChart,
options_class = StatisticsChartOptions,
modes = Report.MODE_GUI | Report.MODE_BKI | Report.MODE_CLI,
translated_name = _("Statistics Chart"),
2005-12-06 12:08:09 +05:30
status = (_("Stable")),
author_name="Eero Tamminen",
author_email="",
description= _("Generates statistical bar and pie charts of the people in the database.")
)