Package gen :: Package lib :: Module srcref :: Class SourceRef

[frames] | no frames]

Class SourceRef

source code

Source reference, containing detailed information about how a referenced source relates to it.

Instance Methods

__init__(self, source=None)
Create a new SourceRef, copying from the source if present.

source code

serialize(self)
Convert the object to a serialized tuple of data.

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_referenced_handles(self)
Return the list of (classname, handle) tuples for all directly referenced primary objects.

source code

set_confidence_level(self, val)
Set the confidence level.

source code

get_confidence_level(self)
Return the confidence level.

source code

set_page(self, page)
Set the page indicator of the SourceRef.

source code

get_page(self)
Get the page indicator of the SourceRef.

source code

are_equal(self, other)
Deprecated function - use are_equal instead.

source code

Inherited from secondaryobj.SecondaryObject: is_equal

Inherited from baseobj.BaseObject: get_handle_referents, get_referenced_handles_recursively, get_text_data_child_list, matches_regexp, matches_string

Inherited from datebase.DateBase: get_date_object, set_date_object

Inherited from privacybase.PrivacyBase: get_privacy, set_privacy

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

Inherited from refbase.RefBase: get_reference_handle, set_reference_handle

Class Variables
	CONF_VERY_HIGH = `4`
	CONF_HIGH = `3`
	CONF_NORMAL = `2`
	CONF_LOW = `1`
	CONF_VERY_LOW = `0`

Method Details

init(self, source=None)
(Constructor)

source code

Create a new SourceRef, copying from the source if present.

Parameters:

source - Object used to initialize the new object

Overrides: refbase.RefBase.__init__

serialize(self)

source code

Convert the object to a serialized tuple of data.

Overrides: refbase.RefBase.serialize

unserialize(self, data)

source code

Convert a serialized tuple of data to an object.

Overrides: refbase.RefBase.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_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: refbase.RefBase.get_referenced_handles

Class SourceRef

__init__(self, source=None) (Constructor)

serialize(self)

unserialize(self, data)

get_text_data_list(self)

get_referenced_handles(self)

init(self, source=None)
(Constructor)