rulex

1
.\"                                      Hey, EMACS: -*- nroff -*-
2
.TH RULEXDB_FETCH_RULE 3 "February 19, 2012"
3
.SH NAME
4
rulexdb_fetch_rule \- extract specified rule from the rulex database
5
.SH SYNOPSIS
6
.nf
7
.B #include <rulexdb.h>
8
.sp
9
.BI "char *rulexdb_fetch_rule(RULEXDB *" rulexdb ", int " rule_type \
10
", int " position );
11
.fi
12
.SH DESCRIPTION
13
The
14
.BR rulexdb_fetch_rule ()
15
function retrieves a rule identified by its type and position in the
16
ruleset from the rulex database
17
referenced by
18
.I rulexdb
19
argument.
20
.PP
21
The argument
22
.I rule_type
23
specifies the rule type. It may accept one of the following values:
24
.TP
25
.B RULEXDB_LEXCLASS
26
The rule is the word classifier and belongs to the \fBClassifiers\fP
27
dataset.
28
.TP
29
.B RULEXDB_PREFIX
30
The rule describes prefix detection and replacement and belongs to the
31
 \fBPrefix detectors\fP ruleset.
32
.TP
33
.B RULEXDB_RULE
34
The requested rule should be extracted from the \fBGeneral\fP rules
35
dataset.
36
.TP
37
.B RULEXDB_CORRECTOR
38
The rule is a correction rule that belongs to the \fBCorrectors\fP
39
dataset.
40
.PP
41
The argument
42
.I position
43
defines position of the requested rule in the ruleset.
44
.SH "RETURN VALUE"
45
Upon success, the
46
.BR rulexdb_fetch_rule ()
47
function returns pointer to the textual representation of the
48
extracted rule. This pointer remains valid until the next database
49
operation. Otherwise, NULL is returned.
50
.SH SEE ALSO
51
.BR rulexdb_classify (3),
52
.BR rulexdb_close (3),
53
.BR rulexdb_dataset_name (3),
54
.BR rulexdb_discard_dictionary (3),
55
.BR rulexdb_discard_ruleset (3),
56
.BR rulexdb_lexbase (3),
57
.BR rulexdb_load_ruleset (3),
58
.BR rulexdb_open (3),
59
.BR rulexdb_remove_item (3),
60
.BR rulexdb_remove_rule (3),
61
.BR rulexdb_remove_this_item (3),
62
.BR rulexdb_retrieve_item (3),
63
.BR rulexdb_search (3),
64
.BR rulexdb_seq (3),
65
.BR rulexdb_subscribe_item (3),
66
.BR rulexdb_subscribe_rule (3)
67
.SH AUTHOR
68
Igor B. Poretsky <poretsky@mlbox.ru>.
69