Skip to content

Commit 131b1d4

Browse files
committed
documented PipelineAnalyzer limitations
1 parent 5ede88a commit 131b1d4

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

src/main/java/com/arangodb/entity/arangosearch/analyzer/PipelineAnalyzer.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@
2828
/**
2929
* An Analyzer capable of chaining effects of multiple Analyzers into one. The pipeline is a list of Analyzers, where
3030
* the output of an Analyzer is passed to the next for further processing.
31-
*
31+
* <p/>
32+
* <b>LIMITATIONS</b>: Analyzers of types {@link GeoPointAnalyzer} and {@link GeoJSONAnalyzer} cannot be used in pipelines and
33+
* will make the creation fail.
34+
* <p/>
3235
* @author Michele Rastelli
3336
* @see <a href= "https://www.arangodb.com/docs/stable/arangosearch-analyzers.html#pipeline">API Documentation</a>
3437
* @since ArangoDB 3.8

src/main/java/com/arangodb/entity/arangosearch/analyzer/PipelineAnalyzerProperties.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,12 @@ public class PipelineAnalyzerProperties {
3333

3434
/**
3535
* Appends the specified analyzer to the end of the pipeline.
36+
* <p/>
37+
* <b>LIMITATIONS</b>: Analyzers of types {@link GeoPointAnalyzer} and {@link GeoJSONAnalyzer} cannot be used in
38+
* pipelines and will make the creation fail.
39+
* <p/>
3640
*
37-
* @param analyzer
38-
* analyzer to be appended
41+
* @param analyzer analyzer to be appended
3942
* @return this
4043
*/
4144
public PipelineAnalyzerProperties addAnalyzer(final SearchAnalyzer analyzer) {

0 commit comments

Comments
 (0)