Home

facet_options Class Reference
[Faceting]

Interface class for representing user-specified faceting requirements. More...

#include <facet_options.hxx>

Inheritance diagram for facet_options:

Inheritance graph
[legend]
Collaboration diagram for facet_options:

Collaboration graph
[legend]

List of all members.

Public Member Functions

facet_options_expertget_expert_options ()
 Returns a facet_options_expert object that is based upon this object.


Detailed Description

Interface class for representing user-specified faceting requirements.


Role: This class serves as a base class for the workflow-specific facet-option classes, including facet_options_visualization, facet_options_precise, and facet_options_expert. Instances of these classes are utilized by api_facet_entity, api_facet_entities, api_facet_unfaceted_entity, api_facet_unfaceted_entities, and FacetEntity.

Note: Each of the derived classes possess the same set of parameters. The differences among the derived classes are their interfaces and default parameter values. These provide very different behaviors for the different facet option classes.

For additional information refer to the Technical Article Facet Options.

See also:
facet_options_visualization, facet_options_precise, facet_options_expert.

Member Function Documentation

facet_options_expert& facet_options::get_expert_options (  ) 

Returns a facet_options_expert object that is based upon this object.



Role: The facet_options_visualization and facet_options_precise classes have been optimized for particular workflows. Users willing to take more risk for the sake of additional customizability may use the get_expert_options method to convert any of the workflow-based options into an expert options object. The expert options object allows the customization of all parameters.

The expert options object reference obtained by this method is essentially the same options object, with more controls exposed.

Reimplemented in facet_options_expert.