Develop an Addon Rule
|
This article's content is incomplete or a placeholder stub. |
Custom Filters are built upon Query Rules. Sometimes a filter rule has not been provided to search the part of the Tree desired. Or the existing Rules can not be combined to isolate the desired part of the Tree. If those particular branches and leaves must be repeatedly isolated, building a query rule might be the next logical step.
Query Rules abstract the underlying complexity of the query and provides a higher-level, simpler interface for users to define search criteria without needing to understand the intricate details of the actual database query language.
Contents
coding style guide (placeholder)
In various rules that allow a Person ID to be selected as a parameter value, both built-in rules & addon rules use inconsistent placeholders:
- <Id>
- <id>
- <person>
It would be better if they were harmonized.
I suspect any variant of <ID> would ambiguous because sometimes these rules (while needing a Person Gramps ID) are in different category custom rules.
What should the standard nomenclature be for the rule names, descriptions & documentation?
Using addons to design and test flight Filter Rule
Designing and optimizing a quality query can be challenging. Even a slow rough-cut query is acceptable for a single-use. But clean and fast code is vital to a frequently used addon Filter Rule.
There are some power tool addons to help when designing queries, testing them and optimize their runtimes.
Particularly, using SuperTool design a rough query, the Query Gramplet to experiment with optimizations, the Generic custom rules to commit the query to a something usable with Custom Filters, and FilterParams to tune is one way to use addons in concert.
Converting a query to an addon Filter Rule
Sample Gramps Plug-in Registration file
#
# GPR (Gramps plug-in Registration) of a Python module
# for Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2018 Paul Culley
#
# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
"""
Filter rule to match an Event Role with a particular value.
"""
register(RULE,
id='HasPersonEventRole',
name=_("People with events with a selected role"),
description=_("Matches people with an event with a selected role"),
version='0.0.14',
authors=["Paul Culley"],
authors_email=["bugs@gramps-project.com"],
gramps_target_version='5.1',
status=STABLE,
fname="hasrolerule.py",
ruleclass='HasPersonEventRole', # must be rule class name
namespace='Person', # one of the primary object classes
)
register(RULE,
id='HasFamilyEventRole',
name=_("Families with events with a selected role"),
description=_("Matches families with an event with a selected role"),
version='0.0.14',
authors=["Paul Culley"],
authors_email=["bugs@gramps-project.com"],
gramps_target_version='5.1',
status=STABLE,
fname="hasrolerule.py",
ruleclass='HasFamilyEventRole', # must be rule class name
namespace='Family', # one of the primary object classes
)
Sample Gramps Plug-in source file
Filenames or Filenames
#
#
# plug-in Python module
# for Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2018 Paul Culley
#
# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
"""
Filter rule to match persons with a particular event.
"""
# -------------------------------------------------------------------------
#
# Standard Python modules
#
# -------------------------------------------------------------------------
# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from gramps.gen.lib.eventroletype import EventRoleType
from gramps.gui.editors.filtereditor import MySelect, MyBoolean
from gramps.gen.filters.rules import Rule
from gramps.gen.const import GRAMPS_LOCALE as glocale
try:
_trans = glocale.get_addon_translator(__file__)
except ValueError:
_trans = glocale.translation
_ = _trans.gettext
class Roletype(MySelect):
""" Provide a Role type selector """
def __init__(self, db):
MySelect.__init__(self, EventRoleType, db.get_event_roles())
class NoMatch(MyBoolean):
""" Provide a negation switch """
def __init__(self, db):
MyBoolean.__init__(self, _("Does NOT match with selected Role"))
self.set_tooltip_text(_("Finds the items that don't have event Roles "
"of the selected type."))
# -------------------------------------------------------------------------
#
# HasEvent
#
# -------------------------------------------------------------------------
class HasPersonEventRole(Rule):
"""Rule that checks for a person with a selected event role"""
labels = [(_('Role'), Roletype),
(_('Inverse'), NoMatch)]
name = _('People with events with the <role>')
description = _("Matches people with an event with a selected role")
category = _('Event filters')
def apply(self, dbase, person):
if not self.list[0]:
return False
for event_ref in person.get_event_ref_list():
if not event_ref:
continue
if self.list[1] == '1':
if event_ref.role.xml_str() != self.list[0]:
return True
else:
if event_ref.role.xml_str() == self.list[0]:
return True
return False
class HasFamilyEventRole(Rule):
"""Rule that checks for a family with a selected event role"""
labels = [(_('Role'), Roletype),
(_('Inverse'), NoMatch)]
name = _('Families with events with the <role>')
description = _("Matches families with an event with a selected role")
category = _('Event filters')
def apply(self, dbase, family):
if not self.list[0]:
return False
for event_ref in family.get_event_ref_list():
if not event_ref:
continue
if self.list[1] == '1':
if event_ref.role.xml_str() != self.list[0]:
return True
else:
if event_ref.role.xml_str() == self.list[0]:
return True
return False
Publishing a new Filter Rule
Update the Rule Expansions wiki page
See also
- Developer documentation
- Filter Gramps Glossary definition
- based on the Gramps-users Gramps Discourse forum archived threads:
- In in MantisBT bug reporter for Gramps
- Feature Requests: search for addon custom filter Rules. (Filter for "filter, rule")
- 0011689: [GrampsAIO-5.1.2-new_libs_win64] Active and Default Person filter rules
