~ubuntu-branches/ubuntu/trusty/hyperestraier/trusty-proposed

The function `est_doc_set_keywords' is used in order to attach keywords to a document object.

.TP

.B void est_doc_set_keywords(ESTDOC *doc, CBMAP *kwords);

`doc' specifies a document object.  `kwords' specifies a map object of keywords.  Keys of the map should be keywords of the document and values should be their scores in decimal string.  The map object is copied internally.

.PP

The function `est_doc_set_score' is used in order to set the substitute score of a document object.

.TP

.B void est_doc_set_score(ESTDOC *doc, int score);

`doc' specifies a document object.  `score' specifies the substitute score.  It it is negative, the substitute score setting is nullified.

.PP

The function `est_doc_keywords' is used in order to get attached keywords of a document object.

.TP

.B CBMAP *est_doc_keywords(ESTDOC *doc);

`doc' specifies a document object.  The return value is a map object of keywords and their scores in decimal string.  If no keyword is attached, `NULL' is returned.  The life duration of the returned object is synchronous with the one of the document object.

.PP

The function `est_cond_set_skip' is used in order to set the number of skipped documents of a condition object.

.TP

.B void est_cond_set_skip(ESTCOND *cond, int skip);

`cond' specifies a condition object.  `skip' specifies the number of documents to be skipped in the search result.

.PP

`cond' specifies a condition object.  `options' specifies options: `ESTCONDSURE' specifies that it checks every N\-gram key, `ESTCONDUSUAL', which is the default, specifies that it checks N\-gram keys with skipping one key, `ESTCONDFAST' skips two keys, `ESTCONDAGITO' skips three keys, `ESTCONDNOIDF' specifies not to perform TF\-IDF tuning, `ESTCONDSIMPLE' specifies to use simplified phrase, `ESTCONDROUGH' specifies to use rustic phrase, `ESTCONDUNION' specifies to use union phrase, `ESTCONDISECT' specifies to use intersection phrase, `ESTCONDSCFB' specifies to feed back scores (only for debugging).  Each option can be specified at the same time by bitwise or.  If keys are skipped, though search speed is improved, the relevance ratio grows less.

.PP

The function `est_cond_set_auxiliary' is used in order to set permission to adopt result of the auxiliary index.

.TP

.B void est_cond_set_auxiliary(ESTCOND *cond, int min);

`cond' specifies a condition object.  `min' specifies the minimum hits to adopt result of the auxiliary index.  If it is not more than 0, the auxiliary index is not used.  By default, it is 32.

`cond' specifies a condition object.  `limit' specifies the lower limit of similarity for documents to be eclipsed.  Similarity is between 0.0 and 1.0.  If the limit is added by `ESTECLSIMURL', similarity is weighted by URL.  If the limit is `ESTECLSERV', similarity is ignored and documents in the same server are eclipsed.  If the limit is `ESTECLDIR', similarity is ignored and documents in the same directory are eclipsed.  If the limit is `ESTECLFILE', similarity is ignored and documents of the same file are eclipsed.

.PP

The function `est_cond_set_distinct' is used in order to set the attribute distinction filter.

.TP

.B void est_cond_set_distinct(ESTCOND *cond, const char *name);

`cond' specifies a condition object.  `name' specifies the name of an attribute to be distinct.  If this filter is set, candidates which have same value of the attribute is omitted.

.PP

The function `est_set_cond_mask' is used in order to set the mask of targets of meta search.

.TP

.B void est_cond_set_mask(ESTCOND *cond, int mask);

`cond' specifies a condition object.  `mask' specifies a masking number.  1 means the first target, 2 means the second target, 4 means the third target, and power values of 2 and their summation compose the mask.

`name' specifies the name of a database directory.  `omode' specifies open modes: `ESTDBWRITER' as a writer, `ESTDBREADER' as a reader.  If the mode is `ESTDBWRITER', the following may be added by bitwise or: `ESTDBCREAT', which means it creates a new database if not exist, `ESTDBTRUNC', which means it creates a new database regardless if one exists.  Both of `ESTDBREADER' and  `ESTDBWRITER' can be added to by bitwise or: `ESTDBNOLCK', which means it opens a database file without file locking, or `ESTDBLCKNB', which means locking is performed without blocking.  If `ESTDBNOLCK' is used, the application is responsible for exclusion control.  `ESTDBCREAT' can be added to by bitwise or: `ESTDBPERFNG', which means N\-gram analysis is performed against European text also, `ESTDBSMALL', which means the index is tuned to register less than 50000 documents, `ESTDBLARGE', which means the index is tuned to register more than 300000 documents, `ESTDBHUGE', which means the index is tuned to register more than 1000000 documents, `ESTDBHUGE2', which means the index is tuned to register more than 5000000 documents, `ESTDBHUGE3', which means the index is tuned to register more than 10000000 documents, `ESTDBSCVOID', which means scores are stored as void, `ESTDBSCINT', which means scores are stored as 32-bit integer, `ESTDBSCASIS', which means scores are stored as-is and marked not to be tuned when search.  `ecp' specifies the pointer to a variable to which the error code is assigned.  The return value is a database object of the database or `NULL' if failure.

The function `est_db_add_attr_index' is used in order to add an index for narrowing or sorting with document attributes.

.TP

.B int est_db_add_attr_index(ESTDB *db, const char *name, int type);

`db' specifies a database object connected as a writer.  `name' specifies the name of an attribute.  `type' specifies the data type of attribute index; `ESTIDXATTRSEQ' for multipurpose sequencial access method, `ESTIDXATTRSTR' for narrowing with attributes as strings, `ESTIDXATTRNUM' for narrowing with attributes as numbers.  The return value is true if success, else it is false.  Note that this function should be called before the first document is registered.

.PP

`db' specifies a database object connected as a writer.  `options' specifies options: `ESTOPTNOPURGE' to omit purging dispensable region of deleted documents, `ESTOPTNODBOPT' to omit optimization of the database files.  The three can be specified at the same time by bitwise or.  The return value is true if success, else it is false.

.PP

The function `est_db_merge' is used in order to merge another database.

.TP

.B int est_db_merge(ESTDB *db, const char *name, int options);

`db' specifies a database object connected as a writer.  `name' specifies the name of another database directory.  `options' specifies options: `ESTMGCLEAN' to clean up dispensable regions of the deleted document.  The return value is true if success, else it is false.  Creation options of the two databases should be same entirely.  ID numbers of imported documents are changed within the sequence of the desitination database.  If URIs of imported documents conflict ones of exsisting documents, existing documents are removed.

`db' specifies a database object connected as a writer.  `doc' specifies a document object.  The document object should have the URI attribute.  `options' specifies options: `ESTPDCLEAN' to clean up dispensable regions of the overwritten document, `ESTPDWEIGHT' to weight scores statically with score weighting attribute.  The return value is true if success, else it is false.  If the URI attribute is same with an existing document in the database, the existing one is deleted.

`db' specifies a database object.  `id' specifies the ID number of a registered document.  `options' specifies options: `ESTGDNOATTR' to ignore attributes, `ESTGDNOTEXT' to ignore the body text, `ESTGDNOKWD' to ignore keywords.  The two can be specified at the same time by bitwise or.  The return value is a document object.  It should be deleted with `est_doc_delete' if it is no longer in use.  On error, `NULL' is returned.

The function `est_db_search' is used in order to search a database for documents corresponding a condition.

Search plural databases for documents corresponding a condition.

.TP

.B int *est_db_search_meta(ESTDB **dbs, int dbnum, ESTCOND *cond, int *nump, CBMAP *hints);

`dbs' specifies an array whose elements are database objects.  `dbnum' specifies the number of elements of the array.  `cond' specifies a condition object.  `nump' specifies the pointer to a variable to which the number of elements in the result is assigned.  `hints' specifies a map object into which the number of documents corresponding to each word is stored.  If a word is in a negative condition, the number is negative.  The element whose key is an empty string specifies the number of whole result.  If it is `NULL', it is not used.  The return value is an array whose elements are indexes of container databases and ID numbers of in each database alternately.  This function does never fail.  Even if no document corresponds or an error occurs, an empty array is returned.  Because the region of the return value is allocated with the `malloc' call, it should be released with the `free' call if it is no longer in use.

.PP

`db' specifies a database object.  `size' specifies the maximum size of the index cache.  By default, it is 64MB.  If it is negative, the current size is not changed.  `anum' specifies the maximum number of cached records for document attributes.  By default, it is 8192.  If it is negative, the current size is not changed.  `tnum' specifies the maximum number of cached records for document texts.  By default, it is 1024.  If it is negative, the current size is not changed.  `rnum' specifies the maximum number of cached records for occurrence results.  By default, it is 256.  If it is negative, the current size is not changed.

.BR estconfig (1),

.BR estmaster (1),

.BR estcall (1),

.BR estwaver (1),