Blame view

morfeusz/wrappers/morfeusz_javadoc.i 4.14 KB
Michał Lenart authored
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
%typemap(javaimports) morfeusz::Morfeusz %{
import java.io.IOException;
import java.lang.RuntimeException;
import java.util.List;
import java.util.ArrayList;

/**
 * Performs morphological analysis (analyse methods) and syntesis (generate methods).
 * 
 * It is NOT thread-safe
 * but it is possible to use separate Morfeusz instance for each concurrent thread.
 */
%}

%typemap(javaimports) morfeusz::ResultsIterator %{
/**
 * Iterates through morphological analysis and synthesis results.
 * 
 */
%}

%typemap(javaimports) morfeusz::MorphInterpretation %{
/**
 * <p>The result of morphological analysis or synthesis</p>
 * 
 * <p>
 * The result of analysis is  a directed acyclic graph with numbered
 * nodes representing positions  in text (points _between_ segments)
 * and edges representing interpretations of segments that span from
 * one node to another.  E.g.,
 * <pre>
 * {0,1,"ja","ja","ppron12:sg:nom:m1.m2.m3.f.n1.n2:pri"}
 *       |
 *       |      {1,2,"został","zostać","praet:sg:m1.m2.m3:perf"}
 *       |      |
 *     __|  ____|   __{2,3,"em","być","aglt:sg:pri:imperf:wok"}
 *    /  \ /     \ / \
 *   * Ja * został*em *
 *   0    1       2   3
 * </pre>
 * </p>
 * 
 * <p>
 * Note that the word 'zostałem' got broken into 2 separate segments.
 * </p>

 * <p>One MorphInterpretation instance describes one edge of this DAG.</p>
 */
%}

%typemap(javaimports) morfeusz::IdResolver %{
/**
 * Represents mappings for tags, names and labels.
 */
%}

%typemap(javaimports) morfeusz::WhitespaceHandling %{
/**
 * Represents whitespace handling strategies (default is SKIP_WHITESPACES).
 */
%}

%typemap(javaimports) morfeusz::CaseHandling %{
/**
 * Represents case handling strategies (default is CONDITIONALLY_CASE_SENSITIVE).
 */
%}

%typemap(javaimports) morfeusz::TokenNumbering %{
/**
 * Represents token numbering strategies (default is SEPARATE_NUMBERING).
 */
%}
Michał Lenart authored
75
%javamethodmodifiers morfeusz::Morfeusz::createInstance "
Michał Lenart authored
76
77
78
79
80
    /**
     * Creates actual instance of Morfeusz class.
     * 
     * @return Morfeusz instance
     */
Michał Lenart authored
81
    public synchronized";
Michał Lenart authored
82
83
84
85
86
87
88
89

%javamethodmodifiers morfeusz::Morfeusz::getVersion() "
    /**
     * Returns a string containing library version.
     * @return library version string
     */
    public";
Michał Lenart authored
90
%javamethodmodifiers morfeusz::Morfeusz::analyseAsIterator(const char*) const "
Michał Lenart authored
91
92
93
94
    /**
     * Analyze given text and return the results as iterator.
     * It does not store results for whole text at once, so may be less memory-consuming for analysis of big texts.
     * 
Michał Lenart authored
95
96
     * NOT THREAD-SAFE (must have exclusive access to this instance).
     * 
Michał Lenart authored
97
98
99
100
101
102
103
104
105
     * @param text text for morphological analysis.
     * @return iterator over morphological analysis results
     */
    public";

%javamethodmodifiers morfeusz::Morfeusz::setAggl(const std::string&) "
    /**
     * Set aggl segmentation option value.
     * 
Michał Lenart authored
106
107
     * NOT THREAD-SAFE (must have exclusive access to this instance).
     * 
Michał Lenart authored
108
     * @param aggl aggl value
Michał Lenart authored
109
     * @throws MorfeuszException when invalid aggl parameter provided
Michał Lenart authored
110
111
112
113
114
115
116
     */
    public";

%javamethodmodifiers morfeusz::Morfeusz::setPraet(const std::string&) "
    /**
     * Set praet segmentation option value.
     * 
Michał Lenart authored
117
118
     * NOT THREAD-SAFE (must have exclusive access to this instance).
     * 
Michał Lenart authored
119
     * @param praet praet value
Michał Lenart authored
120
     * @throws MorfeuszException when invalid praet parameter provided
Michał Lenart authored
121
122
123
124
125
126
127
     */
    public";

%javamethodmodifiers morfeusz::Morfeusz::setCaseHandling(CaseHandling) "
    /**
     * Set case handling.
     * 
Michał Lenart authored
128
129
     * NOT THREAD-SAFE (must have exclusive access to this instance).
     * 
Michał Lenart authored
130
131
132
133
134
135
136
137
     * @param caseHandling case handling policy
     */
    public";

%javamethodmodifiers morfeusz::Morfeusz::setTokenNumbering(TokenNumbering) "
    /**
     * Set token numbering policy.
     * 
Michał Lenart authored
138
139
     * NOT THREAD-SAFE (must have exclusive access to this instance).
     * 
Michał Lenart authored
140
141
142
143
144
145
146
147
     * @param numbering token numbering policy
     */
    public";

%javamethodmodifiers morfeusz::Morfeusz::setWhitespaceHandling(WhitespaceHandling) "
    /**
     * Set whitespace handling.
     * 
Michał Lenart authored
148
149
     * NOT THREAD-SAFE (must have exclusive access to this instance).
     * 
Michał Lenart authored
150
151
152
     * @param whitespaceHandling whitespace handling policy
     */
    public";