ZeitgeistIndex

ZeitgeistIndex — Query the Zeitgeist Full Text Search Extension

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── ZeitgeistIndex

Includes

#include <zeitgeist.h>

Description

Functions

zeitgeist_index_new ()

ZeitgeistIndex *
zeitgeist_index_new (void);

Create a new ZeitgeistIndex instance. The index will start to connect to Zeitgeist asynchronously. You can however start calling methods on the returned instance immediately, any method calls issued before the connection has been established will simply be queued and executed once the connection is up.

Returns

A reference to a newly allocated index. Free with g_object_unref().


zeitgeist_index_search ()

void
zeitgeist_index_search (ZeitgeistIndex *self,
                        const gchar *query,
                        ZeitgeistTimeRange *time_range,
                        GPtrArray *event_templates,
                        guint32 offset,
                        guint32 num_events,
                        ZeitgeistResultType result_type,
                        GCancellable *cancellable,
                        GAsyncReadyCallback callback,
                        gpointer user_data);

Perform a full text search possibly restricted to a ZeitgeistTimeRange and/or set of event templates.

The default boolean operator is AND. Thus the query foo bar will be interpreted as foo AND bar. To exclude a term from the result set prepend it with a minus sign - eg foo -bar. Phrase queries can be done by double quoting the string "foo is a bar". You can truncate terms by appending a *.

There are a few keys you can prefix to a term or phrase to search within a specific set of metadata. They are used like key:value. The keys name and title search strictly within the text field of the event subjects. The key app searches within the application name or description that is found in the actor attribute of the events. Lastly you can use the site key to search within the domain name of the subject URIs.

You can also control the results with the boolean operators AND and OR and you may use brackets, ( and ), to control the operator precedence.

Parameters

self

The ZeitgeistIndex you want to query

 

query

The search string to send to Zeitgeist

 

time_range

Restrict matched events to ones within this time range. If you are not interested in restricting the timerange pass zeitgeist_time_range_new_anytime() as Zeitgeist will detect this and optimize the query accordingly

 

event_templates

Restrict matches events to ones matching these templates

 

offset

Offset into the result set to read events from

 

num_events

Maximal number of events to retrieve

 

result_type

The ZeitgeistResultType determining the sort order. You may pass ZEITGEIST_RESULT_TYPE_RELEVANCY to this method to have the results ordered by relevancy calculated in relation to query

 

cancellable

A GCancellable used to cancel the call or NULL

 

callback

A GAsyncReadyCallback to invoke when the search results are ready

 

user_data

User data to pass back with callback

 

zeitgeist_index_search_finish ()

ZeitgeistResultSet *
zeitgeist_index_search_finish (ZeitgeistIndex *self,
                               GAsyncResult *res,
                               GError **error);

Retrieve the result from an asynchronous query started with zeitgeist_index_search().

The total hit count of the query will be available via the returned result set by calling zeitgeist_result_set_estimated_matches(). This will often be bigger than the actual number of events held in the result set, which is limited by the num_events parameter passed to zeitgeist_index_search().

Parameters

self

The ZeitgeistIndex to retrieve results from

 

res

The GAsyncResult you received in the GAsyncReadyCallback you passed to zeitgeist_index_search()

 

error

A place to store a GError or NULL in case you want to ignore errors

 

Returns

A newly allocated ZeitgeistResultSet containing the ZeitgeistEvents matching the query. You must free the result set with g_object_unref(). The events held in the result set will automatically be unreffed when it is finalized.


zeitgeist_index_search_with_relevancies ()

void
zeitgeist_index_search_with_relevancies
                               (ZeitgeistIndex *self,
                                const gchar *query,
                                ZeitgeistTimeRange *time_range,
                                GPtrArray *event_templates,
                                ZeitgeistStorageState storage_state,
                                guint32 offset,
                                guint32 num_events,
                                ZeitgeistResultType result_type,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Perform a full text search possibly restricted to a ZeitgeistTimeRange and/or set of event templates. As opposed to zeitgeist_index_search(), this call will also return numeric relevancies of the events in the ZeitgeistResultSet.

See zeitgeist_index_search() for more details on how to create the query.

Parameters

self

The ZeitgeistIndex you want to query

 

query

The search string to send to Zeitgeist

 

time_range

Restrict matched events to ones within this time range. If you are not interested in restricting the timerange pass zeitgeist_time_range_new_anytime() as Zeitgeist will detect this and optimize the query accordingly

 

event_templates

Restrict matched events to ones matching these templates

 

storage_state

Filter the events by availability of the storage medium.

 

offset

Offset into the result set to read events from

 

num_events

Maximal number of events to retrieve

 

result_type

The ZeitgeistResultType determining the sort order. You may pass ZEITGEIST_RESULT_TYPE_RELEVANCY to this method to have the results ordered by relevancy calculated in relation to query

 

cancellable

A GCancellable used to cancel the call or NULL

 

callback

A GAsyncReadyCallback to invoke when the search results are ready

 

user_data

User data to pass back with callback

 

zeitgeist_index_search_with_relevancies_finish ()

ZeitgeistResultSet*
zeitgeist_index_search_with_relevancies_finish
                               (ZeitgeistIndex *self,
                                GAsyncResult *res,
                                gdouble **relevancies,
                                gint *relevancies_size,
                                GError **error);

Retrieve the result from an asynchronous query started with zeitgeist_index_search_with_relevancies().

The total hit count of the query will be available via the returned result set by calling zeitgeist_result_set_estimated_matches(). This will often be bigger than the actual number of events held in the result set, which is limited by the num_events parameter passed to zeitgeist_index_search_with_relevancies().

Parameters

self

The ZeitgeistIndex to retrieve results from

 

res

The GAsyncResult you received in the GAsyncReadyCallback you passed to zeitgeist_index_search_with_relevancies()

 

relevancies

Location for the newly allocated array with relevancies.

[out][array]

relevancies_size

Location for the size of the newly allocated array.

[out]

error

A place to store a GError or NULL in case you want to ignore errors

 

Returns

A newly allocated ZeitgeistResultSet containing the ZeitgeistEvents matching the query. You must free the result set with g_object_unref(). The events held in the result set will automatically be unreffed when it is finalized.

Types and Values

struct ZeitgeistIndex

struct ZeitgeistIndex;

struct ZeitgeistIndexClass

struct ZeitgeistIndexClass {
  GObjectClass parent_class;
};