You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2021/03/25 10:36:52 UTC
[lucenenet] branch master updated (f76cbfe -> 85b9321)
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git.
from f76cbfe Lucene.Net.Tests.Analysis.Common/Analysis/Hunspell: Removed Foo.cs, as it wasn't intended to be added
new c5bb53b MIGRATE.md: Fixed slashes so the link works
new d534de0 docs: Lucene.Net/overview.md: updated code examples and fixed broken links (see #284, #300)
new 75a8b1f docs: Lucene.Net/Analysis/package.md: updated code examples and fixed broken links (see #284, #300)
new b704a84 docs: Lucene.Net.Analysis.Common/overview.md: temporarily switched from xref to relative links to fix broken links (see #300)
new 90671de docs: Lucene.Net.Analysis.Analyzer: added links to analysis package docs (see #284, #300)
new ea67745 docs.ps1: Update toc.yml to the latest documentation version to prevent issues with crosslinking to older documentation. (see #300)
new 835ef07 docs.ps1, docfx.json: Updated to use HTML copyright symbol to keep it from being "eaten" by DocFx
new 85b9321 docs: Lucene.Net/Document/package.md: fixed broken links (see #300)
The 8 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
MIGRATE.md | 2 +-
src/Lucene.Net.Analysis.Common/overview.md | 6 +-
src/Lucene.Net/Analysis/Analyzer.cs | 20 +-
src/Lucene.Net/Analysis/package.md | 884 +++++++++++++++++------------
src/Lucene.Net/Document/package.md | 10 +-
src/Lucene.Net/overview.md | 119 ++--
websites/apidocs/docfx.json | 2 +-
websites/apidocs/docs.ps1 | 6 +-
8 files changed, 612 insertions(+), 437 deletions(-)
[lucenenet] 04/08: docs: Lucene.Net.Analysis.Common/overview.md:
temporarily switched from xref to relative links to fix broken links (see
#300)
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit b704a8459c738227d44cee5e96781efdc21a2b78
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Thu Mar 25 03:31:34 2021 +0700
docs: Lucene.Net.Analysis.Common/overview.md: temporarily switched from xref to relative links to fix broken links (see #300)
---
src/Lucene.Net.Analysis.Common/overview.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/Lucene.Net.Analysis.Common/overview.md b/src/Lucene.Net.Analysis.Common/overview.md
index d6e2d34..1e8e81d 100644
--- a/src/Lucene.Net.Analysis.Common/overview.md
+++ b/src/Lucene.Net.Analysis.Common/overview.md
@@ -1,4 +1,4 @@
----
+---
uid: Lucene.Net.Analysis.Common
title: Lucene.Net.Analysis.Common
summary: *content
@@ -23,6 +23,6 @@ summary: *content
Analyzers for indexing content in different languages and domains.
- For an introduction to Lucene's analysis API, see the <xref:Lucene.Net.Analysis> package documentation.
+ For an introduction to Lucene's analysis API, see the [Lucene.Net.Analysis](../core/Lucene.Net.Analysis.html) namespace documentation.
- This module contains concrete components (<xref:Lucene.Net.Analysis.CharFilter>s, <xref:Lucene.Net.Analysis.Tokenizer>s, and (<xref:Lucene.Net.Analysis.TokenFilter>s) for analyzing different types of content. It also provides a number of <xref:Lucene.Net.Analysis.Analyzer>s for different languages that you can use to get started quickly.
\ No newline at end of file
+ This module contains concrete components ([Lucene.Net.Analysis.CharFilter](../core/Lucene.Net.Analysis.CharFilter.html)s, [Lucene.Net.Analysis.Tokenizer](../core/Lucene.Net.Analysis.Tokenizer.html)s, and [Lucene.Net.Analysis.TokenFilter](../core/Lucene.Net.Analysis.TokenFilter.html)s) for analyzing different types of content. It also provides a number of [Lucene.Net.Analysis.Analyzer](../core/Lucene.Net.Analysis.Analyzer.html)s for different languages that you can use to get started quickly.
\ No newline at end of file
[lucenenet] 02/08: docs: Lucene.Net/overview.md: updated code
examples and fixed broken links (see #284, #300)
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit d534de0fa88bbede61c9269c7e692ebbc43b5e06
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Thu Mar 25 03:25:34 2021 +0700
docs: Lucene.Net/overview.md: updated code examples and fixed broken links (see #284, #300)
---
src/Lucene.Net/overview.md | 119 ++++++++++++++++++++++++++++-----------------
1 file changed, 75 insertions(+), 44 deletions(-)
diff --git a/src/Lucene.Net/overview.md b/src/Lucene.Net/overview.md
index 169769f..45db0bd 100644
--- a/src/Lucene.Net/overview.md
+++ b/src/Lucene.Net/overview.md
@@ -1,4 +1,4 @@
----
+---
uid: Lucene.Net
title: Lucene.Net
summary: *content
@@ -21,48 +21,55 @@ summary: *content
limitations under the License.
-->
-Apache Lucene is a high-performance, full-featured text search engine library. Here's a simple example how to use Lucene for indexing and searching (using JUnit to check if the results are what we expect):
-
-<!-- = Java2Html Converter 5.0 [2006-03-04] by Markus Gebhard markus@jave.de = -->
-
- Analyzer analyzer = new StandardAnalyzer(Version.LUCENE_CURRENT);
-
- // Store the index in memory:
- Directory directory = new RAMDirectory();
- // To store an index on disk, use this instead:
- //Directory directory = FSDirectory.open("/tmp/testindex");
- IndexWriterConfig config = new IndexWriterConfig(Version.LUCENE_CURRENT, analyzer);
- IndexWriter iwriter = new IndexWriter(directory, config);
- Document doc = new Document();
- String text = "This is the text to be indexed.";
- doc.add(new Field("fieldname", text, TextField.TYPE_STORED));
- iwriter.addDocument(doc);
- iwriter.close();
-
- // Now search the index:
- DirectoryReader ireader = DirectoryReader.open(directory);
- IndexSearcher isearcher = new IndexSearcher(ireader);
- // Parse a simple query that searches for "text":
- QueryParser parser = new QueryParser(Version.LUCENE_CURRENT, "fieldname", analyzer);
- Query query = parser.parse("text");
- ScoreDoc[] hits = isearcher.search(query, null, 1000).scoreDocs;
- assertEquals(1, hits.length);
- // Iterate through the results:
- for (int i = 0; i < hits.length;="" i++)="" {="" document="" hitdoc="isearcher.doc(hits[i].doc);" assertequals("this="" is="" the="" text="" to="" be="" indexed.",="" hitdoc.get("fieldname"));="" }="" ireader.close();="">
+Apache Lucene.NET is a high-performance, full-featured text search engine library. Here's a simple example how to use Lucene.NET for indexing and searching (using NUnit to check if the results are what we expect):
+
+```cs
+Analyzer analyzer = new StandardAnalyzer(Version.LUCENE_CURRENT);
+
+// Store the index in memory:
+Directory directory = new RAMDirectory();
+// To store an index on disk, use this instead:
+// Construct a machine-independent path for the index
+//var basePath = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData);
+//var indexPath = Path.Combine(basePath, "index");
+//Directory directory = FSDirectory.Open(indexPath);
+IndexWriterConfig config = new IndexWriterConfig(LuceneVersion.LUCENE_CURRENT, analyzer);
+using IndexWriter iwriter = new IndexWriter(directory, config);
+Document doc = new Document();
+String text = "This is the text to be indexed.";
+doc.Add(new Field("fieldname", text, TextField.TYPE_STORED));
+iwriter.AddDocument(doc);
+iwriter.Dispose();
+
+// Now search the index:
+using DirectoryReader ireader = DirectoryReader.Open(directory);
+IndexSearcher isearcher = new IndexSearcher(ireader);
+// Parse a simple query that searches for "text":
+QueryParser parser = new QueryParser(LuceneVersion.LUCENE_CURRENT, "fieldname", analyzer);
+Query query = parser.Parse("text");
+ScoreDoc[] hits = isearcher.Search(query, null, 1000).ScoreDocs;
+Assert.AreEqual(1, hits.Length);
+// Iterate through the results:
+for (int i = 0; i < hits.Length; i++)
+{
+ Document hitDoc = isearcher.Doc(hits[i].Doc);
+ Assert.AreEqual("This is the text to be indexed.", hitDoc.Get("fieldname"));
+}
+```
The Lucene API is divided into several packages:
* __<xref:Lucene.Net.Analysis>__
defines an abstract [Analyzer](xref:Lucene.Net.Analysis.Analyzer)
-API for converting text from a {@link java.io.Reader}
+API for converting text from a [System.Text.TextReader](https://docs.microsoft.com/en-us/dotnet/api/system.io.textreader)
into a [TokenStream](xref:Lucene.Net.Analysis.TokenStream),
an enumeration of token [Attribute](xref:Lucene.Net.Util.Attribute)s.
A TokenStream can be composed by applying [TokenFilter](xref:Lucene.Net.Analysis.TokenFilter)s
to the output of a [Tokenizer](xref:Lucene.Net.Analysis.Tokenizer).
Tokenizers and TokenFilters are strung together and applied with an [Analyzer](xref:Lucene.Net.Analysis.Analyzer).
-[analyzers-common](../analyzers-common/overview-summary.html) provides a number of Analyzer implementations, including
-[StopAnalyzer](../analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html)
-and the grammar-based [StandardAnalyzer](../analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html).
+[Lucene.Net.Analysis.Common](../analysis-common/overview.html) provides a number of Analyzer implementations, including
+[StopAnalyzer](../analysis-common/Lucene.Net.Analysis.Core.StopAnalyzer.html)
+and the grammar-based [StandardAnalyzer](../analysis-common/Lucene.Net.Analysis.Standard.StandardAnalyzer.html).
* __<xref:Lucene.Net.Codecs>__
provides an abstraction over the encoding and decoding of the inverted index structure,
@@ -71,11 +78,11 @@ as well as different implementations that can be chosen depending upon applicati
* __<xref:Lucene.Net.Documents>__
provides a simple [Document](xref:Lucene.Net.Documents.Document)
class. A Document is simply a set of named [Field](xref:Lucene.Net.Documents.Field)s,
-whose values may be strings or instances of {@link java.io.Reader}.
+whose values may be strings or instances of [System.Text.TextReader](https://docs.microsoft.com/en-us/dotnet/api/system.io.textreader).
* __<xref:Lucene.Net.Index>__
provides two primary classes: [IndexWriter](xref:Lucene.Net.Index.IndexWriter),
-which creates and adds documents to indices; and <xref:Lucene.Net.Index.IndexReader>,
+which creates and adds documents to indices; and [IndexReader](xref:Lucene.Net.Index.IndexReader),
which accesses the data in the index.
* __<xref:Lucene.Net.Search>__
@@ -84,8 +91,8 @@ for individual words, [PhraseQuery](xref:Lucene.Net.Search.PhraseQuery)
for phrases, and [BooleanQuery](xref:Lucene.Net.Search.BooleanQuery)
for boolean combinations of queries) and the [IndexSearcher](xref:Lucene.Net.Search.IndexSearcher)
which turns queries into [TopDocs](xref:Lucene.Net.Search.TopDocs).
-A number of [QueryParser](../queryparser/overview-summary.html)s are provided for producing
-query structures from strings or xml.
+A number of [QueryParser](../queryparser/overview.html)s are provided for producing
+query structures from strings or XML.
* __<xref:Lucene.Net.Store>__
defines an abstract class for storing persistent data, the [Directory](xref:Lucene.Net.Store.Directory),
@@ -102,24 +109,48 @@ and [PriorityQueue](xref:Lucene.Net.Util.PriorityQueue).
To use Lucene, an application should:
1. Create [Document](xref:Lucene.Net.Documents.Document)s by
-adding
-[Field](xref:Lucene.Net.Documents.Field)s;
+adding [Field](xref:Lucene.Net.Documents.Field)s;
2. Create an [IndexWriter](xref:Lucene.Net.Index.IndexWriter)
-and add documents to it with [AddDocument](xref:Lucene.Net.Index.IndexWriter#methods);
+and add documents to it with [AddDocument()](xref:Lucene.Net.Index.IndexWriter#Lucene_Net_Index_IndexWriter_AddDocument_System_Collections_Generic_IEnumerable_Lucene_Net_Index_IIndexableField__Lucene_Net_Analysis_Analyzer_);
-3. Call [QueryParser.parse()](../queryparser/org/apache/lucene/queryparser/classic/QueryParserBase.html#parse(java.lang.String))
+3. Call [QueryParser.Parse()](../queryparser/Lucene.Net.QueryParsers.Classic.QueryParserBase.html#Lucene_Net_QueryParsers_Classic_QueryParserBase_Parse_System_String_)
to build a query from a string; and
4. Create an [IndexSearcher](xref:Lucene.Net.Search.IndexSearcher)
-and pass the query to its [Search](xref:Lucene.Net.Search.IndexSearcher#methods)
+and pass the query to its [Search()](xref:Lucene.Net.Search.IndexSearcher#Lucene_Net_Search_IndexSearcher_Search_Lucene_Net_Search_Query_System_Int32_)
method.
Some simple examples of code which does this are:
-* [IndexFiles.java](../demo/src-html/org/apache/lucene/demo/IndexFiles.html) creates an
+* [IndexFiles.cs](../demo/Lucene.Net.Demo.IndexFiles.html) creates an
index for all the files contained in a directory.
-* [SearchFiles.java](../demo/src-html/org/apache/lucene/demo/SearchFiles.html) prompts for
+* [SearchFiles.cs](../demo/Lucene.Net.Demo.SearchFiles.html) prompts for
queries and searches an index.
+> [!TIP]
+> These demos can be run and code viewed/exported using the [lucene-cli](../../cli/index.html) dotnet tool.
+
+To demonstrate this, try something like:
+
+```
+> dotnet demo index-files index rec.food.recipies/soups
+adding rec.food.recipes/soups/abalone-chowder
+[...]
+
+> dotnet demo search-files index
+Query: chowder
+Searching for: chowder
+34 total matching documents
+1. rec.food.recipes/soups/spam-chowder
+ [ ... thirty-four documents contain the word "chowder" ... ]
+
+Query: "clam chowder" AND Manhattan
+Searching for: +"clam chowder" +manhattan
+2 total matching documents
+1. rec.food.recipes/soups/clam-chowder
+ [ ... two documents contain the phrase "clam chowder" and the word "manhattan" ... ]
+ [ Note: "+" and "-" are canonical, but "AND", "OR" and "NOT" may be used. ]
+```
+
[lucenenet] 06/08: docs.ps1: Update toc.yml to the latest
documentation version to prevent issues with crosslinking to older
documentation. (see #300)
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit ea67745b1f853c0ab6c06498cd49bb22818ba889
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Thu Mar 25 07:54:06 2021 +0700
docs.ps1: Update toc.yml to the latest documentation version to prevent issues with crosslinking to older documentation. (see #300)
---
websites/apidocs/docs.ps1 | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1
index 2e22aab..8292adc 100644
--- a/websites/apidocs/docs.ps1
+++ b/websites/apidocs/docs.ps1
@@ -52,6 +52,7 @@ $RepoRoot = (get-item $PSScriptFilePath).Directory.Parent.Parent.FullName;
$ApiDocsFolder = Join-Path -Path $RepoRoot -ChildPath "websites\apidocs";
$ToolsFolder = Join-Path -Path $ApiDocsFolder -ChildPath "tools";
$CliIndexPath = Join-Path -Path $RepoRoot -ChildPath "src\dotnet\tools\lucene-cli\docs\index.md";
+$TocPath = Join-Path -Path $ApiDocsFolder -ChildPath "toc.yml"
#ensure the /build/tools folder
New-Item $ToolsFolder -type directory -force
@@ -185,6 +186,9 @@ if ($? -and $DisableBuild -eq $false) {
# Note it works better this way anyway because we can store a real version number in the file in the repo.
(Get-Content -Path $CliIndexPath -Raw) -Replace '(?<=--version\s)\d+?\.\d+?\.\d+?(?:\.\d+?)?(?:-\w+)?', $LuceneNetVersion | Set-Content -Path $CliIndexPath
+ # Update our TOC to the latest LuceneNetVersion
+ (Get-Content -Path $TocPath -Raw) -Replace '(?<=lucenenet\.apache\.org\/docs\/)\d+?\.\d+?\.\d+?(?:\.\d+?)?(?:-\w+)?', $LuceneNetVersion | Set-Content -Path $TocPath
+
foreach ($proj in $DocFxJsonMeta) {
$projFile = Join-Path -Path $ApiDocsFolder $proj
[lucenenet] 05/08: docs: Lucene.Net.Analysis.Analyzer: added links
to analysis package docs (see #284, #300)
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit 90671dece79c3b78f64fd838bb1bd04cd438a01d
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Thu Mar 25 03:48:59 2021 +0700
docs: Lucene.Net.Analysis.Analyzer: added links to analysis package docs (see #284, #300)
---
src/Lucene.Net/Analysis/Analyzer.cs | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/Lucene.Net/Analysis/Analyzer.cs b/src/Lucene.Net/Analysis/Analyzer.cs
index 077a3ec..5a1490b 100644
--- a/src/Lucene.Net/Analysis/Analyzer.cs
+++ b/src/Lucene.Net/Analysis/Analyzer.cs
@@ -1,4 +1,4 @@
-using Lucene.Net.Util;
+using Lucene.Net.Util;
using System;
using System.Collections.Generic;
using System.IO;
@@ -46,22 +46,22 @@ namespace Lucene.Net.Analysis
/// <para/>
/// For some concrete implementations bundled with Lucene, look in the analysis modules:
/// <list type="bullet">
- /// <item><description>Common:
+ /// <item><description>[Common](../analysis-common/overview.html):
/// Analyzers for indexing content in different languages and domains.</description></item>
- /// <item><description>ICU:
+ /// <item><description>[ICU](../icu/Lucene.Net.Analysis.Icu.html):
/// Exposes functionality from ICU to Apache Lucene.</description></item>
- /// <item><description>Kuromoji:
+ /// <item><description>[Kuromoji](../analysis-kuromoji/Lucene.Net.Analysis.Ja.html):
/// Morphological analyzer for Japanese text.</description></item>
- /// <item><description>Morfologik:
+ /// <item><description>[Morfologik](../analysis-morfologik/Lucene.Net.Analysis.Morfologik.html):
/// Dictionary-driven lemmatization for the Polish language.</description></item>
- /// <item><description>Phonetic:
+ /// <item><description>[OpenNLP](../analysis-opennlp/Lucene.Net.Analysis.OpenNlp.html):
+ /// Analysis integration with Apache OpenNLP.</description></item>
+ /// <item><description>[Phonetic](../analysis-phonetic/Lucene.Net.Analysis.Phonetic.html):
/// Analysis for indexing phonetic signatures (for sounds-alike search).</description></item>
- /// <item><description>Smart Chinese:
+ /// <item><description>[Smart Chinese](../analysis-smartcn/Lucene.Net.Analysis.Cn.Smart.html):
/// Analyzer for Simplified Chinese, which indexes words.</description></item>
- /// <item><description>Stempel:
+ /// <item><description>[Stempel](../analysis-stempel/Lucene.Net.Analysis.Stempel.html):
/// Algorithmic Stemmer for the Polish Language.</description></item>
- /// <item><description>UIMA:
- /// Analysis integration with Apache UIMA.</description></item>
/// </list>
/// </summary>
public abstract class Analyzer : IDisposable
[lucenenet] 01/08: MIGRATE.md: Fixed slashes so the link works
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit c5bb53bb21eb35ded6ab30863fdf146eaa112b99
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Wed Mar 24 10:45:39 2021 +0700
MIGRATE.md: Fixed slashes so the link works
---
MIGRATE.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/MIGRATE.md b/MIGRATE.md
index 79e71fb..221f688 100644
--- a/MIGRATE.md
+++ b/MIGRATE.md
@@ -1 +1 @@
-The migration guide has moved to: [src\Lucene.Net\migration-guide.md](src\Lucene.Net\migration-guide.md)
\ No newline at end of file
+The migration guide has moved to: [src/Lucene.Net/migration-guide.md](src/Lucene.Net/migration-guide.md)
\ No newline at end of file
[lucenenet] 07/08: docs.ps1,
docfx.json: Updated to use HTML copyright symbol to keep it from
being "eaten" by DocFx
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit 835ef0786ad2c52f11614071dbebf928c2e92c3a
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Thu Mar 25 08:26:07 2021 +0700
docs.ps1, docfx.json: Updated to use HTML copyright symbol to keep it from being "eaten" by DocFx
---
websites/apidocs/docfx.json | 2 +-
websites/apidocs/docs.ps1 | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/websites/apidocs/docfx.json b/websites/apidocs/docfx.json
index ffcfa7a..d6dca5c 100644
--- a/websites/apidocs/docfx.json
+++ b/websites/apidocs/docfx.json
@@ -581,7 +581,7 @@
"_appFaviconPath": "logo/favicon.ico",
"_enableSearch": true,
"_appLogoPath": "logo/lucene-net-color.png",
- "_appFooter": "Copyright © 2020 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br/> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br/>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>",
+ "_appFooter": "Copyright © 2020 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br/> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br/>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>",
"_gitContribute": {
"repo": "https://github.com/apache/lucenenet",
"branch": "docs/4.8.0-beta00008",
diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1
index 8292adc..3180087 100644
--- a/websites/apidocs/docs.ps1
+++ b/websites/apidocs/docs.ps1
@@ -126,7 +126,7 @@ if ($DisablePlugins -eq $false) {
# update the docjx.global.json file based
$DocFxGlobalJson = Join-Path -Path $ApiDocsFolder "docfx.global.json"
$DocFxJsonContent = Get-Content $DocFxGlobalJson | ConvertFrom-Json
-$DocFxJsonContent._appFooter = "Copyright © $((Get-Date).Year) The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br/> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br/>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>"
+$DocFxJsonContent._appFooter = "Copyright © $((Get-Date).Year) The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br/> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br/>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>"
$DocFxJsonContent._appTitle = "Apache Lucene.NET $LuceneNetVersion Documentation"
$DocFxJsonContent._gitContribute.branch = "docs/$LuceneNetVersion"
$DocFxJsonContent | ConvertTo-Json -depth 100 | Set-Content $DocFxGlobalJson
[lucenenet] 03/08: docs: Lucene.Net/Analysis/package.md: updated
code examples and fixed broken links (see #284, #300)
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit 75a8b1f5d3e0a1f54cd6a37f1d187f15fa0d8ed5
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Thu Mar 25 03:27:56 2021 +0700
docs: Lucene.Net/Analysis/package.md: updated code examples and fixed broken links (see #284, #300)
---
src/Lucene.Net/Analysis/package.md | 884 +++++++++++++++++++++----------------
1 file changed, 512 insertions(+), 372 deletions(-)
diff --git a/src/Lucene.Net/Analysis/package.md b/src/Lucene.Net/Analysis/package.md
index bccb293..1f0b677 100644
--- a/src/Lucene.Net/Analysis/package.md
+++ b/src/Lucene.Net/Analysis/package.md
@@ -1,4 +1,4 @@
----
+---
uid: Lucene.Net.Analysis
summary: *content
---
@@ -24,21 +24,21 @@ API and code to convert text into indexable/searchable tokens. Covers <xref:Luce
## Parsing? Tokenization? Analysis!
-Lucene, an indexing and search library, accepts only plain text input.
+Lucene.NET, an indexing and search library, accepts only plain text input.
## Parsing
-Applications that build their search capabilities upon Lucene may support documents in various formats – HTML, XML, PDF, Word – just to name a few.
-Lucene does not care about the _Parsing_ of these and other document formats, and it is the responsibility of the
-application using Lucene to use an appropriate _Parser_ to convert the original format into plain text before passing that plain text to Lucene.
+Applications that build their search capabilities upon Lucene.NET may support documents in various formats – HTML, XML, PDF, Word – just to name a few.
+Lucene.NET does not care about the _Parsing_ of these and other document formats, and it is the responsibility of the
+application using Lucene.NET to use an appropriate _Parser_ to convert the original format into plain text before passing that plain text to Lucene.NET.
## Tokenization
-Plain text passed to Lucene for indexing goes through a process generally called tokenization. Tokenization is the process
+Plain text passed to Lucene.NET for indexing goes through a process generally called tokenization. Tokenization is the process
of breaking input text into small indexing elements – tokens.
The way input text is broken into tokens heavily influences how people will then be able to search for that text.
For instance, sentences beginnings and endings can be identified to provide for more accurate phrase
-and proximity searches (though sentence identification is not provided by Lucene).
+and proximity searches (though sentence identification is not provided by Lucene.NET).
In some cases simply breaking the input text into tokens is not enough – a deeper _Analysis_ may be needed. Lucene includes both pre- and post-tokenization analysis facilities.
@@ -65,7 +65,7 @@ and proximity searches (though sentence identification is not provided by Lucene
## Core Analysis
- The analysis package provides the mechanism to convert Strings and Readers into tokens that can be indexed by Lucene. There are four main classes in the package from which all analysis processes are derived. These are:
+ The analysis package provides the mechanism to convert Strings and TextReaders into tokens that can be indexed by Lucene.NET. There are four main classes in the package from which all analysis processes are derived. These are:
* <xref:Lucene.Net.Analysis.Analyzer> – An Analyzer is
responsible for building a
@@ -73,14 +73,14 @@ and proximity searches (though sentence identification is not provided by Lucene
by the indexing and searching processes. See below for more information
on implementing your own Analyzer.
-* CharFilter – CharFilter extends
- {@link java.io.Reader} to perform pre-tokenization substitutions,
- deletions, and/or insertions on an input Reader's text, while providing
+* <xref:Lucene.Net.Analysis.CharFilter> – CharFilter extends
+ [System.Text.TextReader](https://docs.microsoft.com/en-us/dotnet/api/system.io.textreader) to perform pre-tokenization substitutions,
+ deletions, and/or insertions on an input TextReader's text, while providing
corrected character offsets to account for these modifications. This
capability allows highlighting to function over the original text when
indexed tokens are created from CharFilter-modified text with offsets
that are not the same as those in the original text. Tokenizers'
- constructors and reset() methods accept a CharFilter. CharFilters may
+ constructors and Reset() methods accept a CharFilter. CharFilters may
be chained to perform multiple pre-tokenization modifications.
* <xref:Lucene.Net.Analysis.Tokenizer> – A Tokenizer is a
@@ -113,7 +113,7 @@ and proximity searches (though sentence identification is not provided by Lucene
* <xref:Lucene.Net.Analysis.Analyzer> is "field aware", but
<xref:Lucene.Net.Analysis.Tokenizer> is not.
- Lucene Java provides a number of analysis capabilities, the most commonly used one being the StandardAnalyzer. Many applications will have a long and industrious life with nothing more than the StandardAnalyzer. However, there are a few other classes/packages that are worth mentioning:
+ Lucene.NET provides a number of analysis capabilities, the most commonly used one being the StandardAnalyzer. Many applications will have a long and industrious life with nothing more than the StandardAnalyzer. However, there are a few other classes/packages that are worth mentioning:
1. PerFieldAnalyzerWrapper – Most Analyzers perform the same operation on all
<xref:Lucene.Net.Documents.Field>s. The PerFieldAnalyzerWrapper can be used to associate a different Analyzer with different
@@ -128,99 +128,187 @@ and proximity searches (though sentence identification is not provided by Lucene
## Invoking the Analyzer
- Applications usually do not invoke analysis – Lucene does it for them:
+ Applications usually do not invoke analysis – Lucene.NET does it for them:
* At indexing, as a consequence of
- [AddDocument](xref:Lucene.Net.Index.IndexWriter#methods),
+ [AddDocument()](xref:Lucene.Net.Index.IndexWriter#Lucene_Net_Index_IndexWriter_AddDocument_System_Collections_Generic_IEnumerable_Lucene_Net_Index_IIndexableField__),
the Analyzer in effect for indexing is invoked for each indexed field of the added document.
* At search, a QueryParser may invoke the Analyzer during parsing. Note that for some queries, analysis does not
take place, e.g. wildcard queries.
- However an application might invoke Analysis of any text for testing or for any other purpose, something like:
+ However an application might invoke Analysis of any text for testing or for any other purpose, something like:
- Version matchVersion = Version.LUCENE_XY; // Substitute desired Lucene version for XY
- Analyzer analyzer = new StandardAnalyzer(matchVersion); // or any other analyzer
- TokenStream ts = analyzer.tokenStream("myfield", new StringReader("some text goes here"));
- OffsetAttribute offsetAtt = ts.addAttribute(OffsetAttribute.class);
+<a id="analysis-workflow"></a>
- try {
- ts.reset(); // Resets this stream to the beginning. (Required)
- while (ts.incrementToken()) {
- // Use [#reflectAsString(boolean)](xref:Lucene.Net.Util.AttributeSource)
- // for token stream debugging.
- System.out.println("token: " + ts.reflectAsString(true));
-
- System.out.println("token start offset: " + offsetAtt.startOffset());
- System.out.println(" token end offset: " + offsetAtt.endOffset());
- }
- ts.end(); // Perform end-of-stream operations, e.g. set the final offset.
- } finally {
- ts.close(); // Release resources associated with this stream.
- }
+```cs
+LuceneVersion matchVersion = LuceneVersion.LUCENE_XY; // Substitute desired Lucene version for XY
+Analyzer analyzer = new StandardAnalyzer(matchVersion); // or any other analyzer
+TokenStream ts = analyzer.GetTokenStream("myfield", new StringReader("some text goes here"));
+IOffsetAttribute offsetAtt = ts.AddAttribute<IOffsetAttribute>();
+
+try
+{
+ ts.Reset(); // Resets this stream to the beginning. (Required)
+ while (ts.IncrementToken())
+ {
+ // Use [ReflectAsString(bool)](xref:Lucene.Net.Util.AttributeSource#Lucene_Net_Util_AttributeSource_ReflectAsString_System_Boolean_)
+ // for token stream debugging.
+ Console.WriteLine("token: " + ts.ReflectAsString(true));
+
+ Console.WriteLine("token start offset: " + offsetAtt.StartOffset);
+ Console.WriteLine(" token end offset: " + offsetAtt.EndOffset);
+ }
+ ts.End(); // Perform end-of-stream operations, e.g. set the final offset.
+}
+finally
+{
+ ts.Dispose(); // Release resources associated with this stream.
+}
+```
## Indexing Analysis vs. Search Analysis
- Selecting the "correct" analyzer is crucial for search quality, and can also affect indexing and search performance. The "correct" analyzer differs between applications. Lucene java's wiki page [AnalysisParalysis](http://wiki.apache.org/lucene-java/AnalysisParalysis) provides some data on "analyzing your analyzer". Here are some rules of thumb: 1. Test test test... (did we say test?) 2. Beware of over analysis – might hurt indexing performance. 3. Start with same analyzer for indexing a [...]
+ Selecting the "correct" analyzer is crucial for search quality, and can also affect indexing and search performance. The "correct" analyzer differs between applications. Lucene java's wiki page [AnalysisParalysis](http://wiki.apache.org/lucene-java/AnalysisParalysis) provides some data on "analyzing your analyzer". Here are some rules of thumb:
+
+1. Test test test... (did we say test?)
+2. Beware of over analysis – might hurt indexing performance.
+3. Start with same analyzer for indexing and search, otherwise searches would not find what they are supposed to...
+4. In some cases a different analyzer is required for indexing and search, for instance:
+ * Certain searches require more stop words to be filtered. (I.e. more than those that were filtered at indexing.)
+ * Query expansion by synonyms, acronyms, auto spell correction, etc.
+ This might sometimes require a modified analyzer – see the next section on how to do that.
## Implementing your own Analyzer
- Creating your own Analyzer is straightforward. Your Analyzer can wrap existing analysis components — CharFilter(s) _(optional)_, a Tokenizer, and TokenFilter(s) _(optional)_ — or components you create, or a combination of existing and newly created components. Before pursuing this approach, you may find it worthwhile to explore the [analyzers-common]({@docRoot}/../analyzers-common/overview-summary.html) library and/or ask on the [java-user@lucene.apache.org mailing list](http://lucene.a [...]
+ Creating your own Analyzer is straightforward. Your Analyzer can wrap existing analysis components — CharFilter(s) _(optional)_, a Tokenizer, and TokenFilter(s) _(optional)_ — or components you create, or a combination of existing and newly created components. Before pursuing this approach, you may find it worthwhile to explore the [Lucene.Net.Analysis.Common](xref:Lucene.Net.Analysis.Common) library and/or ask on the [user@lucenenet.apache.org mailing list](https://lucenenet.apache.org [...]
The following sections discuss some aspects of implementing your own analyzer.
### Field Section Boundaries
- When [Document.add](xref:Lucene.Net.Documents.Document#methods) is called multiple times for the same field name, we could say that each such call creates a new section for that field in that document. In fact, a separate call to [TokenStream](xref:Lucene.Net.Analysis.Analyzer#methods) would take place for each of these so called "sections". However, the default Analyzer behavior is to treat all these sections as one large section. This allows phrase search and proximity search to seaml [...]
+ When [Document.Add()](xref:Lucene.Net.Documents.Document#Lucene_Net_Documents_Document_Add_Lucene_Net_Index_IIndexableField_) is called multiple times for the same field name, we could say that each such call creates a new section for that field in that document. In fact, a separate call to [GetTokenStream()](xref:Lucene.Net.Analysis.Analyzer#Lucene_Net_Analysis_Analyzer_GetTokenStream_System_String_System_IO_TextReader_) would take place for each of these so called "sections". However, [...]
+
+```cs
+document.Add(new Field("f","first ends",...);
+document.Add(new Field("f","starts two",...);
+indexWriter.AddDocument(document);
+```
+
+ Then, a phrase search for "ends starts" would find that document. Where desired, this behavior can be modified by introducing a "position gap" between consecutive field "sections", by overriding [Analyzer.GetPositionIncrementGap(string)](xref:Lucene.Net.Analysis.Analyzer#Lucene_Net_Analysis_Analyzer_GetPositionIncrementGap_System_String_):
+
+
+```cs
+/// <summary>
+/// Similar to <see cref="StandardAnalyzer"/>, but has a different position increment gap.
+/// </summary>
+public sealed class PositionIncrementGapAnalyzer : StopwordAnalyzerBase
+{
+ public PositionIncrementGapAnalyzer(LuceneVersion matchVersion)
+ : base(matchVersion, StopAnalyzer.ENGLISH_STOP_WORDS_SET)
+ {
+ }
+
+ public int MaxTokenLength { get; set; } = 255;
- document.add(new Field("f","first ends",...);
- document.add(new Field("f","starts two",...);
- indexWriter.addDocument(document);
+ /// <summary>
+ /// Returns a fixed position increment gap of 10.
+ /// </summary>
+ public override int GetPositionIncrementGap(string fieldName)
+ {
+ return 10;
+ }
- Then, a phrase search for "ends starts" would find that document. Where desired, this behavior can be modified by introducing a "position gap" between consecutive field "sections", simply by overriding [Analyzer.getPositionIncrementGap](xref:Lucene.Net.Analysis.Analyzer#methods):
+ protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
+ {
+ // Same components as StandardAnalyzer
+ var src = new StandardTokenizer(m_matchVersion, reader);
+ src.MaxTokenLength = MaxTokenLength;
+ TokenStream tok = new StandardFilter(m_matchVersion, src);
+ tok = new LowerCaseFilter(m_matchVersion, tok);
+ tok = new StopFilter(m_matchVersion, tok, m_stopwords);
+ return new PositionIncrementGapTokenStreamComponents(this, src, tok);
+ }
- Version matchVersion = Version.LUCENE_XY; // Substitute desired Lucene version for XY
- Analyzer myAnalyzer = new StandardAnalyzer(matchVersion) {
- public int getPositionIncrementGap(String fieldName) {
- return 10;
+ private class PositionIncrementGapTokenStreamComponents : TokenStreamComponents
+ {
+ private readonly PositionIncrementGapAnalyzer analyzer;
+ private readonly StandardTokenizer src;
+
+ public PositionIncrementGapTokenStreamComponents(PositionIncrementGapAnalyzer analyzer,
+ StandardTokenizer src, TokenStream tok)
+ : base(src, tok)
+ {
+ this.analyzer = analyzer;
+ this.src = src;
}
- };
+
+ protected override void SetReader(TextReader reader)
+ {
+ src.MaxTokenLength = analyzer.MaxTokenLength;
+ base.SetReader(reader);
+ }
+ }
+}
+
+LuceneVersion matchVersion = LuceneVersion.LUCENE_XY; // Substitute desired Lucene version for XY
+Analyzer myAnalyzer = new PositionIncrementGapAnalyzer(matchVersion);
+```
### Token Position Increments
- By default, all tokens created by Analyzers and Tokenizers have a [Increment](xref:Lucene.Net.Analysis.TokenAttributes.PositionIncrementAttribute#methods) of one. This means that the position stored for that token in the index would be one more than that of the previous token. Recall that phrase and proximity searches rely on position info.
+ By default, all tokens created by Analyzers and Tokenizers have a [PositionIncrement](xref:Lucene.Net.Analysis.TokenAttributes.IPositionIncrementAttribute#Lucene_Net_Analysis_TokenAttributes_IPositionIncrementAttribute_PositionIncrement) of one. This means that the position stored for that token in the index would be one more than that of the previous token. Recall that phrase and proximity searches rely on position info.
If the selected analyzer filters the stop words "is" and "the", then for a document containing the string "blue is the sky", only the tokens "blue", "sky" are indexed, with position("sky") = 3 + position("blue"). Now, a phrase query "blue is the sky" would find that document, because the same analyzer filters the same stop words from that query. But the phrase query "blue sky" would not find that document because the position increment between "blue" and "sky" is only 1.
If this behavior does not fit the application needs, the query parser needs to be configured to not take position increments into account when generating phrase queries.
- Note that a StopFilter MUST increment the position increment in order not to generate corrupt tokenstream graphs. Here is the logic used by StopFilter to increment positions when filtering out tokens:
+ Note that a StopFilter MUST increment the position increment in order not to generate corrupt TokenStream graphs. Here is the logic used by StopFilter to increment positions when filtering out tokens:
- public TokenStream tokenStream(final String fieldName, Reader reader) {
- final TokenStream ts = someAnalyzer.tokenStream(fieldName, reader);
- TokenStream res = new TokenStream() {
- CharTermAttribute termAtt = addAttribute(CharTermAttribute.class);
- PositionIncrementAttribute posIncrAtt = addAttribute(PositionIncrementAttribute.class);
+```cs
+public class MyTokenStream : TokenStream
+{
+ private readonly TokenStream ts;
+ private readonly CharArraySet stopWords;
+ private readonly ICharTermAttribute termAtt;
+ private readonly IPositionIncrementAttribute posIncrAtt;
+
+ public MyTokenStream(TokenStream ts, CharArraySet stopWords)
+ {
+ this.ts = ts;
+ termAtt = AddAttribute<ICharTermAttribute>();
+ posIncrAtt = AddAttribute<IPositionIncrementAttribute>();
+ }
- public boolean incrementToken() throws IOException {
- int extraIncrement = 0;
- while (true) {
- boolean hasNext = ts.incrementToken();
- if (hasNext) {
- if (stopWords.contains(termAtt.toString())) {
- extraIncrement += posIncrAtt.getPositionIncrement(); // filter this word
- continue;
- }
- if (extraIncrement>0) {
- posIncrAtt.setPositionIncrement(posIncrAtt.getPositionIncrement()+extraIncrement);
+ public override bool IncrementToken()
+ {
+ int extraIncrement = 0;
+ while (true)
+ {
+ bool hasNext = ts.IncrementToken();
+ if (hasNext)
+ {
+ if (stopWords.Contains(termAttr.ToString()))
+ {
+ extraIncrement += posIncrAtt.PositionIncrement; // filter this word
+ continue;
+ }
+ if (extraIncrement > 0)
+ {
+ posIncrAtt.PositionIncrement += extraIncrement;
}
- }
- return hasNext;
}
- }
- };
- return res;
- }
+ return hasNext;
+ }
+ }
+}
+
+public override TokenStream GetTokenStream(string fieldName, Reader reader)
+{
+ TokenStream ts = someAnalyzer.GetTokenStream(fieldName, reader);
+ return new MyTokenStream(ts, stopWords);
+}
+```
A few more use cases for modifying position increments are:
@@ -234,7 +322,7 @@ and proximity searches (though sentence identification is not provided by Lucene
### Token Position Length
- By default, all tokens created by Analyzers and Tokenizers have a [Length](xref:Lucene.Net.Analysis.TokenAttributes.PositionLengthAttribute#methods) of one. This means that the token occupies a single position. This attribute is not indexed and thus not taken into account for positional queries, but is used by eg. suggesters.
+ By default, all tokens created by Analyzers and Tokenizers have a [Length](xref:Lucene.Net.Analysis.TokenAttributes.IPositionLengthAttribute#Lucene_Net_Analysis_TokenAttributes_IPositionLengthAttribute_PositionLength) of one. This means that the token occupies a single position. This attribute is not indexed and thus not taken into account for positional queries, but is used by eg. suggesters.
The main use case for positions lengths is multi-word synonyms. With single-word synonyms, setting the position increment to 0 is enough to denote the fact that two words are synonyms, for example:
@@ -273,20 +361,20 @@ and proximity searches (though sentence identification is not provided by Lucene
* Tokens that have the same end position (taking into account the
position length) must have the same end offset.
-* Tokenizers must call [#clearAttributes()](xref:Lucene.Net.Util.AttributeSource) in
- incrementToken().
+* Tokenizers must call [ClearAttributes()](xref:Lucene.Net.Util.AttributeSource#Lucene_Net_Util_AttributeSource_ClearAttributes) in
+ IncrementToken().
-* Tokenizers must override [#end()](xref:Lucene.Net.Analysis.TokenStream), and pass the final
+* Tokenizers must override [End()](xref:Lucene.Net.Analysis.TokenStream#Lucene_Net_Analysis_TokenStream_End), and pass the final
offset (the total number of input characters processed) to both
- parameters of [Int)](xref:Lucene.Net.Analysis.TokenAttributes.OffsetAttribute#methods).
+ parameters of [OffsetAttribute.SetOffset(int, int)](xref:Lucene.Net.Analysis.TokenAttributes.IOffsetAttribute#Lucene_Net_Analysis_TokenAttributes_IOffsetAttribute_SetOffset_System_Int32_System_Int32_).
Although these rules might seem easy to follow, problems can quickly happen when chaining badly implemented filters that play with positions and offsets, such as synonym or n-grams filters. Here are good practices for writing correct filters:
-* Token filters should not modify offsets. If you feel that your filter would need to modify offsets, then it should probably be implemented as a tokenizer.
+* Token filters should not modify offsets. If you feel that your filter would need to modify offsets, then it should probably be implemented as a Tokenizer.
* Token filters should not insert positions. If a filter needs to add tokens, then they should all have a position increment of 0.
-* When they add tokens, token filters should call [#clearAttributes()](xref:Lucene.Net.Util.AttributeSource) first.
+* When they add tokens, token filters should call [ClearAttributes()](xref:Lucene.Net.Util.AttributeSource#Lucene_Net_Util_AttributeSource_ClearAttributes) first.
* When they remove tokens, token filters should increment the position increment of the following token.
@@ -294,53 +382,57 @@ and proximity searches (though sentence identification is not provided by Lucene
## TokenStream API
- "Flexible Indexing" summarizes the effort of making the Lucene indexer pluggable and extensible for custom index formats. A fully customizable indexer means that users will be able to store custom data structures on disk. Therefore an API is necessary that can transport custom types of data from the documents to the indexer.
+ "Flexible Indexing" summarizes the effort of making the Lucene.NET indexer pluggable and extensible for custom index formats. A fully customizable indexer means that users will be able to store custom data structures on disk. Therefore an API is necessary that can transport custom types of data from the documents to the indexer.
### Attribute and AttributeSource
- Classes <xref:Lucene.Net.Util.Attribute> and <xref:Lucene.Net.Util.AttributeSource> serve as the basis upon which the analysis elements of "Flexible Indexing" are implemented. An Attribute holds a particular piece of information about a text token. For example, <xref:Lucene.Net.Analysis.TokenAttributes.CharTermAttribute> contains the term text of a token, and <xref:Lucene.Net.Analysis.TokenAttributes.OffsetAttribute> contains the start and end character offsets of a token. An AttributeS [...]
+ Classes <xref:Lucene.Net.Util.Attribute> and <xref:Lucene.Net.Util.AttributeSource> serve as the basis upon which the analysis elements of "Flexible Indexing" are implemented. An Attribute holds a particular piece of information about a text token. For example, <xref:Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute> contains the term text of a token, and <xref:Lucene.Net.Analysis.TokenAttributes.IOffsetAttribute> contains the start and end character offsets of a token. An Attribut [...]
- Lucene provides seven Attributes out of the box:
+ Lucene.NET provides seven Attributes out of the box:
<table rules="all" frame="box" cellpadding="3">
+ <colgroup>
+ <col span="1" style="width:30%">
+ <col span="1" style="width:70%">
+ </colgroup>
<tr>
- <td><xref:Lucene.Net.Analysis.TokenAttributes.CharTermAttribute></td>
+ <td><xref:Lucene.Net.Analysis.TokenAttributes.ICharTermAttribute></td>
<td>
- The term text of a token. Implements {@link java.lang.CharSequence}
- (providing methods length() and charAt(), and allowing e.g. for direct
- use with regular expression {@link java.util.regex.Matcher}s) and
- {@link java.lang.Appendable} (allowing the term text to be appended to.)
+ The term text of a token. Implements J2N.Text.ICharSequence
+ (providing properties Length and this[int], and allowing e.g. for direct
+ use with J2N.Text.IAppendable (allowing the term text to be appended to.)
+ In .NET, we can only use this indirectly with the [Regex](https://docs.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex) class by first calling ToString() and then passing the string to the Regex.
</td>
</tr>
<tr>
- <td><xref:Lucene.Net.Analysis.TokenAttributes.OffsetAttribute></td>
+ <td><xref:Lucene.Net.Analysis.TokenAttributes.IOffsetAttribute></td>
<td>The start and end offset of a token in characters.</td>
</tr>
<tr>
- <td><xref:Lucene.Net.Analysis.TokenAttributes.PositionIncrementAttribute></td>
+ <td><xref:Lucene.Net.Analysis.TokenAttributes.IPositionIncrementAttribute></td>
<td>See above for detailed information about position increment.</td>
</tr>
<tr>
- <td><xref:Lucene.Net.Analysis.TokenAttributes.PositionLengthAttribute></td>
+ <td><xref:Lucene.Net.Analysis.TokenAttributes.IPositionLengthAttribute></td>
<td>The number of positions occupied by a token.</td>
</tr>
<tr>
- <td><xref:Lucene.Net.Analysis.TokenAttributes.PayloadAttribute></td>
+ <td><xref:Lucene.Net.Analysis.TokenAttributes.IPayloadAttribute></td>
<td>The payload that a Token can optionally have.</td>
</tr>
<tr>
- <td><xref:Lucene.Net.Analysis.TokenAttributes.TypeAttribute></td>
+ <td><xref:Lucene.Net.Analysis.TokenAttributes.ITypeAttribute></td>
<td>The type of the token. Default is 'word'.</td>
</tr>
<tr>
- <td><xref:Lucene.Net.Analysis.TokenAttributes.FlagsAttribute></td>
+ <td><xref:Lucene.Net.Analysis.TokenAttributes.IFlagsAttribute></td>
<td>Optional flags a token can have.</td>
</tr>
<tr>
- <td><xref:Lucene.Net.Analysis.TokenAttributes.KeywordAttribute></td>
+ <td><xref:Lucene.Net.Analysis.TokenAttributes.IKeywordAttribute></td>
<td>
Keyword-aware TokenStreams/-Filters skip modification of tokens that
- return true from this attribute's isKeyword() method.
+ return true from this attribute's [IsKeyword](xref:Lucene.Net.Analysis.TokenAttributes.IKeywordAttribute#Lucene_Net_Analysis_TokenAttributes_IKeywordAttribute_IsKeyword) property.
</td>
</tr>
</table>
@@ -359,7 +451,7 @@ left for garbage. However, that does not mean that the components of
that token stream will, in fact, be discarded. The default is just the
opposite. <xref:Lucene.Net.Analysis.Analyzer> applies a reuse
strategy to the tokenizer and the token filters. It will reuse
-them. For each new input, it calls [#setReader(java.io.Reader)](xref:Lucene.Net.Analysis.Tokenizer)
+them. For each new input, it calls [SetReader(System.IO.TextReader)](xref:Lucene.Net.Analysis.Tokenizer#Lucene_Net_Analysis_Tokenizer_SetReader_System_IO_TextReader_)
to set the input. Your components must be prepared for this scenario,
as described below.
@@ -368,52 +460,56 @@ as described below.
* You should create your tokenizer class by extending <xref:Lucene.Net.Analysis.Tokenizer>.
* Your tokenizer must __never__ make direct use of the
- {@link java.io.Reader} supplied to its constructor(s). (A future
- release of Apache Lucene may remove the reader parameters from the
+ [System.Text.TextReader](https://docs.microsoft.com/en-us/dotnet/api/system.io.textreader) supplied to its constructor(s). (A future
+ release of Apache Lucene.NET will remove the reader parameters from the
Tokenizer constructors.)
- <xref:Lucene.Net.Analysis.Tokenizer> wraps the reader in an
+ <xref:Lucene.Net.Analysis.Tokenizer> wraps the text reader in an
object that helps enforce that applications comply with the [analysis workflow](#analysis-workflow). Thus, your class
should only reference the input via the protected 'input' field
of Tokenizer.
-* Your tokenizer __must__ override [#end()](xref:Lucene.Net.Analysis.TokenStream).
+* Your tokenizer __must__ override [End()](xref:Lucene.Net.Analysis.TokenStream#Lucene_Net_Analysis_TokenStream_End).
Your implementation __must__ call
- `super.end()`. It must set a correct final offset into
+ `base.End()`. It must set a correct final offset into
the offset attribute, and finish up and other attributes to reflect
the end of the stream.
-* If your tokenizer overrides [#reset()](xref:Lucene.Net.Analysis.TokenStream)
- or [#close()](xref:Lucene.Net.Analysis.TokenStream), it
+* If your tokenizer overrides [Reset()](xref:Lucene.Net.Analysis.TokenStream#Lucene_Net_Analysis_TokenStream_Reset)
+ or [Dispose()](xref:Lucene.Net.Analysis.TokenStream#Lucene_Net_Analysis_TokenStream_Dispose_System_Boolean_), it
__must__ call the corresponding superclass method.
#### Token Filter
You should create your token filter class by extending <xref:Lucene.Net.Analysis.TokenFilter>.
- If your token filter overrides [#reset()](xref:Lucene.Net.Analysis.TokenStream),
- [#end()](xref:Lucene.Net.Analysis.TokenStream)
- or [#close()](xref:Lucene.Net.Analysis.TokenStream), it
+ If your token filter overrides [Reset()](xref:Lucene.Net.Analysis.TokenStream#Lucene_Net_Analysis_TokenStream_Reset),
+ [End()](xref:Lucene.Net.Analysis.TokenStream#Lucene_Net_Analysis_TokenStream_End)
+ or [Dispose()](xref:Lucene.Net.Analysis.TokenStream#Lucene_Net_Analysis_TokenStream_Dispose_System_Boolean_), it
__must__ call the corresponding superclass method.
#### Creating delegates
Forwarding classes (those which extend <xref:Lucene.Net.Analysis.Tokenizer> but delegate
selected logic to another tokenizer) must also set the reader to the delegate in the overridden
- [#reset()](xref:Lucene.Net.Analysis.Tokenizer) method, e.g.:
-
- public class ForwardingTokenizer extends Tokenizer {
- private Tokenizer delegate;
- ...
- {@literal @Override}
- public void reset() {
- super.reset();
- delegate.setReader(this.input);
- delegate.reset();
- }
- }
+ [Reset()](xref:Lucene.Net.Analysis.Tokenizer#Lucene_Net_Analysis_Tokenizer_Reset) method, e.g.:
+
+```cs
+public class ForwardingTokenizer : Tokenizer
+{
+ private Tokenizer @delegate;
+ ...
+
+ public override void Reset()
+ {
+ base.Reset();
+ @delegate.SetReader(this.m_input);
+ @delegate.Reset();
+ }
+}
+```
### Testing Your Analysis Component
- The lucene-test-framework component defines [BaseTokenStreamTestCase]({@docRoot}/../test-framework/org/apache/lucene/analysis/BaseTokenStreamTestCase.html). By extending this class, you can create JUnit tests that validate that your Analyzer and/or analysis components correctly implement the protocol. The checkRandomData methods of that class are particularly effective in flushing out errors.
+ The Lucene.Net.TestFramework component defines [BaseTokenStreamTestCase](../test-framework/Lucene.Net.Analysis.BaseTokenStreamTestCase.html). By extending this class, you can create NUnit tests that validate that your Analyzer and/or analysis components correctly implement the protocol. The CheckRandomData()methods of that class are particularly effective in flushing out errors.
### Using the TokenStream API
@@ -425,345 +521,387 @@ a chain of a TokenStream and multiple TokenFilters is used, then all TokenFilter
with the TokenStream.
2. Attribute instances are reused for all tokens of a document. Thus, a TokenStream/-Filter needs to update
-the appropriate Attribute(s) in incrementToken(). The consumer, commonly the Lucene indexer, consumes the data in the
-Attributes and then calls incrementToken() again until it returns false, which indicates that the end of the stream
-was reached. This means that in each call of incrementToken() a TokenStream/-Filter can safely overwrite the data in
+the appropriate Attribute(s) in IncrementToken(). The consumer, commonly the Lucene.NET indexer, consumes the data in the
+Attributes and then calls IncrementToken() again until it returns false, which indicates that the end of the stream
+was reached. This means that in each call of IncrementToken() a TokenStream/-Filter can safely overwrite the data in
the Attribute instances.
3. For performance reasons a TokenStream/-Filter should add/get Attributes during instantiation; i.e., create an attribute in the
-constructor and store references to it in an instance variable. Using an instance variable instead of calling addAttribute()/getAttribute()
-in incrementToken() will avoid attribute lookups for every token in the document.
+constructor and store references to it in an instance variable. Using an instance variable instead of calling `AddAttribute<T>()`/`GetAttribute<T>()`
+in IncrementToken() will avoid attribute lookups for every token in the document.
4. All methods in AttributeSource are idempotent, which means calling them multiple times always yields the same
-result. This is especially important to know for addAttribute(). The method takes the __type__ (`Class`)
-of an Attribute as an argument and returns an __instance__. If an Attribute of the same type was previously added, then
+result. This is especially important to know for `AddAttribute<T>()`. The method takes the __interface__
+of an Attribute as an generic closing type and returns an __instance__. If an Attribute of the same type was previously added, then
the already existing instance is returned, otherwise a new instance is created and returned. Therefore TokenStreams/-Filters
-can safely call addAttribute() with the same Attribute type multiple times. Even consumers of TokenStreams should
-normally call addAttribute() instead of getAttribute(), because it would not fail if the TokenStream does not have this
-Attribute (getAttribute() would throw an IllegalArgumentException, if the Attribute is missing). More advanced code
-could simply check with hasAttribute(), if a TokenStream has it, and may conditionally leave out processing for
+can safely call `AddAttribute<T>()` with the same Attribute type multiple times. Even consumers of TokenStreams should
+normally call `AddAttribute<T>()` instead of `GetAttribute<T>()`, because it would not fail if the TokenStream does not have this
+Attribute (`GetAttribute<T>()` would throw an ArgumentException, if the Attribute is missing). More advanced code
+could simply check with `HasAttribute<T>()`, if a TokenStream has it, and may conditionally leave out processing for
extra performance.
### Example
- In this example we will create a WhiteSpaceTokenizer and use a LengthFilter to suppress all words that have only two or fewer characters. The LengthFilter is part of the Lucene core and its implementation will be explained here to illustrate the usage of the TokenStream API.
+ In this example we will create a WhiteSpaceTokenizer and use a LengthFilter to suppress all words that have only two or fewer characters. The LengthFilter is part of the Lucene.Net assembly and its implementation will be explained here to illustrate the usage of the TokenStream API.
- Then we will develop a custom Attribute, a PartOfSpeechAttribute, and add another filter to the chain which utilizes the new custom attribute, and call it PartOfSpeechTaggingFilter.
+ Then we will develop a custom Attribute, a IPartOfSpeechAttribute, and add another filter to the chain which utilizes the new custom attribute, and call it PartOfSpeechTaggingFilter.
#### Whitespace tokenization
- public class MyAnalyzer extends Analyzer {
-
- private Version matchVersion;
+```cs
+public class MyAnalyzer : Analyzer
+{
+ private LuceneVersion matchVersion;
- public MyAnalyzer(Version matchVersion) {
+ public MyAnalyzer(LuceneVersion matchVersion)
+ {
this.matchVersion = matchVersion;
- }
-
- {@literal @Override}
- protected TokenStreamComponents createComponents(String fieldName, Reader reader) {
- return new TokenStreamComponents(new WhitespaceTokenizer(matchVersion, reader));
- }
+ }
- public static void main(String[] args) throws IOException {
+ protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
+ {
+ return new TokenStreamComponents(new WhitespaceTokenizer(matchVersion, reader));
+ }
+}
+
+public static class Program
+{
+ public static void Main(string[] args)
+ {
// text to tokenize
- final String text = "This is a demo of the TokenStream API";
+ string text = "This is a demo of the TokenStream API";
- Version matchVersion = Version.LUCENE_XY; // Substitute desired Lucene version for XY
+ LuceneVersion matchVersion = Version.LUCENE_XY; // Substitute desired Lucene version for XY
MyAnalyzer analyzer = new MyAnalyzer(matchVersion);
- TokenStream stream = analyzer.tokenStream("field", new StringReader(text));
+ TokenStream stream = analyzer.GetTokenStream("field", new StringReader(text));
// get the CharTermAttribute from the TokenStream
- CharTermAttribute termAtt = stream.addAttribute(CharTermAttribute.class);
-
- try {
- stream.reset();
+ ICharTermAttribute termAtt = stream.AddAttribute<ICharTermAttribute>();
- // print all tokens until stream is exhausted
- while (stream.incrementToken()) {
- System.out.println(termAtt.toString());
- }
+ try
+ {
+ stream.Reset();
- stream.end();
- } finally {
- stream.close();
- }
- }
+ // print all tokens until stream is exhausted
+ while (stream.IncrementToken())
+ {
+ Console.WriteLine(termAtt.ToString());
+ }
+
+ stream.End();
+ }
+ finally
+ {
+ stream.Dispose();
}
+}
+```
-In this easy example a simple white space tokenization is performed. In main() a loop consumes the stream and
-prints the term text of the tokens by accessing the CharTermAttribute that the WhitespaceTokenizer provides.
+In this easy example a simple white space tokenization is performed. In Main() a loop consumes the stream and
+prints the term text of the tokens by accessing the ICharTermAttribute that the WhitespaceTokenizer provides.
Here is the output:
- This
- is
- a
- demo
- of
- the
- new
- TokenStream
- API
+```
+This
+is
+a
+demo
+of
+the
+new
+TokenStream
+API
+```
#### Adding a LengthFilter
We want to suppress all tokens that have 2 or less characters. We can do that
easily by adding a LengthFilter to the chain. Only the
-`createComponents()` method in our analyzer needs to be changed:
-
- {@literal @Override}
- protected TokenStreamComponents createComponents(String fieldName, Reader reader) {
- final Tokenizer source = new WhitespaceTokenizer(matchVersion, reader);
- TokenStream result = new LengthFilter(true, source, 3, Integer.MAX_VALUE);
- return new TokenStreamComponents(source, result);
- }
+`CreateComponents()` method in our analyzer needs to be changed:
+
+```cs
+protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
+{
+ Tokenizer source = new WhitespaceTokenizer(matchVersion, reader);
+ TokenStream result = new LengthFilter(true, source, 3, int.MaxValue);
+ return new TokenStreamComponents(source, result);
+}
+```
Note how now only words with 3 or more characters are contained in the output:
- This
- demo
- the
- new
- TokenStream
- API
+```
+This
+demo
+the
+new
+TokenStream
+API
+```
Now let's take a look how the LengthFilter is implemented:
- public final class LengthFilter extends FilteringTokenFilter {
-
- private final int min;
- private final int max;
+```cs
+public sealed class LengthFilter : FilteringTokenFilter
+{
+ private readonly int min;
+ private readonly int max;
+
+ private readonly ICharTermAttribute termAtt = AddAttribute<ICharTermAttribute>();
+
+ /// <summary>
+ /// Create a new LengthFilter. This will filter out tokens whose
+ /// ICharTermAttribute is either too short
+ /// (< min) or too long (> max).
+ /// </summary>
+ /// <param name="version">the Lucene match version</param>
+ /// <param name="input">the TokenStream to consume</param>
+ /// <param name="min">the minimum length</param>
+ /// <param name="max">the maximum length</param>
+ public LengthFilter(LuceneVersion version, TokenStream input, int min, int max)
+ : base(version, input)
+ {
- private final CharTermAttribute termAtt = addAttribute(CharTermAttribute.class);
-
- /**
- * Create a new LengthFilter. This will filter out tokens whose
- * CharTermAttribute is either too short
- * (< min) or too long (> max).
- * @param version the Lucene match version
- * @param in the TokenStream to consume
- * @param min the minimum length
- * @param max the maximum length
- */
- public LengthFilter(Version version, TokenStream in, int min, int max) {
- super(version, in);
this.min = min;
this.max = max;
- }
-
- {@literal @Override}
- public boolean accept() {
- final int len = termAtt.length();
- return (len >= min && len <= max);="" }="" }=""></=>
+ }
- In LengthFilter, the CharTermAttribute is added and stored in the instance variable `termAtt`. Remember that there can only be a single instance of CharTermAttribute in the chain, so in our example the `addAttribute()` call in LengthFilter returns the CharTermAttribute that the WhitespaceTokenizer already added.
+ public override bool Accept()
+ {
+ int len = termAtt.Length;
+ return len >= min && len <= max;
+ }
+}
+```
- The tokens are retrieved from the input stream in FilteringTokenFilter's `incrementToken()` method (see below), which calls LengthFilter's `accept()` method. By looking at the term text in the CharTermAttribute, the length of the term can be determined and tokens that are either too short or too long are skipped. Note how `accept()` can efficiently access the instance variable; no attribute lookup is necessary. The same is true for the consumer, which can simply use local references to [...]
+ In LengthFilter, the ICharTermAttribute is added and stored in the instance variable `termAtt`. Remember that there can only be a single instance of ICharTermAttribute in the chain, so in our example the `AddAttribute<T>()` call in LengthFilter returns the ICharTermAttribute that the WhitespaceTokenizer already added.
- LengthFilter extends FilteringTokenFilter:
+ The tokens are retrieved from the input stream in FilteringTokenFilter's `IncrementToken()` method (see below), which calls LengthFilter's `Accept()` method. By looking at the term text in the ICharTermAttribute, the length of the term can be determined and tokens that are either too short or too long are skipped. Note how `Accept()` can efficiently access the instance variable; no attribute lookup is necessary. The same is true for the consumer, which can simply use local references to [...]
- public abstract class FilteringTokenFilter extends TokenFilter {
-
- private final PositionIncrementAttribute posIncrAtt = addAttribute(PositionIncrementAttribute.class);
-
- /**
- * Create a new FilteringTokenFilter.
- * @param in the TokenStream to consume
- */
- public FilteringTokenFilter(Version version, TokenStream in) {
- super(in);
- }
-
- /** Override this method and return if the current input token should be returned by incrementToken. */
- protected abstract boolean accept() throws IOException;
-
- {@literal @Override}
- public final boolean incrementToken() throws IOException {
+```cs
+public abstract class FilteringTokenFilter : TokenFilter
+{
+ private readonly IPositionIncrementAttribute posIncrAtt = AddAttribute<IPositionIncrementAttribute>();
+
+ /// <summary>
+ /// Create a new FilteringTokenFilter.
+ /// </summary>
+ /// <param name="version">the Lucene match version</param>
+ /// <param name="input">the TokenStream to consume</param>
+ public FilteringTokenFilter(LuceneVersion version, TokenStream input)
+ : base(input)
+ {
+ }
+
+ /// <summary>
+ /// Override this method and return if the current input token should be returned by IncrementToken.
+ /// </summary>
+ protected abstract bool Accept();
+
+ public sealed override bool IncrementToken()
+ {
int skippedPositions = 0;
- while (input.incrementToken()) {
- if (accept()) {
- if (skippedPositions != 0) {
- posIncrAtt.setPositionIncrement(posIncrAtt.getPositionIncrement() + skippedPositions);
+ while (m_input.IncrementToken())
+ {
+ if (Accept())
+ {
+ if (skippedPositions != 0)
+ {
+ posIncrAtt.PositionIncrement += skippedPositions;
+ }
+ return true;
}
- return true;
- }
- skippedPositions += posIncrAtt.getPositionIncrement();
+ skippedPositions += posIncrAtt.PositionIncrement;
}
- // reached EOS -- return false
+ // reached end of stream -- return false
return false;
- }
-
- {@literal @Override}
- public void reset() throws IOException {
- super.reset();
- }
-
-}
-
-#### Adding a custom Attribute
+ }
-Now we're going to implement our own custom Attribute for part-of-speech tagging and call it consequently
-`PartOfSpeechAttribute`. First we need to define the interface of the new Attribute:
+ public override void Reset()
+ {
+ base.Reset();
+ }
+}
+```
- public interface PartOfSpeechAttribute extends Attribute {
- public static enum PartOfSpeech {
- Noun, Verb, Adjective, Adverb, Pronoun, Preposition, Conjunction, Article, Unknown
- }
+#### Adding a custom IAttribute
- public void setPartOfSpeech(PartOfSpeech pos);
+Now we're going to implement our own custom IAttribute for part-of-speech tagging and call it consequently
+`IPartOfSpeechAttribute`. First we need to define the interface of the new IAttribute:
- public PartOfSpeech getPartOfSpeech();
- }
+```cs
+public enum PartOfSpeech
+{
+ Noun, Verb, Adjective, Adverb, Pronoun, Preposition, Conjunction, Article, Unknown
+}
- Now we also need to write the implementing class. The name of that class is important here: By default, Lucene checks if there is a class with the name of the Attribute with the suffix 'Impl'. In this example, we would consequently call the implementing class `PartOfSpeechAttributeImpl`.
+public interface IPartOfSpeechAttribute : IAttribute
+{
+ PartOfSpeech PartOfSpeech { get; set; }
+}
+```
- This should be the usual behavior. However, there is also an expert-API that allows changing these naming conventions: <xref:Lucene.Net.Util.AttributeSource.AttributeFactory>. The factory accepts an Attribute interface as argument and returns an actual instance. You can implement your own factory if you need to change the default behavior.
+ Now we also need to write the implementing class. The name of that class is important here: By default, Lucene checks if there is a class with the name of the IAttribute without the prefix 'I'. In this example, we would consequently call the implementing class `PartOfSpeechAttribute`.
- Now here is the actual class that implements our new Attribute. Notice that the class has to extend <xref:Lucene.Net.Util.AttributeImpl>:
+ This should be the usual behavior. However, there is also an expert-API that allows changing these naming conventions: <xref:Lucene.Net.Util.AttributeSource.AttributeFactory>. The factory accepts an IAttribute interface as argument and returns an actual instance. You can implement your own factory if you need to change the default behavior.
- public final class PartOfSpeechAttributeImpl extends AttributeImpl
- implements PartOfSpeechAttribute {
+ Now here is the actual class that implements our new Attribute. Notice that the class has to extend <xref:Lucene.Net.Util.Attribute>:
- private PartOfSpeech pos = PartOfSpeech.Unknown;
+```cs
+public sealed class PartOfSpeechAttribute : Lucene.Net.Util.Attribute, IPartOfSpeechAttribute
+{
+ public PartOfSpeech PartOfSpeech { get; set; } = PartOfSpeech.Unknown;
- public void setPartOfSpeech(PartOfSpeech pos) {
- this.pos = pos;
- }
+ public override void Clear()
+ {
+ PartOfSpeech = PartOfSpeech.Unknown;
+ }
- public PartOfSpeech getPartOfSpeech() {
- return pos;
- }
-
- {@literal @Override}
- public void clear() {
- pos = PartOfSpeech.Unknown;
- }
-
- {@literal @Override}
- public void copyTo(AttributeImpl target) {
- ((PartOfSpeechAttribute) target).setPartOfSpeech(pos);
- }
- }
+ public override void CopyTo(IAttribute target)
+ {
+ ((IPartOfSpeechAttribute)target).PartOfSpeech = PartOfSpeech;
+ }
+}
+```
- This is a simple Attribute implementation has only a single variable that stores the part-of-speech of a token. It extends the `AttributeImpl` class and therefore implements its abstract methods `clear()` and `copyTo()`. Now we need a TokenFilter that can set this new PartOfSpeechAttribute for each token. In this example we show a very naive filter that tags every word with a leading upper-case letter as a 'Noun' and all other words as 'Unknown'.
+ This is a simple Attribute implementation has only a single variable that stores the part-of-speech of a token. It extends the `Attribute` class and therefore implements its abstract methods `Clear()` and `CopyTo()`. Now we need a TokenFilter that can set this new PartOfSpeechAttribute for each token. In this example we show a very naive filter that tags every word with a leading upper-case letter as a 'Noun' and all other words as 'Unknown'.
- public static class PartOfSpeechTaggingFilter extends TokenFilter {
- PartOfSpeechAttribute posAtt = addAttribute(PartOfSpeechAttribute.class);
- CharTermAttribute termAtt = addAttribute(CharTermAttribute.class);
+```cs
+public class PartOfSpeechTaggingFilter : TokenFilter
+{
+ private readonly IPartOfSpeechAttribute posAtt;
+ private readonly ICharTermAttribute termAtt;
- protected PartOfSpeechTaggingFilter(TokenStream input) {
- super(input);
- }
+ protected PartOfSpeechTaggingFilter(TokenStream input)
+ : base(input)
+ {
+ posAtt = AddAttribute<IPartOfSpeechAttribute>();
+ termAtt = AddAttribute<ICharTermAttribute>();
+ }
- public boolean incrementToken() throws IOException {
- if (!input.incrementToken()) {return false;}
- posAtt.setPartOfSpeech(determinePOS(termAtt.buffer(), 0, termAtt.length()));
- return true;
- }
+ public bool IncrementToken()
+ {
+ if (!m_input.IncrementToken()) { return false; }
+ posAtt.PartOfSpeech = DeterminePartOfSpeech(termAtt.Buffer, 0, termAtt.Length);
+ return true;
+ }
- // determine the part of speech for the given term
- protected PartOfSpeech determinePOS(char[] term, int offset, int length) {
- // naive implementation that tags every uppercased word as noun
- if (length > 0 && Character.isUpperCase(term[0])) {
+ // determine the part of speech for the given term
+ protected PartOfSpeech DeterminePartOfSpeech(char[] term, int offset, int length)
+ {
+ // naive implementation that tags every uppercased word as noun
+ if (length > 0 && char.IsUpper(term[0]))
+ {
return PartOfSpeech.Noun;
- }
- return PartOfSpeech.Unknown;
}
- }
+ return PartOfSpeech.Unknown;
+ }
+}
+```
Just like the LengthFilter, this new filter stores references to the attributes it needs in instance variables. Notice how you only need to pass in the interface of the new Attribute and instantiating the correct class is automatically taken care of.
Now we need to add the filter to the chain in MyAnalyzer:
- {@literal @Override}
- protected TokenStreamComponents createComponents(String fieldName, Reader reader) {
- final Tokenizer source = new WhitespaceTokenizer(matchVersion, reader);
- TokenStream result = new LengthFilter(true, source, 3, Integer.MAX_VALUE);
- result = new PartOfSpeechTaggingFilter(result);
- return new TokenStreamComponents(source, result);
- }
+```cs
+protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
+{
+ Tokenizer source = new WhitespaceTokenizer(matchVersion, reader);
+ TokenStream result = new LengthFilter(matchVersion, source, 3, int.MaxValue);
+ result = new PartOfSpeechTaggingFilter(result);
+ return new TokenStreamComponents(source, result);
+}
+```
Now let's look at the output:
- This
- demo
- the
- new
- TokenStream
- API
+```
+This
+demo
+the
+new
+TokenStream
+API
+```
Apparently it hasn't changed, which shows that adding a custom attribute to a TokenStream/Filter chain does not
affect any existing consumers, simply because they don't know the new Attribute. Now let's change the consumer
to make use of the new PartOfSpeechAttribute and print it out:
- public static void main(String[] args) throws IOException {
- // text to tokenize
- final String text = "This is a demo of the TokenStream API";
-
- MyAnalyzer analyzer = new MyAnalyzer();
- TokenStream stream = analyzer.tokenStream("field", new StringReader(text));
-
- // get the CharTermAttribute from the TokenStream
- CharTermAttribute termAtt = stream.addAttribute(CharTermAttribute.class);
-
- // get the PartOfSpeechAttribute from the TokenStream
- PartOfSpeechAttribute posAtt = stream.addAttribute(PartOfSpeechAttribute.class);
-
- try {
- stream.reset();
-
- // print all tokens until stream is exhausted
- while (stream.incrementToken()) {
- System.out.println(termAtt.toString() + ": " + posAtt.getPartOfSpeech());
- }
-
- stream.end();
- } finally {
- stream.close();
- }
- }
+```cs
+public static class Program
+{
+ public static void Main(string[] args)
+ {
+ // text to tokenize
+ string text = "This is a demo of the TokenStream API";
+
+ MyAnalyzer analyzer = new MyAnalyzer();
+ TokenStream stream = analyzer.GetTokenStream("field", new StringReader(text));
+
+ // get the ICharTermAttribute from the TokenStream
+ ICharTermAttribute termAtt = stream.AddAttribute<ICharTermAttribute>();
+
+ // get the PartOfSpeechAttribute from the TokenStream
+ IPartOfSpeechAttribute posAtt = stream.AddAttribute<IPartOfSpeechAttribute>();
+
+ try
+ {
+ stream.Reset();
+
+ // print all tokens until stream is exhausted
+ while (stream.IncrementToken())
+ {
+ Console.WriteLine(termAtt.ToString() + ": " + posAtt.PartOfSpeech);
+ }
+
+ stream.End();
+ }
+ finally
+ {
+ stream.Dispose();
+ }
+ }
+}
+```
The change that was made is to get the PartOfSpeechAttribute from the TokenStream and print out its contents in
the while loop that consumes the stream. Here is the new output:
- This: Noun
- demo: Unknown
- the: Unknown
- new: Unknown
- TokenStream: Noun
- API: Noun
+```
+This: Noun
+demo: Unknown
+the: Unknown
+new: Unknown
+TokenStream: Noun
+API: Noun
+```
Each word is now followed by its assigned PartOfSpeech tag. Of course this is a naive
part-of-speech tagging. The word 'This' should not even be tagged as noun; it is only spelled capitalized because it
is the first word of a sentence. Actually this is a good opportunity for an exercise. To practice the usage of the new
-API the reader could now write an Attribute and TokenFilter that can specify for each word if it was the first token
+API the reader could now write an IAttribute and TokenFilter that can specify for each word if it was the first token
of a sentence or not. Then the PartOfSpeechTaggingFilter can make use of this knowledge and only tag capitalized words
as nouns if not the first word of a sentence (we know, this is still not a correct behavior, but hey, it's a good exercise).
-As a small hint, this is how the new Attribute class could begin:
+As a small hint, this is how the new IAttribute class could begin:
- public class FirstTokenOfSentenceAttributeImpl extends AttributeImpl
- implements FirstTokenOfSentenceAttribute {
+```cs
+public class FirstTokenOfSentenceAttribute : Lucene.Net.Util.Attribute, IFirstTokenOfSentenceAttribute
+{
+ public bool FirstToken { get; set; }
- private boolean firstToken;
+ public override void Clear()
+ {
+ FirstToken = false;
+ }
- public void setFirstToken(boolean firstToken) {
- this.firstToken = firstToken;
- }
-
- public boolean getFirstToken() {
- return firstToken;
- }
-
- {@literal @Override}
- public void clear() {
- firstToken = false;
- }
-
- ...
+ // ...
+}
+```
#### Adding a CharFilter chain
-Analyzers take Java {@link java.io.Reader}s as input. Of course you can wrap your Readers with {@link java.io.FilterReader}s
+Analyzers take .NET [System.Text.TextReader](https://docs.microsoft.com/en-us/dotnet/api/system.io.textreader)s as input. In Java you can wrap Readers with [java.io.FilterReader](https://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html)s
to manipulate content, but this would have the big disadvantage that character offsets might be inconsistent with your original
text.
@@ -773,16 +911,18 @@ CharFilters can be chained.
Example:
- public class MyAnalyzer extends Analyzer {
-
- {@literal @Override}
- protected TokenStreamComponents createComponents(String fieldName, Reader reader) {
- return new TokenStreamComponents(new MyTokenizer(reader));
- }
-
- {@literal @Override}
- protected Reader initReader(String fieldName, Reader reader) {
- // wrap the Reader in a CharFilter chain.
- return new SecondCharFilter(new FirstCharFilter(reader));
- }
- }
\ No newline at end of file
+```cs
+public class MyAnalyzer : Analyzer
+{
+ protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
+ {
+ return new TokenStreamComponents(new MyTokenizer(reader));
+ }
+
+ protected override TextReader InitReader(string fieldName, TextReader reader)
+ {
+ // wrap the Reader in a CharFilter chain.
+ return new SecondCharFilter(new FirstCharFilter(reader));
+ }
+}
+```
\ No newline at end of file
[lucenenet] 08/08: docs: Lucene.Net/Document/package.md: fixed
broken links (see #300)
Posted by ni...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit 85b9321587cc6d4599f508fc0e79baa22f567bb5
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Thu Mar 25 08:33:07 2021 +0700
docs: Lucene.Net/Document/package.md: fixed broken links (see #300)
---
src/Lucene.Net/Document/package.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/Lucene.Net/Document/package.md b/src/Lucene.Net/Document/package.md
index 3cc16d3..9a7d4c0 100644
--- a/src/Lucene.Net/Document/package.md
+++ b/src/Lucene.Net/Document/package.md
@@ -1,4 +1,4 @@
----
+---
uid: Lucene.Net.Documents
summary: *content
---
@@ -22,16 +22,16 @@ summary: *content
The logical representation of a <xref:Lucene.Net.Documents.Document> for indexing and searching.
-The document package provides the user level logical representation of content to be indexed and searched. The package also provides utilities for working with <xref:Lucene.Net.Documents.Document>s and <xref:Lucene.Net.Index.IndexableField>s.
+The document package provides the user level logical representation of content to be indexed and searched. The package also provides utilities for working with <xref:Lucene.Net.Documents.Document>s and <xref:Lucene.Net.Index.IIndexableField>s.
## Document and IndexableField
-A <xref:Lucene.Net.Documents.Document> is a collection of <xref:Lucene.Net.Index.IndexableField>s. A <xref:Lucene.Net.Index.IndexableField> is a logical representation of a user's content that needs to be indexed or stored. <xref:Lucene.Net.Index.IndexableField>s have a number of properties that tell Lucene how to treat the content (like indexed, tokenized, stored, etc.) See the <xref:Lucene.Net.Documents.Field> implementation of <xref:Lucene.Net.Index.IndexableField> for specifics on th [...]
+A <xref:Lucene.Net.Documents.Document> is a collection of <xref:Lucene.Net.Index.IIndexableField>s. A <xref:Lucene.Net.Index.IIndexableField> is a logical representation of a user's content that needs to be indexed or stored. <xref:Lucene.Net.Index.IIndexableField>s have a number of properties that tell Lucene.NET how to treat the content (like indexed, tokenized, stored, etc.) See the <xref:Lucene.Net.Documents.Field> implementation of <xref:Lucene.Net.Index.IIndexableField> for specifi [...]
-Note: it is common to refer to <xref:Lucene.Net.Documents.Document>s having <xref:Lucene.Net.Documents.Field>s, even though technically they have <xref:Lucene.Net.Index.IndexableField>s.
+Note: it is common to refer to <xref:Lucene.Net.Documents.Document>s having <xref:Lucene.Net.Documents.Field>s, even though technically they have <xref:Lucene.Net.Index.IIndexableField>s.
## Working with Documents
First and foremost, a <xref:Lucene.Net.Documents.Document> is something created by the user application. It is your job to create Documents based on the content of the files you are working with in your application (Word, txt, PDF, Excel or any other format.) How this is done is completely up to you. That being said, there are many tools available in other projects that can make the process of taking a file and converting it into a Lucene <xref:Lucene.Net.Documents.Document>.
-The <xref:Lucene.Net.Documents.DateTools> is a utility class to make dates and times searchable (remember, Lucene only searches text). <xref:Lucene.Net.Documents.IntField>, <xref:Lucene.Net.Documents.LongField>, <xref:Lucene.Net.Documents.FloatField> and <xref:Lucene.Net.Documents.DoubleField> are a special helper class to simplify indexing of numeric values (and also dates) for fast range range queries with <xref:Lucene.Net.Search.NumericRangeQuery> (using a special sortable string repr [...]
\ No newline at end of file
+The <xref:Lucene.Net.Documents.DateTools> is a utility class to make dates and times searchable (remember, Lucene only searches text). <xref:Lucene.Net.Documents.Int32Field>, <xref:Lucene.Net.Documents.Int64Field>, <xref:Lucene.Net.Documents.SingleField> and <xref:Lucene.Net.Documents.DoubleField> are a special helper class to simplify indexing of numeric values (and also dates) for fast range range queries with <xref:Lucene.Net.Search.NumericRangeQuery> (using a special sortable string [...]
\ No newline at end of file