strus  0.17
Static Public Member Functions | List of all members
strus::Constants Struct Reference

Some reserved global constants that document some dependencies (hacks) that did not get yet into interfaces (and probably never will). More...

#include <constants.hpp>

Static Public Member Functions

static const char * attribute_docid ()
 Get the attribute name for the document id. More...
 
static const char * identifier_docno ()
 Get the name reserved for the internal document number. More...
 
static const char * identifier_acl ()
 Get the name reserved for addressing ACLs (access control lists) More...
 
static const char * identifier_position ()
 Get the name reserved for ordinal positions assigned to terms in a document. More...
 
static const char * operator_set_union ()
 Get the name of the set union operator for postings. More...
 
static const char * operator_query_phrase_same_position ()
 Get the name of the set join operator for postings for query phrase terms that got the same position asigned. More...
 
static const char * operator_query_phrase_sequence ()
 Get the name of the set join operator for postings for query phrase terms that got ascending position assigned. More...
 
static const char * query_empty_postings_termtype ()
 Get the term type that does not exist and is reserved for the empty posting set. More...
 
static unsigned int storage_max_position_info ()
 Get the maximum position (counted from 1) in a document a token can have. More...
 
static const char * standard_vector_storage ()
 Get the name of the standard (default) vector storage. More...
 
static const char * standard_vector_storage_module ()
 Get the name of the standard (default) vector storage module. More...
 
static const char * standard_pattern_matcher ()
 Get the name of the standard (default) pattern matcher. More...
 
static const char * standard_pattern_matcher_module ()
 Get the name of the standard (default) pattern match module. More...
 
static char standard_word2vec_type_feature_separator ()
 Get the default type feature separator in a word2vec vector file (where you have only a single identifier describing the item) More...
 

Detailed Description

Some reserved global constants that document some dependencies (hacks) that did not get yet into interfaces (and probably never will).

Member Function Documentation

static const char* strus::Constants::attribute_docid ( )
inlinestatic

Get the attribute name for the document id.

Note
The inserter program set this attribute implicitely to the value of the path of the document inserted
static const char* strus::Constants::identifier_acl ( )
inlinestatic

Get the name reserved for addressing ACLs (access control lists)

static const char* strus::Constants::identifier_docno ( )
inlinestatic

Get the name reserved for the internal document number.

static const char* strus::Constants::identifier_position ( )
inlinestatic

Get the name reserved for ordinal positions assigned to terms in a document.

static const char* strus::Constants::operator_query_phrase_same_position ( )
inlinestatic

Get the name of the set join operator for postings for query phrase terms that got the same position asigned.

Note
The standard query language uses this operator to build query expressions for phrases in case of multiple occurrencies of distinct terms at the same position in the query
static const char* strus::Constants::operator_query_phrase_sequence ( )
inlinestatic

Get the name of the set join operator for postings for query phrase terms that got ascending position assigned.

Note
The standard query language uses this operator to build query expressions for phrases in case of subsequent occurrencies of terms in a query phrase
static const char* strus::Constants::operator_set_union ( )
inlinestatic

Get the name of the set union operator for postings.

Note
The query evaluation uses implicitely this operator to make joins of posting sets that have to be merged before passing it to some function (like for example the structure element posting set passed to summarizers)
static const char* strus::Constants::query_empty_postings_termtype ( )
inlinestatic

Get the term type that does not exist and is reserved for the empty posting set.

static const char* strus::Constants::standard_pattern_matcher ( )
inlinestatic

Get the name of the standard (default) pattern matcher.

static const char* strus::Constants::standard_pattern_matcher_module ( )
inlinestatic

Get the name of the standard (default) pattern match module.

static const char* strus::Constants::standard_vector_storage ( )
inlinestatic

Get the name of the standard (default) vector storage.

static const char* strus::Constants::standard_vector_storage_module ( )
inlinestatic

Get the name of the standard (default) vector storage module.

static char strus::Constants::standard_word2vec_type_feature_separator ( )
inlinestatic

Get the default type feature separator in a word2vec vector file (where you have only a single identifier describing the item)

static unsigned int strus::Constants::storage_max_position_info ( )
inlinestatic

Get the maximum position (counted from 1) in a document a token can have.

Note
This is a limit given by the implementation of the position info block. Unfortunately it creeps through the system.

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