Skip to content

Commit

Permalink
Add rule 'having note of type' for citation, event, family, person, p…
Browse files Browse the repository at this point in the history
…lace and source.
  • Loading branch information
royas committed Aug 21, 2024
1 parent e84b26d commit ea36845
Show file tree
Hide file tree
Showing 13 changed files with 387 additions and 0 deletions.
75 changes: 75 additions & 0 deletions gramps/gen/filters/rules/_hasnotetypebase.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2002-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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

"""
Rule that checks for a note of a particular type.
"""

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from ...const import GRAMPS_LOCALE as glocale
from ...lib.notetype import NoteType
from . import Rule

_ = glocale.translation.gettext


# -------------------------------------------------------------------------
#
# HasType
#
# -------------------------------------------------------------------------
class HasNoteTypeBase(Rule):
"""
Objects having note of particular type.
"""

labels = [_("Note type:")]
name = _("Objects with notes with the particular type")
description = _("Matches notes with the particular type ")
category = _("General filters")

def __init__(self, arg, use_regex=False, use_case=False):
super().__init__(arg, use_regex, use_case)
self.note_type = None

def prepare(self, db, user):
"""
Prepare the rule. Things we only want to do once.
"""
if self.list[0]:
self.note_type = NoteType()
self.note_type.set_from_xml_str(self.list[0])

def apply(self, db, obj):
"""
Apply the rule. Return True on a match.
"""
notelist = obj.get_note_list()
for notehandle in notelist:
note = db.get_note_from_handle(notehandle)
if note.get_type() == self.note_type:
return True
return False


2 changes: 2 additions & 0 deletions gramps/gen/filters/rules/citation/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
from ._hasnote import HasNote
from ._hasnotematchingsubstringof import HasNoteMatchingSubstringOf
from ._hasnoteregexp import HasNoteRegexp
from ._hasnotetype import HasNoteType
from ._hasreferencecountof import HasReferenceCountOf
from ._hassource import HasSource
from ._hassourceidof import HasSourceIdOf
Expand All @@ -56,6 +57,7 @@
HasIdOf,
HasNote,
HasNoteRegexp,
HasNoteType,
HasReferenceCountOf,
HasSource,
HasSourceIdOf,
Expand Down
50 changes: 50 additions & 0 deletions gramps/gen/filters/rules/citation/_hasnotetype.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2002-2007 Donald N. Allingham
# Copyright (C) 2007-2008 Brian G. Matherly
# Copyright (C) 2008 Jerome Rapinat
# Copyright (C) 2008 Benny Malengier
# Copyright (C) 2011 Tim G L Lyons
#
# 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.
#

# -------------------------------------------------------------------------
#
# Standard Python modules
#
# -------------------------------------------------------------------------
from ....const import GRAMPS_LOCALE as glocale

_ = glocale.translation.gettext

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from .._hasnotetypebase import HasNoteTypeBase


# -------------------------------------------------------------------------
# "Sources having notes"
# -------------------------------------------------------------------------
class HasNoteType(HasNoteTypeBase):
"""Citations having note of particular type"""

name = _("Citations having note of particular type")
description = _("Matches citations having note of the particular type")
category = _("Note filters")
2 changes: 2 additions & 0 deletions gramps/gen/filters/rules/event/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
from ._hasnote import HasNote
from ._hasnoteregexp import HasNoteRegexp
from ._hasnotematchingsubstringof import HasNoteMatchingSubstringOf
from ._hasnotetype import HasNoteType
from ._hasreferencecountof import HasReferenceCountOf
from ._hassourcecount import HasSourceCount
from ._eventprivate import EventPrivate
Expand All @@ -58,6 +59,7 @@
HasCitation,
HasNote,
HasNoteRegexp,
HasNoteType,
HasReferenceCountOf,
HasSourceCount,
EventPrivate,
Expand Down
50 changes: 50 additions & 0 deletions gramps/gen/filters/rules/event/_hasnotetype.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2002-2007 Donald N. Allingham
# Copyright (C) 2007-2008 Brian G. Matherly
# Copyright (C) 2008 Jerome Rapinat
# Copyright (C) 2008 Benny Malengier
# Copyright (C) 2011 Tim G L Lyons
#
# 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.
#

# -------------------------------------------------------------------------
#
# Standard Python modules
#
# -------------------------------------------------------------------------
from ....const import GRAMPS_LOCALE as glocale

_ = glocale.translation.gettext

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from .._hasnotetypebase import HasNoteTypeBase


# -------------------------------------------------------------------------
# "Sources having notes"
# -------------------------------------------------------------------------
class HasNoteType(HasNoteTypeBase):
"""Citations having note of particular type"""

name = _("Events having note of particular type")
description = _("Matches events having note of the particular type")
category = _("Note filters")
2 changes: 2 additions & 0 deletions gramps/gen/filters/rules/family/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
from ._hasnote import HasNote
from ._hasnoteregexp import HasNoteRegexp
from ._hasnotematchingsubstringof import HasNoteMatchingSubstringOf
from ._hasnotetype import HasNoteType
from ._hassourcecount import HasSourceCount
from ._hassourceof import HasSourceOf
from ._hasreferencecountof import HasReferenceCountOf
Expand Down Expand Up @@ -69,6 +70,7 @@
HasIdOf,
HasLDS,
HasNote,
HasNoteType,
RegExpIdOf,
HasNoteRegexp,
HasReferenceCountOf,
Expand Down
50 changes: 50 additions & 0 deletions gramps/gen/filters/rules/family/_hasnotetype.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2002-2007 Donald N. Allingham
# Copyright (C) 2007-2008 Brian G. Matherly
# Copyright (C) 2008 Jerome Rapinat
# Copyright (C) 2008 Benny Malengier
# Copyright (C) 2011 Tim G L Lyons
#
# 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.
#

# -------------------------------------------------------------------------
#
# Standard Python modules
#
# -------------------------------------------------------------------------
from ....const import GRAMPS_LOCALE as glocale

_ = glocale.translation.gettext

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from .._hasnotetypebase import HasNoteTypeBase


# -------------------------------------------------------------------------
# "Sources having notes"
# -------------------------------------------------------------------------
class HasNoteType(HasNoteTypeBase):
"""Citations having note of particular type"""

name = _("Families having note of particular type")
description = _("Matches families having note of the particular type")
category = _("Note filters")
2 changes: 2 additions & 0 deletions gramps/gen/filters/rules/person/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
from ._hasnote import HasNote
from ._hasnotematchingsubstringof import HasNoteMatchingSubstringOf
from ._hasnoteregexp import HasNoteRegexp
from ._hasnotetype import HasNoteType
from ._hasothergender import HasOtherGender
from ._hasrelationship import HasRelationship
from ._hassourcecount import HasSourceCount
Expand Down Expand Up @@ -187,6 +188,7 @@
RelationshipPathBetweenBookmarks,
HasTextMatchingSubstringOf,
HasNote,
HasNoteType,
HasNoteRegexp,
RegExpIdOf,
RegExpName,
Expand Down
50 changes: 50 additions & 0 deletions gramps/gen/filters/rules/person/_hasnotetype.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2002-2007 Donald N. Allingham
# Copyright (C) 2007-2008 Brian G. Matherly
# Copyright (C) 2008 Jerome Rapinat
# Copyright (C) 2008 Benny Malengier
# Copyright (C) 2011 Tim G L Lyons
#
# 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.
#

# -------------------------------------------------------------------------
#
# Standard Python modules
#
# -------------------------------------------------------------------------
from ....const import GRAMPS_LOCALE as glocale

_ = glocale.translation.gettext

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from .._hasnotetypebase import HasNoteTypeBase


# -------------------------------------------------------------------------
# "Sources having notes"
# -------------------------------------------------------------------------
class HasNoteType(HasNoteTypeBase):
"""Persons having note of particular type"""

name = _("Persons having note of particular type")
description = _("Matches persons having note of the particular type")
category = _("Note filters")
2 changes: 2 additions & 0 deletions gramps/gen/filters/rules/place/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
from ._hasnote import HasNote
from ._hasnoteregexp import HasNoteRegexp
from ._hasnotematchingsubstringof import HasNoteMatchingSubstringOf
from ._hasnotetype import HasNoteType
from ._hasreferencecountof import HasReferenceCountOf
from ._hassourcecount import HasSourceCount
from ._hassourceof import HasSourceOf
Expand All @@ -57,6 +58,7 @@
RegExpIdOf,
HasNote,
HasNoteRegexp,
HasNoteType,
HasReferenceCountOf,
HasSourceCount,
HasSourceOf,
Expand Down
Loading

0 comments on commit ea36845

Please sign in to comment.