Package gen :: Package proxy :: Module private

[frames] | no frames]

Module private

Proxy class for the GRAMPS databases. Filter out all data marked private.

Classes
	PrivateProxyDb A proxy to a Gramps database.

Functions

copy_media_ref_list(db, original_obj, clean_obj)
Copies media references from one object to another - excluding private references and references to private objects.

source code

copy_source_ref_list(db, original_obj, clean_obj)
Copies source references from one object to another - excluding private references and references to private objects.

source code

copy_notes(db, original_obj, clean_obj)
Copies notes from one object to another - excluding references to private notes.

source code

copy_attributes(db, original_obj, clean_obj)
Copies attributes from one object to another - excluding references to private attributes.

source code

copy_urls(db, original_obj, clean_obj)
Copies urls from one object to another - excluding references to private urls.

source code

copy_lds_ords(db, original_obj, clean_obj)
Copies LDS ORDs from one object to another - excluding references to private LDS ORDs.

source code

copy_addresses(db, original_obj, clean_obj)
Copies addresses from one object to another - excluding references to private addresses.

source code

Name

sanitize_name(db, name)
Create a new Name instance based off the passed Name instance.

source code

EventRef

sanitize_event_ref(db, event_ref)
Create a new EventRef instance based off the passed EventRef instance.

source code

Person

sanitize_person(db, person)
Create a new Person instance based off the passed Person instance.

source code

Source

sanitize_source(db, source)
Create a new Source instance based off the passed Source instance.

source code

MediaObject

sanitize_media(db, media)
Create a new MediaObject instance based off the passed Media instance.

source code

Place

sanitize_place(db, place)
Create a new Place instance based off the passed Place instance.

source code

Event

sanitize_event(db, event)
Create a new Event instance based off the passed Event instance.

source code

Family

sanitize_family(db, family)
Create a new Family instance based off the passed Family instance.

source code

Repository

sanitize_repository(db, repository)
Create a new Repository instance based off the passed Repository instance.

source code

Imports: MediaRef, SourceRef, Attribute, Address, EventRef, Person, Name, Source, RepoRef, MediaObject, Place, Event, Family, ChildRef, Repository, ProxyDbBase

Function Details

copy_media_ref_list(db, original_obj, clean_obj)

Copies media references from one object to another - excluding private references and references to private objects.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the references belongs
original_obj (MediaBase) - Object that may have private references
clean_obj - Object that will have only non-private references

Returns:

Nothing

copy_source_ref_list(db, original_obj, clean_obj)

Copies source references from one object to another - excluding private references and references to private objects.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the references belongs
original_obj (SourceBase) - Object that may have private references
clean_obj - Object that will have only non-private references

Returns:

Nothing

copy_notes(db, original_obj, clean_obj)

Copies notes from one object to another - excluding references to private notes.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the references belongs
original_obj (NoteBase) - Object that may have private references
clean_obj - Object that will have only non-private references

Returns:

Nothing

copy_attributes(db, original_obj, clean_obj)

Copies attributes from one object to another - excluding references to private attributes.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the references belongs
original_obj (AttributeBase) - Object that may have private references
clean_obj - Object that will have only non-private references

Returns:

Nothing

copy_urls(db, original_obj, clean_obj)

Copies urls from one object to another - excluding references to private urls.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the references belongs
original_obj (UrlBase) - Object that may have urls
clean_obj - Object that will have only non-private urls

Returns:

Nothing

copy_lds_ords(db, original_obj, clean_obj)

Copies LDS ORDs from one object to another - excluding references to private LDS ORDs.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the references belongs
original_obj (LdsOrdBase) - Object that may have LDS ORDs
clean_obj - Object that will have only non-private LDS ORDs

Returns:

Nothing

copy_addresses(db, original_obj, clean_obj)

Copies addresses from one object to another - excluding references to private addresses.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the references belongs
original_obj (AddressBase) - Object that may have addresses
clean_obj - Object that will have only non-private addresses

Returns:

Nothing

sanitize_name(db, name)

Create a new Name instance based off the passed Name instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
name (Name) - source Name object that will be copied with privacy records removed

Returns: Name

'cleansed' Name object

sanitize_event_ref(db, event_ref)

Create a new EventRef instance based off the passed EventRef instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
event_ref (EventRef) - source EventRef object that will be copied with privacy records removed

Returns: EventRef

'cleansed' EventRef object

sanitize_person(db, person)

Create a new Person instance based off the passed Person instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
person (Person) - source Person object that will be copied with privacy records removed

Returns: Person

'cleansed' Person object

sanitize_source(db, source)

Create a new Source instance based off the passed Source instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
source (Source) - source Source object that will be copied with privacy records removed

Returns: Source

'cleansed' Source object

sanitize_media(db, media)

Create a new MediaObject instance based off the passed Media instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
media (MediaObject) - source Media object that will be copied with privacy records removed

Returns: MediaObject

'cleansed' Media object

sanitize_place(db, place)

Create a new Place instance based off the passed Place instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
place (Place) - source Place object that will be copied with privacy records removed

Returns: Place

'cleansed' Place object

sanitize_event(db, event)

Create a new Event instance based off the passed Event instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
event (Event) - source Event object that will be copied with privacy records removed

Returns: Event

'cleansed' Event object

sanitize_family(db, family)

Create a new Family instance based off the passed Family instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
family (Family) - source Family object that will be copied with privacy records removed

Returns: Family

'cleansed' Family object

sanitize_repository(db, repository)

Create a new Repository instance based off the passed Repository instance. The returned instance has all private records removed from it.

Parameters:

db (GrampsDbBase) - GRAMPS database to which the Person object belongs
repository (Repository) - source Repsitory object that will be copied with privacy records removed

Returns: Repository

'cleansed' Repository object