![]() |
![]() |
![]() |
Zeitgeist Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites | Known Implementations |
guint zeitgeist_result_set_size (ZeitgeistResultSet *self
); guint zeitgeist_result_set_estimated_matches (ZeitgeistResultSet *self
); ZeitgeistEvent * zeitgeist_result_set_next_value (ZeitgeistResultSet *self
); gboolean zeitgeist_result_set_has_next (ZeitgeistResultSet *self
); guint zeitgeist_result_set_tell (ZeitgeistResultSet *self
); void zeitgeist_result_set_reset (ZeitgeistResultSet *self
); ZeitgeistResultSet * zeitgeist_result_set_iterator (ZeitgeistResultSet *self
); ZeitgeistResultSet; struct ZeitgeistResultSetIface;
include: zeitgeist.h
Interface for results returned by zeitgeist_log_find_events()
, zeitgeist_log_get_events()
, and zeitgeist_index_search()
.
This interface utilizes a cursor-like metaphor. You advance the cursor by calling zeitgeist_result_set_next()
or adjust it manually by calling zeitgeist_result_set_seek()
.
Calling zeitgeist_result_set_next()
will also return the event at the current cursor position. You may retrieve the current event without advancing the cursor by calling zeitgeist_result_set_peek()
.
guint zeitgeist_result_set_size (ZeitgeistResultSet *self
);
Get the number of ZeitgeistEvent<!-- -->s held in a ZeitgeistResultSet. Unlike the number obtained from zeitgeist_result_set_estimated_matches()
the size of the result set is always equal to the number of times you can call zeitgeist_result_set_next()
.
|
the ZeitgeistResultSet instance |
Returns : |
The number of events held in the result set |
guint zeitgeist_result_set_estimated_matches
(ZeitgeistResultSet *self
);
Get the total number of matches that would have been for the query that generated the result set had it not been restricted in size. For FTS the number of matches is estimated.
For zeitgeist_log_find_events()
and zeitgeist_log_get_events()
this will always be the same as zeitgeist_result_set_size()
. For cases like zeitgeist_index_search()
where you specify a subset of the hits to retrieve the estimated match count will often be bigger than the result set size.
|
the ZeitgeistResultSet instance |
Returns : |
The number of events that matched the query |
ZeitgeistEvent * zeitgeist_result_set_next_value (ZeitgeistResultSet *self
);
Get the current event from the result set and advance the cursor. To ensure that calls to this method will succeed you can call zeitgeist_result_set_has_next()
.
|
the ZeitgeistResultSet instance |
Returns : |
The ZeitgeistEvent at the current cursor position, or NULL if there are no events left. |
gboolean zeitgeist_result_set_has_next (ZeitgeistResultSet *self
);
Check if a call to zeitgeist_result_set_next()
will succeed.
|
the ZeitgeistResultSet instance |
Returns : |
TRUE if and only if more events can be retrieved by calling zeitgeist_result_set_next()
|
guint zeitgeist_result_set_tell (ZeitgeistResultSet *self
);
Get the current position of the cursor.
|
the ZeitgeistResultSet instance |
Returns : |
The current position of the cursor |
void zeitgeist_result_set_reset (ZeitgeistResultSet *self
);
Resets the result set to start iterating it again from scratch.
|
the ZeitgeistResultSet instance |
ZeitgeistResultSet * zeitgeist_result_set_iterator (ZeitgeistResultSet *self
);
Do not use this method! It is only for use by Vala.
|
the ZeitgeistResultSet instance |
typedef struct _ZeitgeistResultSet ZeitgeistResultSet;
Cursor-like interface for results sets
include: zeitgeist.h
Interface for results returned by zeitgeist_log_find_events()
, zeitgeist_log_get_events()
, and zeitgeist_index_search()
.
This interface utilizes a cursor-like metaphor. You advance the cursor by calling zeitgeist_result_set_next()
or adjust it manually by calling zeitgeist_result_set_seek()
.
Calling zeitgeist_result_set_next()
will also return the event at the current cursor position. You may retrieve the current event without advancing the cursor by calling zeitgeist_result_set_peek()
.
struct ZeitgeistResultSetIface { GTypeInterface parent_iface; guint (*size) (ZeitgeistResultSet* self); guint (*estimated_matches) (ZeitgeistResultSet* self); ZeitgeistEvent* (*next_value) (ZeitgeistResultSet* self); gboolean (*has_next) (ZeitgeistResultSet* self); guint (*tell) (ZeitgeistResultSet* self); void (*reset) (ZeitgeistResultSet* self); };
Interface for creating ZeitgeistResultSet implementations.