Trees       Indices       Help   
Project Homepage
Package gen :: Package lib :: Module name :: Class Name
[frames] | no frames]

Class Name

source code

Provide name information about a person.

A person may have more that one name throughout his or her life.

Instance Methods
 
__init__(self, source=None, data=None)
Create a new Name instance, copying from the source if provided.		 source code
 
serialize(self)
Convert the object to a serialized tuple of data.		 source code
 
is_empty(self)
Indicate if the name is empty.		 source code
 
unserialize(self, data)
Convert a serialized tuple of data to an object.		 source code
list
get_text_data_list(self)
Return the list of all textual attributes of the object.		 source code
list
get_text_data_child_list(self)
Return the list of child objects that may carry textual data.		 source code
list
get_note_child_list(self)
Return the list of child secondary objects that may refer notes.		 source code
list
get_handle_referents(self)
Return the list of child objects which may, directly or through their children, reference primary objects.		 source code
list
get_referenced_handles(self)
Return the list of (classname, handle) tuples for all directly referenced primary objects.		 source code
 
set_group_as(self, name)
Set the grouping name for a person.		 source code
 
get_group_as(self)
Return the grouping name, which is used to group equivalent surnames.		 source code
 
get_group_name(self)
Return the grouping name, which is used to group equivalent surnames.		 source code
 
set_sort_as(self, value)
Specifies the sorting method for the specified name.		 source code
 
get_sort_as(self)
Return the selected sorting method for the name.		 source code
 
set_display_as(self, value)
Specifies the display format for the specified name.		 source code
 
get_display_as(self)
Return the selected display format for the name.		 source code
 
get_call_name(self)
Return the call name.		 source code
 
set_call_name(self, val)
Set the call name.		 source code
 
get_surname_prefix(self)
Return the prefix (or article) of a surname.		 source code
 
set_surname_prefix(self, val)
Set the prefix (or article) of a surname.		 source code
 
set_type(self, the_type)
Set the type of the Name instance.		 source code
 
get_type(self)
Return the type of the Name instance.		 source code
 
set_first_name(self, name)
Set the given name for the Name instance.		 source code
 
set_patronymic(self, name)
Set the patronymic name for the Name instance.		 source code
 
set_surname(self, name)
Set the surname (or last name) for the Name instance.		 source code
 
set_suffix(self, name)
Set the suffix (such as Jr., III, etc.) for the Name instance.		 source code
 
get_first_name(self)
Return the given name for the Name instance.		 source code
 
get_patronymic(self)
Return the patronymic name for the Name instance.		 source code
 
get_surname(self)
Return the surname (or last name) for the Name instance.		 source code
 
get_upper_surname(self)
Return the surname (or last name) for the Name instance.		 source code
 
get_suffix(self)
Return the suffix for the Name instance.		 source code
 
set_title(self, title)
Set the title (Dr., Reverand, Captain) for the Name instance.		 source code
 
get_title(self)
Return the title for the Name instance.		 source code
 
get_name(self)
Return a name string built from the components of the Name instance, in the form of surname, Firstname.		 source code
 
get_upper_name(self)
Return a name string built from the components of the Name instance, in the form of surname, Firstname.		 source code
 
get_regular_name(self)
Return a name string built from the components of the Name instance, in the form of Firstname surname.		 source code

Inherited from secondaryobj.SecondaryObject: is_equal

Inherited from baseobj.BaseObject: get_referenced_handles_recursively, matches_regexp, matches_string

Inherited from privacybase.PrivacyBase: get_privacy, set_privacy

Inherited from srcbase.SourceBase: add_source_reference, get_source_references, get_sourcref_child_list, has_source_reference, remove_source_references, replace_source_references, set_source_reference_list

Inherited from notebase.NoteBase: add_note, get_note_list, get_referenced_note_handles, remove_note, set_note_list

Inherited from datebase.DateBase: get_date_object, set_date_object

Class Variables
  DEF = 0
  LNFN = 1
  FNLN = 2
  PTFN = 3
  FN = 4
Method Details

__init__(self, source=None, data=None)
(Constructor)

source code 

Create a new Name instance, copying from the source if provided.

Parameters:
  • source - Object used to initialize the new object
Overrides: datebase.DateBase.__init__

serialize(self)

source code 

Convert the object to a serialized tuple of data.

Overrides: datebase.DateBase.serialize

unserialize(self, data)

source code 

Convert a serialized tuple of data to an object.

Overrides: datebase.DateBase.unserialize

get_text_data_list(self)

source code 

Return the list of all textual attributes of the object.

Returns: list
Returns the list of all textual attributes of the object.
Overrides: baseobj.BaseObject.get_text_data_list

get_text_data_child_list(self)

source code 

Return the list of child objects that may carry textual data.

Returns: list
Returns the list of child objects that may carry textual data.
Overrides: baseobj.BaseObject.get_text_data_child_list

get_note_child_list(self)

source code 

Return the list of child secondary objects that may refer notes.

Returns: list
Returns the list of child secondary child objects that may refer notes.
Overrides: notebase.NoteBase.get_note_child_list

get_handle_referents(self)

source code 

Return the list of child objects which may, directly or through their children, reference primary objects.

Returns: list
Returns the list of objects refereincing primary objects.
Overrides: baseobj.BaseObject.get_handle_referents

get_referenced_handles(self)

source code 

Return the list of (classname, handle) tuples for all directly referenced primary objects.

Returns: list
List of (classname, handle) tuples for referenced objects.
Overrides: baseobj.BaseObject.get_referenced_handles

set_group_as(self, name)

source code  

Set the grouping name for a person. 

Normally, this is the person's surname. However, some locales group 
equivalent names (e.g. Ivanova and Ivanov in Russian are usually 
considered equivalent.

Note that there is also a database wide grouping set_name_group_mapping
  So one might map a name Smith to SmithNew, and have one person still
  grouped with name Smith. Hence, group_as can be equal to surname!

set_sort_as(self, value)

source code 

Specifies the sorting method for the specified name.

Typically the locale's default should be used. However, there may be names where a specific sorting structure is desired for a name.

get_sort_as(self)

source code 

Return the selected sorting method for the name.

The options are LNFN (last name, first name), FNLN (first name, last name), etc.

set_display_as(self, value)

source code 

Specifies the display format for the specified name.

Typically the locale's default should be used. However, there may be names where a specific display format is desired for a name.

get_display_as(self)

source code 

Return the selected display format for the name.

The options are LNFN (last name, first name), FNLN (first name, last name), etc.

get_call_name(self)

source code 

Return the call name.

The call name's exact definition is not predetermined, and may be locale specific.

set_call_name(self, val)

source code 

Set the call name.

The call name's exact definition is not predetermined, and may be locale specific.

get_surname_prefix(self)

source code 

Return the prefix (or article) of a surname.

The prefix is not used for sorting or grouping.

set_surname_prefix(self, val)

source code 

Set the prefix (or article) of a surname.

Examples of articles would be 'de' or 'van'.


   Trees       Indices       Help   
Project Homepage
Generated by Epydoc 3.0.1 on Sun Mar 9 21:52:37 2008 http://epydoc.sourceforge.net