Gramps 3.0 Wiki Manual - Filters

From Gramps
Jump to: navigation, search

This appendix lists of all the filter rules currently defined in GRAMPS. Each of these rules is available for use when creating custom filters, see tools-util-cfe . The rules are listed by their categories.

Gnome-important.png Special copyright notice: All edits to this page need to be under two different copyright licenses:

These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [http://www.gramps-project.org/...]), not via internal links.<br\> Also, only use the known conventions


Previous Index Next



Custom Filter Editor

Fig.3.x Define filter

The Custom Filter Editor builds custom filters that can be used to select people included in reports, exports, and other tools and utilities. This is in fact a very powerful tool in genealogical analysis.

When you launch it, the User defined filters dialog appears that lists all the filters (if any) previously defined by you. Click the Add... button to define a new filter. Once you have designed your filters, you can edit, test, and delete selected filters using the Edit... , Test... , and Delete buttons, respectively. All the filters displayed in the list will be automatically saved along with your database and will be available with subsequent sessions of GRAMPS.

Gramps-notes.png
Changes on filters

The changes made to the filters only take effect when you click the Apply and close button.

Clicking the Add... button invokes the following Define filter dialog:


Type the name for your new filter into the Name field.

Enter any comment that would help you identify this filter in the future into the Comment field. Add as many rules to the Rule list as you would like to your filter using Add... button. If the filter has more than one rule, select one of the Rule operations . This allows you to choose whether all rules must apply, only one (either) rule must apply, or exactly one (either) rule must apply, in order for the filter to generate a match. If your filter has only one rule, this selection has no effect.

Check Return values that do not match the filter rules to invert the filter rule. For example, inverting "has a common ancestor with I1" rule will match everyone who does not have a common ancestor with that person).

Clicking the Add... button invokes the following Add Rule dialog:

Fig.3.x Add rule

The pane on the left-hand side displays available filter rules arranged by their categories in an expandable tree. For detailed filter rule reference, see append-filtref . Click on the arrows to fold/unfold the appropriate category. Select the rule from the tree by clicking on its name. The right-hand side displays the name, the description, and the values for the currently selected rule. Once you are satisfied with your rule selection and its values, click OK to add this rule to the rule list of the currently edited filter. Clicking Cancel will abort adding the rule to the filter.

Gnome-important.png
Tip

A filter you have already designed may be used as a rule for another filter. This gives you nearly infinite flexibility in custom-tailoring your selection criteria that can be later used in most of the exports, reports, and some of the tools (such as comparing individual events).


General filters

This category includes the following most general rules:

  • Has complete record

This rule matches all people whose records are marked as complete. Currently, the completeness of personal information is marked manually, in the Edit Person dialog.

  • People with incomplete names

This rule matches all people with either given name or family name missing.

  • Is bookmarked person

This rule matches all people who are on the bookmark list.

  • Has text matching substring of

This rule matches all people whose records contain specified substring. All textual records are searched. Optionally, the search can be made case sensitive, or a regular expression match.

  • Everyone

This rule matches any person in the database. As such it is not very useful on its own except for testing purposes. However, it may be useful in combinations with other rules.

  • People probably alive

This rule matches all people whose records do not indicate their death and who are not unreasonably old, judging by their available birth data and today's date.

  • Has a name

This rule matches any person whose name matches the specified value in full or in part. For example, Marta Ericsdotter will be matched by the rule using the value "eric" for the family name.

Separate values can be used for Given name, Family name, Suffix, and the Title. The rule returns a match if, and only if, all non-empty values are (partially) matched by a person's name. To use just one value, leave the other values empty.

  • Has the Id

This rule matches any person with a specified GRAMPS ID. The rule returns a match only if the ID is matched exactly.

You can either enter the ID into a text entry field, or select a person from the list by clicking Select... button. In the latter case, the ID will appear in the text field after the selection was made.

  • Is default person

This rule matches the default (home) person.

  • People marked private

This rule matches people whose records are marked as private.

  • Is a female

This rule matches any female person.

  • People who have images

This rule matches people with images in their galleries.

  • People without a birth date

This rule matches people missing birth date.

  • Is a male

This rule matches any male person.

Event filters

This category includes the following rules that match people based on their recorded events:

  • Has the birth: This rule matches people whose birth event matches specified values for Date, Place, and Description. The rule returns a match even if the person's birth event matches the value partially. The matching rules are case-insensitive. For example, anyone born in Sweden will be matched by the rule using the value "sw" for the Place.

The rule returns a match if, and only if, all non-empty values are (partially) matched by a person's birth. To use just one value, leave the other values empty.

  • Has the death: This rule matches people whose death event matches specified values for Date, Place, and Description. The rule returns a match even if the person's death event matches the value partially. The matching rules are case-insensitive. For example, anyone who died in Sweden will be matched by the rule using the value "sw" for the Place.

The rule returns a match if, and only if, all non-empty values are (partially) matched by a person's death. To use just one value, leave the other values empty.

  • Has source of: This rule matches people whose records refer to the specified source.
  • Has the personal event: This rule matches people that have a personal event matching specified values for the Event type, Date, Place, and Description. The rule returns a match even if the person's event matches the value partially. The matching rules are case-insensitive. For example, anyone who graduated in Sweden will be matched by the rule using the Graduation event and the value "sw" for the Place.

The personal events should be selected from a pull-down menu. The rule returns a match if, and only if, all non-empty values are (partially) matched by the personal event. To use just one value, leave the other values empty.

  • Has the family event: This rule matches people that have a family event matching specified values for the Event type, Date, Place, and Description. The rule returns a match even if the person's event matches the value partially. The matching rules are case-insensitive. For example, anyone who was married in Sweden will be matched by the rule using the Marriage event and the value "sw" for the Place.

The family events should be selected from a pull-down menu. The rule returns a match if, and only if, all non-empty values are (partially) matched by the personal event. To use just one value, leave the other values empty.

  • Witness: This rule matches people who are present as a witness in the event. If the personal or family event type is specified, only the events of this type will be searched.
  • People with incomplete events: This rule matches people missing date or place in any personal event.
  • Families with incomplete events: This rule matches people missing date or place in any family event of any of their families.

Family filters

This category includes the following rules that match people based on their family relationships:

  • People with children

This rule matches people with children.

  • People with multiple marriage records

This rule matches people with more than one spouse.

  • People with no marriage records

This rule matches people with no spouses.

  • People who were adopted

This rule matches adopted people.

  • Has the relationships

This rule matches people with a particular relationship. The relationship must match the type selected from the menu. Optionally, the number of relationships and the number of children can be specified.

The rule returns a match if, and only if, all non-empty values are (partially) matched by a person's relationship. To use just one value, leave the other values empty.

  • Is spouse of filter match

This rule matches people married to someone who is matched by the specified filter. The specified filter name should be selected from the menu.

  • Is a child of filter match

This rule matches people for whom either parent is matched by the specified filter. The specified filter name should be selected from the menu.

  • Is a parent of filter match

This rule matches people whose child is matched by the specified filter. The specified filter name should be selected from the menu.

  • Is a sibling of filter match

This rule matches people whose sibling is matched by the specified filter. The specified filter name should be selected from the menu.

Ancestral filters

This category includes the following rules that match people based on their ancestral relations to other people:

  • Is an ancestor of

This rule matches people who are ancestors of the specified person. The Inclusive option determines whether the specified person should be considered his/her own ancestor (useful for building reports).

You can either enter the ID into a text entry field, or select a person from the list by clicking Select... button. In the latter case, the ID will appear in the text field after the selection was made.

  • Is an ancestor of person at least N generations away

This rule matches people who are ancestors of the specified person and are at least N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match grandparents, great-grandparents, etc., but not the parents of the specified person.

  • Is an ancestor of person not more than N generations away

This rule matches people who are ancestors of the specified person and are no more than N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match parents and grandparents, but not great-grandparents, etc., of the specified person.

  • Has a common ancestor with

This rule matches people who have common ancestors with the specified person.

  • Has a common ancestor with filter match

This rule matches people who have common ancestors with someone who is matched by the specified filter. The specified filter name should be selected from the menu.

  • Is an ancestor of filter match

This rule matches people who are ancestors of someone who is matched by the specified filter. The specified filter name should be selected from the menu.

Descendant filters

This category includes the following rules that match people based on their descendant relations to other people:

  • Is a descendant of

This rule matches people who are descendants of the specified person. The Inclusive option determines whether the specified person should be considered his/her own descendant (useful for building reports).

You can either enter the ID into a text entry field, or select a person from the list by clicking Select... button. In the latter case, the ID will appear in the text field after the selection was made.

  • Is a descendant of person at least N generations away

This rule matches people who are descendants of the specified person and are at least N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match grandchildren, great-grandchildren, etc., but not the children of the specified person.

  • Is a descendant of person not more than N generations away

This rule matches people who are descendants of the specified person and are no more than N generations away from that person in their lineage. For example, using this rule with the value of 2 for the number of generations will match children and grandchildren, but not great-grandchildren, etc., of the specified person.

  • Is a descendant of filter match

This rule matches people who are descendants of someone who is matched by the specified filter. The specified filter name should be selected from the menu.

  • Is a descendant family member of

This rule not only matches people who are descendants of the specified person, but also those descendants' spouses.

Relationship filters

This category includes the following rules that match people based on their mutual relationship:

  • Relationship path between two people

This rule matches all ancestors of both people back to their common ancestors (if exist). This produces the "relationship path" between these two people, through their common ancestors.

You can either enter the ID of each person into the appropriate text entry fields, or select people from the list by clicking their Select... buttons. In the latter case, the ID will appear in the text field after the selection was made.

Miscellaneous filters

This category includes the following rules which do not naturally fit into any of the above categories:

  • Has the personal attribute

This rule matches people who have the personal attribute of the specified value. The specified personal attribute name should be selected from the menu. The specified value should be typed into the text entry field.

  • Has the family attribute

This rule matches people who have the family attribute of the specified value. The specified family attribute should be selected from the menu. The specified value should be typed into the text entry field.

  • Matches the filter named

This rule matches people who are matched by the specified filter. The specified filter name should be selected from the menu.

Previous Index Next