Dee-1.0 Python API Documentation

Class: Dee.Analyzer

Known subclasses: Dee.TextAnalyzer

All fields in the DeeAnalyzer structure are private and should never be accessed directly

Constructors

 new()

Methods

voidadd_term_filter(filter_func, filter_data, filter_destroy)

voidanalyze(data, terms_out, colkeys_out)

intcollate_cmp(key1, key2)

intcollate_cmp_func(key1, key2, analyzer)(static method)

stringcollate_key(data)

voidtokenize(data, terms_out)

Class: Dee.Client

Subclass of: Dee.Peer

Properties

string"bus-address"construct-only

Constructors

 new(swarm_name)

 new_for_address(swarm_name, bus_address)

Class: Dee.FileResourceManager

Implements: Dee.ResourceManager

Properties

string"primary-path"construct-only

Property holding the primary path used to store and load resources

Constructors

 new(primary_path)

Methods

voidadd_search_path(path)

stringget_primary_path()

Class: Dee.FilterModel

Implements: Dee.Serializable, Dee.Model

Subclass of: Dee.ProxyModel

All fields in the DeeFilterModel structure are private and should never be accessed directly

Properties

Dee.Filter"filter"construct-only

Property holding the #DeeFilter used to filter the model defined in the #DeeFilterModel:back-end property.

Constructors

 new(orig_model, filter)

Methods

Dee.ModelIterappend_iter(iter)

boolcontains(iter)

Dee.ModelIterinsert_iter(iter, pos)

Dee.ModelIterinsert_iter_before(iter, pos)

Dee.ModelIterinsert_iter_with_original_order(iter)

Dee.ModelIterprepend_iter(iter)

Class: Dee.GListResultSet

Implements: Dee.ResultSet

Methods

Class: Dee.HashIndex

Subclass of: Dee.Index

All fields in the DeeHashIndex structure are private and should never be accessed directly

Constructors

 new(model, analyzer, reader)

Abstract Class: Dee.Index

Known subclasses: Dee.TreeIndex, Dee.HashIndex

All fields in the DeeIndex structure are private and should never be accessed directly

Properties

Dee.Model"model"construct-only

The #DeeModel being indexed

Dee.Analyzer"analyzer"construct-only

The #DeeAnalyzer used to analyze terms extracted by the model reader

Dee.ModelReader"reader"construct-only

The #DeeModelReader used to extract terms from rows in the model

Methods

voidforeach(start_term, func, userdata)

Dee.Analyzerget_analyzer()

Dee.Modelget_model()

intget_n_rows()

intget_n_rows_for_term(term)

intget_n_terms()

Dee.ModelReaderget_reader()

intget_supported_term_match_flags()

Dee.ResultSetlookup(term, flags)

Dee.ModelIterlookup_one(term)

Interface: Dee.Model

Classes implementing Dee.Model: Dee.FilterModel, Dee.SerializableModel, Dee.ProxyModel, Dee.SharedModel, Dee.SequenceModel, Dee.Transaction

Signals

none"row-changed"(self, model, iter)

Connect to this signal to be notified when a row is changed.

none"row-removed"(self, model, iter)

Connect to this signal to be notified when a row is removed from @self. The row is still valid while the signal is being emitted.

none"row-added"(self, model, iter)

Connect to this signal to be notified when a row is added to @self.

Methods

Dee.ModelIterappend_row(row_members)

voidclear()

voidclear_tag(iter, tag)

Dee.ModelIter, boolfind_row_sorted(row_spec, cmp_func, user_data)

boolget_bool(iter, column)

stringget_column_schema(column)

floatget_double(iter, column)

Dee.ModelIterget_first_iter()

intget_int32(iter, column)

intget_int64(iter, column)

Dee.ModelIterget_iter_at_row(row)

Dee.ModelIterget_last_iter()

intget_n_columns()

intget_n_rows()

intget_position(iter)

GLib.Variantget_row(iter, out_row_members)

Array<utf8>, intget_schema()

stringget_string(iter, column)

gpointerget_tag(iter, tag)

intget_uchar(iter, column)

intget_uint32(iter, column)

intget_uint64(iter, column)

GLib.Variantget_value(iter, column)

Dee.ModelIterinsert_row(pos, row_members)

Dee.ModelIterinsert_row_before(iter, row_members)

Dee.ModelIterinsert_row_sorted(row_members, cmp_func, user_data)

boolis_first(iter)

boolis_last(iter)

Dee.ModelIterprepend_row(row_members)

Dee.ModelTagregister_tag(tag_destroy)

voidremove(iter)

voidrow_added(iter)

voidrow_changed(iter)

voidrow_removed(iter)

voidset_row(iter, row_members)

voidset_schema_full(column_schemas, num_columns)

voidset_tag(iter, tag, value)

voidset_value(iter, column, value)

Class: Dee.Peer

Known subclasses: Dee.Client, Dee.Server

All fields in the DeePeer structure are private and should never be accessed directly

Properties

bool"swarm-owner"construct-only

string"swarm-name"construct-only

string"swarm-leader"read-only

Signals

void"connection-closed"(self, peer, connection)

Connect to this signal to be notified when peers close their #GDBusConnection.

void"peer-lost"(self, peer, name)

Connect to this signal to be notified when peers disconnect from the swarm

void"peer-found"(self, peer, name)

Connect to this signal to be notified of existing and new peers that are in your swarm.

void"connection-acquired"(self, peer, object)

Constructors

 new(swarm_name)

Methods

voidconnection_acquired(connection)

voidconnection_closed(connection)

GLib.SListget_connections()

stringget_swarm_leader()

stringget_swarm_name()

boolis_swarm_leader()

boolis_swarm_owner()

Array<utf8>list_peers()

voidpeer_found(name)

voidpeer_lost(name)

Class: Dee.ProxyModel

Implements: Dee.Serializable, Dee.Model

Known subclasses: Dee.FilterModel, Dee.SharedModel

Subclass of: Dee.SerializableModel

All fields in the DeeProxyModel structure are private and should never be accessed directly

Properties

bool"proxy-signals"construct-only

Boolean property defining whether or not to automatically forward signals from the back end model. This is especially useful for sub classes wishing to do their own more advanced signal forwarding.

Dee.Model"back-end"construct-only

The backend model used by this proxy model.

Interface: Dee.ResourceManager

Classes implementing Dee.ResourceManager: Dee.FileResourceManager

Methods

Dee.ResourceManagerget_default()(static method)

GObject.Objectload(resource_name)

boolstore(resource, resource_name)

Interface: Dee.ResultSet

Classes implementing Dee.ResultSet: Dee.GListResultSet

Methods

Dee.Modelget_model()

intget_n_rows()

boolhas_next()

voidseek(pos)

inttell()

Class: Dee.SequenceModel

Implements: Dee.Serializable, Dee.Model

Subclass of: Dee.SerializableModel

All fields in the DeeSequenceModel structure are private and should never be accessed directly

Constructors

 new()

Interface: Dee.Serializable

Classes implementing Dee.Serializable: Dee.FilterModel, Dee.Transaction, Dee.SerializableModel, Unity.LauncherEntry, Dee.ProxyModel, Dee.SequenceModel, Dee.SharedModel

Methods

GLib.Variantexternalize()

GObject.Objectparse(data, type)(static method)

GObject.Objectparse_external(data)(static method)

GLib.Variantserialize()

Abstract Class: Dee.SerializableModel

Implements: Dee.Serializable, Dee.Model

Known subclasses: Dee.ProxyModel, Dee.SequenceModel, Dee.Transaction

All fields in the DeeSerializableModel structure are private and should never be accessed directly

Methods

intget_seqnum()

intinc_seqnum()

voidset_seqnum(seqnum)

Class: Dee.Server

Subclass of: Dee.Peer

Properties

string"bus-address"construct-only

bool"same-user-only"construct-only

Constructors

 new(swarm_name)

 new_for_address(swarm_name, bus_address)

Methods

stringbus_address_for_name(name, include_username)(static method)

stringget_client_address()

Class: Dee.SharedModel

Implements: Dee.Serializable, Dee.Model

Subclass of: Dee.ProxyModel

All fields in the DeeSharedModel structure are private and should never be accessed directly

Properties

Dee.Peer"peer"construct-only

The #DeePeer that this model uses to connect to the swarm

Dee.SharedModelAccessMode"access-mode"construct-only

Enumeration defining behavior of this model when trying to write to it. Setting this to #DEE_SHARED_MODEL_ACCESS_MODE_LEADER_WRITABLE is useful when one process is considered an "owner" of a model and all the other peers are supposed to only synchronize it for reading. See also DeePeer:swarm-owner property to ensure ownership of a swarm.

bool"synchronized"read-only

Boolean property defining whether or not the model has synchronized with its peers (if any) yet. You should not modify a #DeeSharedModel that is not synchronized. Before modifying the model in any way (except calling dee_model_set_schema()) you should wait for it to become synchronized.

Signals

void"begin-transaction"(self, shared_model, begin_seqnum, end_seqnum)

Emitted right before a remote transaction will be committed to the model.

void"end-transaction"(self, shared_model, begin_seqnum, end_seqnum)

Emitted right after a remote transaction has been committed to the model.

Constructors

 new(name)

 new_for_peer(peer)

 new_with_back_end(name, back_end)

Methods

intflush_revision_queue()

Dee.Peerget_peer()

stringget_swarm_name()

boolis_leader()

boolis_synchronized()

Class: Dee.TermList

All fields in the DeeTermList structure are private and should never be accessed directly

Methods

Dee.TermListadd_term(term)

Dee.TermListclear()

Dee.TermListclone()

stringget_term(n)

intnum_terms()

Class: Dee.TextAnalyzer

Subclass of: Dee.Analyzer

All fields in the DeeTextAnalyzer structure are private and should never be accessed directly

Constructors

 new()

Class: Dee.Transaction

Implements: Dee.Serializable, Dee.Model

Subclass of: Dee.SerializableModel

All fields in the DeeTransaction structure are private and should never be accessed directly

Properties

Dee.Model"target"construct-only

Constructors

 new(target)

Methods

boolcommit()

GLib.Quarkerror_quark()(static method)

Dee.Modelget_target()

boolis_committed()

Class: Dee.TreeIndex

Subclass of: Dee.Index

All fields in the DeeTreeIndex structure are private and should never be accessed directly

Constructors

 new(model, analyzer, reader)

Enum: Dee.SharedModelAccessMode

WORLD_WRITABLE0LEADER_WRITABLE1

Enum: Dee.TransactionError

CONCURRENT_MODIFICATION1COMMITTED2

Enum: Dee.SharedModelError

SHARED_MODEL_ERROR_LEADER_INVALIDATED0

Enum: Dee.ICUError

BAD_RULE0BAD_ID1UNKNOWN2

Enum: Dee.TermMatchFlag

EXACT1PREFIX2