Top | ![]() |
![]() |
![]() |
![]() |
TrackerDecoratorTrackerDecorator — A miner tasked with listening for DB resource changes and extracting metadata |
GType | tracker_decorator_get_type () |
const gchar ** | tracker_decorator_get_class_names () |
const gchar * | tracker_decorator_get_data_source () |
guint | tracker_decorator_get_n_items () |
void | tracker_decorator_set_priority_rdf_types () |
void | tracker_decorator_prepend_id () |
void | tracker_decorator_delete_id () |
void | tracker_decorator_next () |
TrackerDecoratorInfo * | tracker_decorator_next_finish () |
GType | tracker_decorator_info_get_type () |
TrackerDecoratorInfo * | tracker_decorator_info_ref () |
void | tracker_decorator_info_unref () |
const gchar * | tracker_decorator_info_get_mimetype () |
TrackerSparqlBuilder * | tracker_decorator_info_get_sparql () |
GTask * | tracker_decorator_info_get_task () |
const gchar * | tracker_decorator_info_get_url () |
const gchar * | tracker_decorator_info_get_urn () |
GStrv | class-names | Read / Write |
gint | commit-batch-size | Read / Write |
gchar * | data-source | Read / Write / Construct Only |
GStrv | priority-rdf-types | Write |
const gchar **
tracker_decorator_get_class_names (TrackerDecorator *decorator
);
This function returns a string list of class names which are being updated with extended metadata. An example would be 'nfo:Document'.
Since 0.18
const gchar *
tracker_decorator_get_data_source (TrackerDecorator *decorator
);
The unique string identifying this TrackerDecorator that has extracted the extended metadata. This is essentially an identifier so it's clear WHO has extracted this extended metadata.
Since 0.18
guint
tracker_decorator_get_n_items (TrackerDecorator *decorator
);
Since 0.18
void tracker_decorator_set_priority_rdf_types (TrackerDecorator *decorator
,const gchar * const *rdf_types
);
void tracker_decorator_prepend_id (TrackerDecorator *decorator
,gint id
,gint class_name_id
);
Adds resource needing extended metadata extraction to the queue.
id
is the same IDs emitted by tracker-store when the database is updated for
consistency. For details, see the GraphUpdated signal.
Since 0.18
void tracker_decorator_delete_id (TrackerDecorator *decorator
,gint id
);
Deletes resource needing extended metadata extraction from the
queue. id
is the same IDs emitted by tracker-store when the database is
updated for consistency. For details, see the GraphUpdated signal.
Since 0.18
void tracker_decorator_next (TrackerDecorator *decorator
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Processes the next resource in the queue to have extended metadata extracted. If the item in the queue has been completed already, it signals it's completion instead.
This function will give a GError if the miner is paused at the time it is called.
decorator |
||
cancellable |
a GCancellable. |
|
callback |
a GAsyncReadyCallback. |
|
user_data |
user_data for |
Since 0.18
TrackerDecoratorInfo * tracker_decorator_next_finish (TrackerDecorator *decorator
,GAsyncResult *result
,GError **error
);
Should be called in the callback function provided to
tracker_decorator_next()
to return the result of the task be it an
error or not.
a TrackerDecoratorInfo on success or
NULL on error. Free with tracker_decorator_info_unref()
.
[transfer full]
Since 0.18
TrackerDecoratorInfo *
tracker_decorator_info_ref (TrackerDecoratorInfo *info
);
const gchar *
tracker_decorator_info_get_mimetype (TrackerDecoratorInfo *info
);
A MIME¹ type is a way of describing the content type of a file or set of data. An example would be 'text/plain' for a clear text document or file.
¹: http://en.wikipedia.org/wiki/MIME
Since 0.18
TrackerSparqlBuilder *
tracker_decorator_info_get_sparql (TrackerDecoratorInfo *info
);
A TrackerSparqlBuilder allows the caller to extract the final SPARQL used to insert the extracted metadata into the database for the resource being processed.
This function calls g_task_get_task_data()
on the return value of
tracker_decorator_info_get_task()
.
Since 0.18
GTask *
tracker_decorator_info_get_task (TrackerDecoratorInfo *info
);
When processing resource updates in the database, the GTask APIs
are used. This function returns the particular GTask used for
info
.
Since 0.18
const gchar *
tracker_decorator_info_get_url (TrackerDecoratorInfo *info
);
A URL is a Uniform Resource Locator and should be a location associated with a resource in the database. For example, 'file:///tmp/foo.txt'.
Since 0.18
const gchar *
tracker_decorator_info_get_urn (TrackerDecoratorInfo *info
);
A URN is a Uniform Resource Name and should be a unique identifier for a resource in the database.
Since 0.18
struct TrackerDecoratorClass { TrackerMinerClass parent_class; void (* items_available) (TrackerDecorator *decorator); void (* finished) (TrackerDecorator *decorator); /* <Private> */ gpointer padding[10]; };
An implementation that takes care of extracting extra metadata specific to file types by talking to tracker-extract.
Based on TrackerMinerClass.
TrackerMinerClass |
parent object class. |
|
Called when there are resources to be processed. |
||
Called when all resources have been processed. |
||
Reserved for future API improvements. |
“class-names”
property “class-names” GStrv
rdfs:Class objects to listen to for changes.
Flags: Read / Write
“commit-batch-size”
property “commit-batch-size” gint
Number of items per update batch.
Flags: Read / Write
Allowed values: >= 0
Default value: 100
“data-source”
property “data-source” gchar *
nie:DataSource to use in this decorator.
Flags: Read / Write / Construct Only
Default value: NULL
“finished”
signalvoid user_function (TrackerDecorator *decorator, gpointer user_data)
The ::finished signal will be emitted whenever the TrackerDecorator has finished extracted extended metadata for resources in the database.
decorator |
the TrackerDecorator |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since 0.18
“items-available”
signalvoid user_function (TrackerDecorator *decorator, gpointer user_data)
The ::items-available signal will be emitted whenever the TrackerDecorator sees resources that are available for extended metadata extraction.
decorator |
the TrackerDecorator |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since 0.18
TrackerDecoratorFS TrackerDecorator watches for signal updates based on file changes in the database. When new files are added initially, only simple metadata exists, for example, name, size, mtime, etc. The TrackerDecorator queues files for extended metadata extraction (i.e. for tracker-extract to fetch metadata specific to the file type) for example 'nmm:whiteBalance' for a picture.