LuceneDocument Struct Reference

A datatype for holding Lucene Documents. More...

#include <lucene_document.h>

Public Member Functions
GRASSROOTS_LUCENE_API LuceneDocument *	AllocateLuceneDocument (void)
	Allocate a LuceneDocument. More...
GRASSROOTS_LUCENE_API void	FreeLuceneDocument (LuceneDocument *doc_p)
	Free a LuceneDocument. More...
GRASSROOTS_LUCENE_API bool	AddFieldToLuceneDocument (LuceneDocument *doc_p, const char *key_s, const char *value_s)
	Add a field to a LuceneDocument. More...

Data Fields
json_t *	ld_store_p

Detailed Description

A datatype for holding Lucene Documents.

Member Function Documentation

AllocateLuceneDocument()

GRASSROOTS_LUCENE_API LuceneDocument * AllocateLuceneDocument

(

void

)

Allocate a LuceneDocument.

Returns

A newly-allocated LuceneDocument or NULL upon error.

FreeLuceneDocument()

GRASSROOTS_LUCENE_API void FreeLuceneDocument

(

LuceneDocument *

doc_p

)

Free a LuceneDocument.

Parameters

doc_p

The LuceneDocument to free.

AddFieldToLuceneDocument()

GRASSROOTS_LUCENE_API bool AddFieldToLuceneDocument	(	LuceneDocument *	doc_p,
		const char *	key_s,
		const char *	value_s
	)

Add a field to a LuceneDocument.

Parameters

doc_p

The LuceneDocument to amend.

Field Documentation

ld_store_p

json_t* ld_store_p

---

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

• lucene_document.h