view_format.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	ViewFormat {   VF_STORAGE, VF_CLIENT_FULL, VF_CLIENT_MINIMAL, VF_INDEXING,   VF_REFERENCE, VF_NUM_FORMATS }
	An indicator of what the output destination is for the JSON data values. More...

Enumeration Type Documentation

ViewFormat

enum ViewFormat

An indicator of what the output destination is for the JSON data values.

This lets us know whether we need to e.g. expand fields to full objects from their ids, or omit certain fields entirely

Enumerator
VF_STORAGE	This is for generating JSON to be stored in the server-side mongo db.
VF_CLIENT_FULL	This is for generating a full data set for displaying within a client.
VF_CLIENT_MINIMAL	This is for generating a minimal data set for displaying within a client. This is used when doing LinkedService calls to get subsequent child data.
VF_INDEXING	Get the object with all of the relevant data needed for indexing into the Lucene component.
VF_REFERENCE	Store just a reference to the object such as a bson_oid.
VF_NUM_FORMATS	The number of available formats.