BeagleHit

BeagleHit —

Synopsis




            BeagleHit;
BeagleHit*  beagle_hit_ref                  (BeagleHit *hit);
void        beagle_hit_unref                (BeagleHit *hit);
const char* beagle_hit_get_uri              (BeagleHit *hit);
BeagleTimestamp* beagle_hit_get_timestamp   (BeagleHit *hit);
const char* beagle_hit_get_type             (BeagleHit *hit);
const char* beagle_hit_get_mime_type        (BeagleHit *hit);
const char* beagle_hit_get_source           (BeagleHit *hit);
const char* beagle_hit_get_source_object_name
                                            (BeagleHit *hit);
double      beagle_hit_get_score            (BeagleHit *hit);
const char* beagle_hit_get_property         (BeagleHit *hit,
                                             const char *key);
BeagleProperty* beagle_hit_lookup_property  (BeagleHit *hit,
                                             const char *key);

Description

Details

BeagleHit

typedef struct _BeagleHit BeagleHit;


beagle_hit_ref ()

BeagleHit*  beagle_hit_ref                  (BeagleHit *hit);

Increases the reference count of the BeagleHit.

hit : a BeagleHit
Returns : the BeagleHit.

beagle_hit_unref ()

void        beagle_hit_unref                (BeagleHit *hit);

Decreases the reference count of the BeagleHit. When its reference count drops to 0, it is freed.

hit : a BeagleHit.

beagle_hit_get_uri ()

const char* beagle_hit_get_uri              (BeagleHit *hit);

Fetches the URI of the given BeagleHit.

hit : a BeagleHit
Returns : the URI of the BeagleHit.

beagle_hit_get_timestamp ()

BeagleTimestamp* beagle_hit_get_timestamp   (BeagleHit *hit);

Fetches the timestamp of the given BeagleHit.

hit : a BeagleHit
Returns : the timestamp as a string of the BeagleHit.

beagle_hit_get_type ()

const char* beagle_hit_get_type             (BeagleHit *hit);

Fetches the type of the given BeagleHit.

hit : a BeagleHit
Returns : the type of the BeagleHit.

beagle_hit_get_mime_type ()

const char* beagle_hit_get_mime_type        (BeagleHit *hit);

Fetches the mime type of the given BeagleHit.

hit : a BeagleHit
Returns : the mime type of the BeagleHit.

beagle_hit_get_source ()

const char* beagle_hit_get_source           (BeagleHit *hit);

Fetches the source of the given BeagleHit.

hit : a BeagleHit
Returns : the source of the BeagleHit.

beagle_hit_get_source_object_name ()

const char* beagle_hit_get_source_object_name
                                            (BeagleHit *hit);

Fetches the source object name of the given BeagleHit.

hit : a BeagleHit
Returns : the source object name of the BeagleHit.

beagle_hit_get_score ()

double      beagle_hit_get_score            (BeagleHit *hit);

Fetches the score of the given BeagleHit.

hit : a BeagleHit
Returns : the score of the BeagleHit.

beagle_hit_get_property ()

const char* beagle_hit_get_property         (BeagleHit *hit,
                                             const char *key);

Fetches the value of the property key of the given BeagleHit.

hit : a BeagleHit
key : a string
Returns : the value of property key.

beagle_hit_lookup_property ()

BeagleProperty* beagle_hit_lookup_property  (BeagleHit *hit,
                                             const char *key);

Fetches the property key of the given BeagleHit.

hit : a BeagleHit
key : a string
Returns : the BeagleProperty matching key of the BeagleHit.