LuceneFacet Struct Reference

#include <lucene_facet.h>

Public Member Functions
GRASSROOTS_LUCENE_API LuceneFacet *	AllocateLuceneFacet (const char *name_s, const uint32 count)
	Allocate a LuceneFacet to store search result metadata. More...
GRASSROOTS_LUCENE_API void	FreeLuceneFacet (LuceneFacet *facet_p)
	Free a LuceneFacet. More...
GRASSROOTS_LUCENE_API LuceneFacetNode *	AllocateLuceneFacetNode (LuceneFacet *facet_p)
	Allocate a LuceneFacetNode. More...
GRASSROOTS_LUCENE_API LuceneFacetNode *	AllocateLuceneFacetNodeByParts (const char *name_s, const uint32 count)
	Allocate a LuceneFacetNode. More...
GRASSROOTS_LUCENE_API void	FreeLuceneFacetNode (ListItem *node_p)
	Free a LuceneFacetNode. More...
GRASSROOTS_LUCENE_API json_t *	GetLuceneFacetAsJSON (const LuceneFacet *facet_p)
	Get the JSON representation of a LuceneFacet. More...
GRASSROOTS_LUCENE_API LuceneFacet *	GetLuceneFacetFromResultsJSON (const json_t *json_p)
	Get a LuceneFacet from a JSON representation. More...

Data Fields
char *	lf_name_s
uint32	lf_count

Member Function Documentation

AllocateLuceneFacet()

GRASSROOTS_LUCENE_API LuceneFacet * AllocateLuceneFacet	(	const char *	name_s,
		const uint32	count
	)

Allocate a LuceneFacet to store search result metadata.

Returns

A newly-allocated LuceneFacet or NULL upon error.

FreeLuceneFacet()

GRASSROOTS_LUCENE_API void FreeLuceneFacet

(

LuceneFacet *

facet_p

)

Free a LuceneFacet.

Parameters

tool_p

The LuceneFacet to free.

AllocateLuceneFacetNode()

GRASSROOTS_LUCENE_API LuceneFacetNode * AllocateLuceneFacetNode

(

LuceneFacet *

facet_p

)

Allocate a LuceneFacetNode.

Returns

A newly-allocated LuceneFacetNode or NULL upon error.

AllocateLuceneFacetNodeByParts()

GRASSROOTS_LUCENE_API LuceneFacetNode * AllocateLuceneFacetNodeByParts	(	const char *	name_s,
		const uint32	count
	)

Allocate a LuceneFacetNode.

Returns

A newly-allocated LuceneFacetNode or NULL upon error.

FreeLuceneFacetNode()

GRASSROOTS_LUCENE_API void FreeLuceneFacetNode

(

ListItem *

node_p

)

Free a LuceneFacetNode.

Parameters

node_p

The LuceneFacetNode to free.

GetLuceneFacetAsJSON()

GRASSROOTS_LUCENE_API json_t * GetLuceneFacetAsJSON

(

const LuceneFacet *

facet_p

)

Get the JSON representation of a LuceneFacet.

Parameters

facet_p

The LuceneFacet to get the JSON representation of.

Returns

A newly-allocated json_t representing the LuceneFacet or NULL upon error.

GetLuceneFacetFromResultsJSON()

GRASSROOTS_LUCENE_API LuceneFacet * GetLuceneFacetFromResultsJSON

(

const json_t *

json_p

)

Get a LuceneFacet from a JSON representation.

Parameters

json_t

The json_t representing the LuceneFacet.

Returns

A newly-allocated LuceneFacet or NULL upon error.

Field Documentation

lf_name_s

char* lf_name_s

lf_count

uint32 lf_count

---

The documentation for this struct was generated from the following file:

• lucene_facet.h