Skip to content

Commit ef78da0

Browse files
yevgen-nykytenkoyevgen-nykytenko
committed
Update file(s) "/." from "groupdocs-search/Groupdocs.Search-References"
1 parent 4f647ef commit ef78da0

176 files changed

Lines changed: 6485 additions & 2610 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/sites/groupdocs/search/english/java/_index.md‎

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,29 @@ is_root: true
1010
## Packages
1111
| Package | Description |
1212
| --- | --- |
13-
| [com.groupdocs.search](./com.groupdocs.search) | The package provides classes for indexing and searching text data in documents of different formats. |
14-
| [com.groupdocs.search.common](./com.groupdocs.search.common) | The package provides common classes of the library. |
15-
| [com.groupdocs.search.dictionaries](./com.groupdocs.search.dictionaries) | The package provides classes of various dictionaries. |
16-
| [com.groupdocs.search.events](./com.groupdocs.search.events) | The package provides classes of event arguments. |
13+
| [com.groupdocs.search](./com.groupdocs.search) | The package provides classes for indexing and searching text data in documents of different formats.
14+
|
15+
| [com.groupdocs.search.common](./com.groupdocs.search.common) | The package provides common classes of the library.
16+
|
17+
| [com.groupdocs.search.dictionaries](./com.groupdocs.search.dictionaries) | The package provides classes of various dictionaries.
18+
|
19+
| [com.groupdocs.search.events](./com.groupdocs.search.events) | The package provides classes of event arguments.
20+
|
1721
| [com.groupdocs.search.exceptions](./com.groupdocs.search.exceptions) | |
1822
| [com.groupdocs.search.helpers](./com.groupdocs.search.helpers) | |
19-
| [com.groupdocs.search.highlighters](./com.groupdocs.search.highlighters) | The package provides highlighters for highlighting search results in text. |
23+
| [com.groupdocs.search.highlighters](./com.groupdocs.search.highlighters) | The package provides highlighters for highlighting search results in text.
24+
|
2025
| [com.groupdocs.search.licenses](./com.groupdocs.search.licenses) | |
2126
| [com.groupdocs.search.logging](./com.groupdocs.search.logging) | |
22-
| [com.groupdocs.search.options](./com.groupdocs.search.options) | The package provides classes to specify additional options of various operations. |
23-
| [com.groupdocs.search.results](./com.groupdocs.search.results) | The package provides search result classes. |
24-
| [com.groupdocs.search.scaling](./com.groupdocs.search.scaling) | The namespace provides classes of scaling functionality. |
25-
| [com.groupdocs.search.scaling.configuring](./com.groupdocs.search.scaling.configuring) | The namespace provides classes for configuring the search network. |
26-
| [com.groupdocs.search.scaling.events](./com.groupdocs.search.scaling.events) | The namespace provides classes of event arguments in the search network. |
27-
| [com.groupdocs.search.scaling.results](./com.groupdocs.search.scaling.results) | The namespace provides the search result classes in the search network. |
27+
| [com.groupdocs.search.options](./com.groupdocs.search.options) | The package provides classes to specify additional options of various operations.
28+
|
29+
| [com.groupdocs.search.results](./com.groupdocs.search.results) | The package provides search result classes.
30+
|
31+
| [com.groupdocs.search.scaling](./com.groupdocs.search.scaling) | The namespace provides classes of scaling functionality.
32+
|
33+
| [com.groupdocs.search.scaling.configuring](./com.groupdocs.search.scaling.configuring) | The namespace provides classes for configuring the search network.
34+
|
35+
| [com.groupdocs.search.scaling.events](./com.groupdocs.search.scaling.events) | The namespace provides classes of event arguments in the search network.
36+
|
37+
| [com.groupdocs.search.scaling.results](./com.groupdocs.search.scaling.results) | The namespace provides the search result classes in the search network.
38+
|

‎content/sites/groupdocs/search/english/java/com.groupdocs.search.common/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ url: /java/com.groupdocs.search.common/
1010
The package provides common classes of the library.
1111

1212

13+
1314
## Classes
1415

1516
| Class | Description |

‎content/sites/groupdocs/search/english/java/com.groupdocs.search.common/attributechangebatch/_index.md‎

Lines changed: 62 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,42 @@ public class AttributeChangeBatch
1414

1515
Represents a container for attribute changes.
1616

17-
**Learn more**
1817

19-
* [Document attributes][]
20-
* [Document filtering in search result][]
18+
**Learn more**
2119

20+
* [Document attributes](../https://docs.groupdocs.com/display/searchjava/Document+attributes)
21+
* [Document filtering in search result](../https://docs.groupdocs.com/display/searchjava/Document+filtering+in+search+result)
2222

23-
[Document attributes]: https://docs.groupdocs.com/display/searchjava/Document+attributes
24-
[Document filtering in search result]: https://docs.groupdocs.com/display/searchjava/Document+filtering+in+search+result
2523
## Constructors
2624

2725
| Constructor | Description |
2826
| --- | --- |
29-
| [AttributeChangeBatch()](#AttributeChangeBatch--) | Initializes a new instance of the AttributeChangeBatch class. |
30-
| [AttributeChangeBatch(Object data)](#AttributeChangeBatch-java.lang.Object-) | Initializes a new instance of the AttributeChangeBatch class. |
27+
| [AttributeChangeBatch()](#AttributeChangeBatch--) | Initializes a new instance of the AttributeChangeBatch class.
28+
|
29+
| [AttributeChangeBatch(Object data)](#AttributeChangeBatch-java.lang.Object-) | Initializes a new instance of the AttributeChangeBatch class.
30+
|
3131
## Methods
3232

3333
| Method | Description |
3434
| --- | --- |
35-
| [add(String path, String[] attributes)](#add-java.lang.String-java.lang.String...-) | Adds the specified attributes to the specified indexed document. |
36-
| [add(String[] paths, String[] attributes)](#add-java.lang.String---java.lang.String...-) | Adds the specified attributes to the specified indexed documents. |
37-
| [addToAll(String[] attributes)](#addToAll-java.lang.String...-) | Adds the specified attributes to all documents in the index. |
38-
| [remove(String path, String[] attributes)](#remove-java.lang.String-java.lang.String...-) | Removes the specified attributes from the specified indexed document. |
39-
| [remove(String[] paths, String[] attributes)](#remove-java.lang.String---java.lang.String...-) | Removes the specified attributes from the specified indexed documents. |
40-
| [removeAll(String path)](#removeAll-java.lang.String-) | Removes all attributes from the specified indexed document. |
41-
| [removeAll(String[] paths)](#removeAll-java.lang.String---) | Removes all attributes from the specified indexed documents. |
42-
| [removeFromAll(String[] attributes)](#removeFromAll-java.lang.String...-) | Removes the specified attributes from all documents in the index. |
43-
| [clear()](#clear--) | Removes all attributes from all documents in the index. |
35+
| [add(String path, String[] attributes)](#add-java.lang.String-java.lang.String...-) | Adds the specified attributes to the specified indexed document.
36+
|
37+
| [add(String[] paths, String[] attributes)](#add-java.lang.String---java.lang.String...-) | Adds the specified attributes to the specified indexed documents.
38+
|
39+
| [addToAll(String[] attributes)](#addToAll-java.lang.String...-) | Adds the specified attributes to all documents in the index.
40+
|
41+
| [remove(String path, String[] attributes)](#remove-java.lang.String-java.lang.String...-) | Removes the specified attributes from the specified indexed document.
42+
|
43+
| [remove(String[] paths, String[] attributes)](#remove-java.lang.String---java.lang.String...-) | Removes the specified attributes from the specified indexed documents.
44+
|
45+
| [removeAll(String path)](#removeAll-java.lang.String-) | Removes all attributes from the specified indexed document.
46+
|
47+
| [removeAll(String[] paths)](#removeAll-java.lang.String---) | Removes all attributes from the specified indexed documents.
48+
|
49+
| [removeFromAll(String[] attributes)](#removeFromAll-java.lang.String...-) | Removes the specified attributes from all documents in the index.
50+
|
51+
| [clear()](#clear--) | Removes all attributes from all documents in the index.
52+
|
4453
| [getCore()](#getCore--) | |
4554
### AttributeChangeBatch() {#AttributeChangeBatch--}
4655
```
@@ -50,6 +59,7 @@ public AttributeChangeBatch()
5059

5160
Initializes a new instance of the AttributeChangeBatch class.
5261

62+
5363
### AttributeChangeBatch(Object data) {#AttributeChangeBatch-java.lang.Object-}
5464
```
5565
public AttributeChangeBatch(Object data)
@@ -58,10 +68,12 @@ public AttributeChangeBatch(Object data)
5868

5969
Initializes a new instance of the AttributeChangeBatch class.
6070

71+
6172
**Parameters:**
6273
| Parameter | Type | Description |
6374
| --- | --- | --- |
64-
| data | java.lang.Object | The serialized data. |
75+
| data | java.lang.Object | The serialized data.
76+
|
6577

6678
### add(String path, String[] attributes) {#add-java.lang.String-java.lang.String...-}
6779
```
@@ -71,11 +83,14 @@ public void add(String path, String[] attributes)
7183

7284
Adds the specified attributes to the specified indexed document.
7385

86+
7487
**Parameters:**
7588
| Parameter | Type | Description |
7689
| --- | --- | --- |
77-
| path | java.lang.String | The document path. |
78-
| attributes | java.lang.String[] | The attributes to add. |
90+
| path | java.lang.String | The document path.
91+
|
92+
| attributes | java.lang.String[] | The attributes to add.
93+
|
7994

8095
### add(String[] paths, String[] attributes) {#add-java.lang.String---java.lang.String...-}
8196
```
@@ -85,11 +100,14 @@ public void add(String[] paths, String[] attributes)
85100

86101
Adds the specified attributes to the specified indexed documents.
87102

103+
88104
**Parameters:**
89105
| Parameter | Type | Description |
90106
| --- | --- | --- |
91-
| paths | java.lang.String[] | The documents paths. |
92-
| attributes | java.lang.String[] | The attributes to add. |
107+
| paths | java.lang.String[] | The documents paths.
108+
|
109+
| attributes | java.lang.String[] | The attributes to add.
110+
|
93111

94112
### addToAll(String[] attributes) {#addToAll-java.lang.String...-}
95113
```
@@ -99,10 +117,12 @@ public void addToAll(String[] attributes)
99117

100118
Adds the specified attributes to all documents in the index.
101119

120+
102121
**Parameters:**
103122
| Parameter | Type | Description |
104123
| --- | --- | --- |
105-
| attributes | java.lang.String[] | The attributes to add. |
124+
| attributes | java.lang.String[] | The attributes to add.
125+
|
106126

107127
### remove(String path, String[] attributes) {#remove-java.lang.String-java.lang.String...-}
108128
```
@@ -112,11 +132,14 @@ public void remove(String path, String[] attributes)
112132

113133
Removes the specified attributes from the specified indexed document.
114134

135+
115136
**Parameters:**
116137
| Parameter | Type | Description |
117138
| --- | --- | --- |
118-
| path | java.lang.String | The document path. |
119-
| attributes | java.lang.String[] | The attributes to remove. |
139+
| path | java.lang.String | The document path.
140+
|
141+
| attributes | java.lang.String[] | The attributes to remove.
142+
|
120143

121144
### remove(String[] paths, String[] attributes) {#remove-java.lang.String---java.lang.String...-}
122145
```
@@ -126,11 +149,14 @@ public void remove(String[] paths, String[] attributes)
126149

127150
Removes the specified attributes from the specified indexed documents.
128151

152+
129153
**Parameters:**
130154
| Parameter | Type | Description |
131155
| --- | --- | --- |
132-
| paths | java.lang.String[] | The documents paths. |
133-
| attributes | java.lang.String[] | The attributes to remove. |
156+
| paths | java.lang.String[] | The documents paths.
157+
|
158+
| attributes | java.lang.String[] | The attributes to remove.
159+
|
134160

135161
### removeAll(String path) {#removeAll-java.lang.String-}
136162
```
@@ -140,10 +166,12 @@ public void removeAll(String path)
140166

141167
Removes all attributes from the specified indexed document.
142168

169+
143170
**Parameters:**
144171
| Parameter | Type | Description |
145172
| --- | --- | --- |
146-
| path | java.lang.String | The document path. |
173+
| path | java.lang.String | The document path.
174+
|
147175

148176
### removeAll(String[] paths) {#removeAll-java.lang.String---}
149177
```
@@ -153,10 +181,12 @@ public void removeAll(String[] paths)
153181

154182
Removes all attributes from the specified indexed documents.
155183

184+
156185
**Parameters:**
157186
| Parameter | Type | Description |
158187
| --- | --- | --- |
159-
| paths | java.lang.String[] | The documents paths. |
188+
| paths | java.lang.String[] | The documents paths.
189+
|
160190

161191
### removeFromAll(String[] attributes) {#removeFromAll-java.lang.String...-}
162192
```
@@ -166,10 +196,12 @@ public void removeFromAll(String[] attributes)
166196

167197
Removes the specified attributes from all documents in the index.
168198

199+
169200
**Parameters:**
170201
| Parameter | Type | Description |
171202
| --- | --- | --- |
172-
| attributes | java.lang.String[] | The attributes to remove. |
203+
| attributes | java.lang.String[] | The attributes to remove.
204+
|
173205

174206
### clear() {#clear--}
175207
```
@@ -179,6 +211,7 @@ public void clear()
179211

180212
Removes all attributes from all documents in the index.
181213

214+
182215
### getCore() {#getCore--}
183216
```
184217
public Object getCore()

‎content/sites/groupdocs/search/english/java/com.groupdocs.search.common/cancellation/_index.md‎

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,40 @@ public class Cancellation
1414

1515
Represents an object for requesting cancellation of an operation.
1616

17-
**Learn more**
1817

19-
* [Indexing options][]
20-
* [Search options][]
18+
**Learn more**
2119

20+
* [Indexing options](../https://docs.groupdocs.com/display/searchjava/Indexing+options)
21+
* [Search options](../https://docs.groupdocs.com/display/searchjava/Search+options)
2222

23-
[Indexing options]: https://docs.groupdocs.com/display/searchjava/Indexing+options
24-
[Search options]: https://docs.groupdocs.com/display/searchjava/Search+options
2523
## Constructors
2624

2725
| Constructor | Description |
2826
| --- | --- |
29-
| [Cancellation()](#Cancellation--) | Initializes a new instance of the Cancellation class. |
27+
| [Cancellation()](#Cancellation--) | Initializes a new instance of the
28+
Cancellation
29+
class.
30+
|
3031
## Methods
3132

3233
| Method | Description |
3334
| --- | --- |
34-
| [isCancelled()](#isCancelled--) | Gets a value indicating that cancellation has been requested. |
35-
| [cancel()](#cancel--) | Makes a request for cancellation. |
36-
| [cancelAfter(int milliseconds)](#cancelAfter-int-) | Makes a request for cancellation after the expiration of specified number of milliseconds. |
35+
| [isCancelled()](#isCancelled--) | Gets a value indicating that cancellation has been requested.
36+
|
37+
| [cancel()](#cancel--) | Makes a request for cancellation.
38+
|
39+
| [cancelAfter(int milliseconds)](#cancelAfter-int-) | Makes a request for cancellation after the expiration of specified number of milliseconds.
40+
|
3741
### Cancellation() {#Cancellation--}
3842
```
3943
public Cancellation()
4044
```
4145

4246

43-
Initializes a new instance of the Cancellation class.
47+
Initializes a new instance of the
48+
Cancellation
49+
class.
50+
4451

4552
### isCancelled() {#isCancelled--}
4653
```
@@ -50,8 +57,10 @@ public final boolean isCancelled()
5057

5158
Gets a value indicating that cancellation has been requested.
5259

60+
5361
**Returns:**
5462
boolean - A value indicating that cancellation has been requested.
63+
5564
### cancel() {#cancel--}
5665
```
5766
public final void cancel()
@@ -60,6 +69,7 @@ public final void cancel()
6069

6170
Makes a request for cancellation.
6271

72+
6373
### cancelAfter(int milliseconds) {#cancelAfter-int-}
6474
```
6575
public final void cancelAfter(int milliseconds)
@@ -68,8 +78,10 @@ public final void cancelAfter(int milliseconds)
6878

6979
Makes a request for cancellation after the expiration of specified number of milliseconds.
7080

81+
7182
**Parameters:**
7283
| Parameter | Type | Description |
7384
| --- | --- | --- |
74-
| milliseconds | int | The number of milliseconds after which an operation will be cancelled. |
85+
| milliseconds | int | The number of milliseconds after which an operation will be cancelled.
86+
|
7587

‎content/sites/groupdocs/search/english/java/com.groupdocs.search.common/chunksearchtoken/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ public abstract class ChunkSearchToken
1313
```
1414

1515
Represents a token for the continuation of the chunk search (search by pages).
16+
1617
## Constructors
1718

1819
| Constructor | Description |

0 commit comments

Comments
 (0)