![]() |
![]() |
![]() |
Libbeagle Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
BeagleIndexable; enum BeagleIndexableType; enum BeagleIndexableFiltering; BeagleIndexable * beagle_indexable_new (const char *uri
); void beagle_indexable_free (BeagleIndexable *indexable
); void beagle_indexable_add_property (BeagleIndexable *indexable
,BeagleProperty *prop
); BeagleIndexableType beagle_indexable_get_type (BeagleIndexable *indexable
); void beagle_indexable_set_type (BeagleIndexable *indexable
,BeagleIndexableType type
); const char * beagle_indexable_get_uri (BeagleIndexable *indexable
); void beagle_indexable_set_uri (BeagleIndexable *indexable
,const char *uri
); const char * beagle_indexable_get_parent_uri (BeagleIndexable *indexable
); void beagle_indexable_set_parent_uri (BeagleIndexable *indexable
,const char *parent_uri
); const char * beagle_indexable_get_content_uri (BeagleIndexable *indexable
); void beagle_indexable_set_content_uri (BeagleIndexable *indexable
,const char *content_uri
); const char * beagle_indexable_get_hot_content_uri (BeagleIndexable *indexable
); void beagle_indexable_set_hot_content_uri (BeagleIndexable *indexable
,const char *hot_content_uri
); BeagleTimestamp * beagle_indexable_get_timestamp (BeagleIndexable *indexable
); void beagle_indexable_set_timestamp (BeagleIndexable *indexable
,BeagleTimestamp *timestamp
); gboolean beagle_indexable_get_delete_content (BeagleIndexable *indexable
); void beagle_indexable_set_delete_content (BeagleIndexable *indexable
,gboolean delete_content
); gboolean beagle_indexable_get_crawled (BeagleIndexable *indexable
); void beagle_indexable_set_crawled (BeagleIndexable *indexable
,gboolean crawled
); gboolean beagle_indexable_get_no_content (BeagleIndexable *indexable
); void beagle_indexable_set_no_content (BeagleIndexable *indexable
,gboolean no_content
); gboolean beagle_indexable_get_cache_content (BeagleIndexable *indexable
); void beagle_indexable_set_cache_content (BeagleIndexable *indexable
,gboolean cache_content
); BeagleIndexableFiltering beagle_indexable_get_filtering (BeagleIndexable *indexable
); void beagle_indexable_set_filtering (BeagleIndexable *indexable
,BeagleIndexableFiltering filtering
); const char * beagle_indexable_get_hit_type (BeagleIndexable *indexable
); void beagle_indexable_set_hit_type (BeagleIndexable *indexable
,const char *hit_type
); const char * beagle_indexable_get_mime_type (BeagleIndexable *indexable
); void beagle_indexable_set_mime_type (BeagleIndexable *indexable
,const char *mime_type
); const char * beagle_indexable_get_source (BeagleIndexable *indexable
);
typedef enum { BEAGLE_INDEXABLE_TYPE_ADD, BEAGLE_INDEXABLE_TYPE_REMOVE, BEAGLE_INDEXABLE_TYPE_PROPERTY_CHANGE } BeagleIndexableType;
typedef enum { BEAGLE_INDEXABLE_FILTERING_ALWAYS, BEAGLE_INDEXABLE_FILTERING_ALREADY_FILTERED, BEAGLE_INDEXABLE_FILTERING_AUTOMATIC, BEAGLE_INDEXABLE_FILTERING_NEVER } BeagleIndexableFiltering;
BeagleIndexable * beagle_indexable_new (const char *uri
);
Creates a new BeagleIndexable for the given uri
.
|
a string |
Returns : |
the newly created BeagleIndexable. |
void beagle_indexable_free (BeagleIndexable *indexable
);
Frees the memory allocated by the BeagleIndexable.
|
a BeagleIndexable |
void beagle_indexable_add_property (BeagleIndexable *indexable
,BeagleProperty *prop
);
Adds the BeagleProperty to the given BeagleIndexable.
|
a BeagleIndexable |
|
a BeagleProperty |
BeagleIndexableType beagle_indexable_get_type (BeagleIndexable *indexable
);
Fetches the BeagleIndexableType of the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
Fetches the BeagleIndexableType of the BeagleIndexable. |
void beagle_indexable_set_type (BeagleIndexable *indexable
,BeagleIndexableType type
);
Sets the BeagleIndexableType of the given BeagleIndexable.
|
a BeagleIndexable |
|
a BeagleIndexableType |
const char * beagle_indexable_get_uri (BeagleIndexable *indexable
);
Fetches the URI for the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
the URI of the BeagleIndexable. |
void beagle_indexable_set_uri (BeagleIndexable *indexable
,const char *uri
);
Sets the URI of the BeagleIndexable to uri
.
|
a BeagleIndexable |
|
a string |
const char * beagle_indexable_get_parent_uri (BeagleIndexable *indexable
);
Fetches the URI for the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
the parent URI of the BeagleIndexable. |
void beagle_indexable_set_parent_uri (BeagleIndexable *indexable
,const char *parent_uri
);
Sets the parent URI of the BeagleIndexable to parent_uri
.
|
a BeagleIndexable |
|
a string |
const char * beagle_indexable_get_content_uri (BeagleIndexable *indexable
);
Fetches the content URI for the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
the content URI of the BeagleIndexable. |
void beagle_indexable_set_content_uri (BeagleIndexable *indexable
,const char *content_uri
);
Sets the content URI of the given BeagleIndexable to content_uri
.
|
a BeagleIndexable |
|
a string |
const char * beagle_indexable_get_hot_content_uri
(BeagleIndexable *indexable
);
Fetches the hot content URI of the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
the hot content URI of the BeagleIndexable. |
void beagle_indexable_set_hot_content_uri (BeagleIndexable *indexable
,const char *hot_content_uri
);
Sets the hot content URI of the given BeagleIndexable to hot_content_uri
.
|
a BeagleIndexable |
|
a string |
BeagleTimestamp * beagle_indexable_get_timestamp (BeagleIndexable *indexable
);
Gets the BeagleTimestamp for the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
a BeagleTimestamp |
void beagle_indexable_set_timestamp (BeagleIndexable *indexable
,BeagleTimestamp *timestamp
);
Sets the BeagleTimestamp for the given BeagleIndexable.
|
a BeagleIndexable |
|
a BeagleTimestamp |
gboolean beagle_indexable_get_delete_content (BeagleIndexable *indexable
);
Fetches whether content of the given BeagleIndexable should be deleted after it has been indexed.
|
a BeagleIndexable |
Returns : |
whether content should be deleted for the BeagleIndexable. |
void beagle_indexable_set_delete_content (BeagleIndexable *indexable
,gboolean delete_content
);
Sets whether content of the given BeagleIndexable should be deleted after it has been indexed.
|
a BeagleIndexable |
|
a boolean |
gboolean beagle_indexable_get_crawled (BeagleIndexable *indexable
);
Fetches whether the given BeagleIndexable is in crawl mode.
|
a BeagleIndexable |
Returns : |
whether the BeagleIndexable is crawled. |
void beagle_indexable_set_crawled (BeagleIndexable *indexable
,gboolean crawled
);
Sets whether the given BeagleIndexable is in crawl mode.
|
a BeagleIndexable |
|
a boolean |
gboolean beagle_indexable_get_no_content (BeagleIndexable *indexable
);
Fetches whether the given BeagleIndexable has no content.
|
a BeagleIndexable |
Returns : |
whether the BeagleIndexable has no content. |
void beagle_indexable_set_no_content (BeagleIndexable *indexable
,gboolean no_content
);
Sets whether the given BeagleIndexable has no content.
|
a BeagleIndexable |
|
a boolean |
gboolean beagle_indexable_get_cache_content (BeagleIndexable *indexable
);
Fetches whether the given BeagleIndexable consists of cached contents.
|
a BeagleIndexable |
Returns : |
whether the BeagleIndexable contains cached contents. |
void beagle_indexable_set_cache_content (BeagleIndexable *indexable
,gboolean cache_content
);
Sets whether the given BeagleIndexable consists of cached contents.
|
a BeagleIndexable |
|
a boolean |
BeagleIndexableFiltering beagle_indexable_get_filtering
(BeagleIndexable *indexable
);
Fetches the BeagleIndexableFiltering of the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
Fetches the BeagleIndexableFiltering of the BeagleIndexable. |
void beagle_indexable_set_filtering (BeagleIndexable *indexable
,BeagleIndexableFiltering filtering
);
Sets the BeagleIndexableFiltering of the given BeagleIndexable.
|
a BeagleIndexable |
|
a BeagleIndexableFiltering |
const char * beagle_indexable_get_hit_type (BeagleIndexable *indexable
);
Fetches the hit type of the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
the hit type of the BeagleIndexable. |
void beagle_indexable_set_hit_type (BeagleIndexable *indexable
,const char *hit_type
);
Sets the hit type of the given BeagleIndexable to hit_type
.
|
a BeagleIndexable |
|
a string |
const char * beagle_indexable_get_mime_type (BeagleIndexable *indexable
);
Fetches the mime type of the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
the mime type of the BeagleIndexable. |
void beagle_indexable_set_mime_type (BeagleIndexable *indexable
,const char *mime_type
);
Sets the mime type of the given BeagleIndexable to mime_type
.
|
a BeagleIndexable |
|
a string |
const char * beagle_indexable_get_source (BeagleIndexable *indexable
);
Fetches the source of the given BeagleIndexable.
|
a BeagleIndexable |
Returns : |
the source of the BeagleIndexable. |