AfsMetaHelper Class Reference

AFS reply meta data. More...

Inheritance diagram for AfsMetaHelper:

Public Member Functions
	__construct ($meta)
	Construct new instance from meta node.
	get_feed ()
	Retrieve feed name of the reply.
	get_total_replies ()
	Retrieve total number of replies for current feed.
	get_replies_per_page ()
	Retrieves number of replies per page.
	get_duration ()
	Retrieve reply computation time for the feed.
	get_producer ()
	Retrieve producer type.
	has_cluster ()
	Checks whether response contains clusters.
	get_cluster_id ()
	Retrieves filter identifier used to clusterize.
	get_cluster_label ()
	Retrieves filter label used to clusterize.
	format ()
	Retrieve meta as array.
Public Member Functions inherited from AfsHelperBase
	__get ($name)
	Simple property helper.

Detailed Description

AFS reply meta data.

Wrapper to access main meta data.

Constructor & Destructor Documentation

__construct

(

$meta

)

Construct new instance from meta node.

Parameters

$meta

[in] meta data node of AFS reply.

Member Function Documentation

format

(

)

Retrieve meta as array.

All data are store in key => value format:

• feed: feed name,
• total_replies: total number of replies for current query,
• replies_per_page: number of replies per page,
• duration: time to compute the reply (in milliseconds),
• producer: name of the producer agent.

Returns

array filled with key/value pairs.

get_cluster_id

(

)

Retrieves filter identifier used to clusterize.

Returns

filter identifier.

get_cluster_label

(

)

Retrieves filter label used to clusterize.

Returns

filter label.

get_duration

(

)

Retrieve reply computation time for the feed.

Returns

duration in milliseconds.

get_feed

(

)

Retrieve feed name of the reply.

Returns

feed name.

get_producer

(

)

Retrieve producer type.

Returns

producer.

get_replies_per_page

(

)

Retrieves number of replies per page.

Returns

number of replies per page.

get_total_replies

(

)

Retrieve total number of replies for current feed.

Returns

number of replies for the feed.

has_cluster

(

)

Checks whether response contains clusters.

Returns

True in cluster mode, false otherwise.