Class CharFilterFactory

Abstract parent class for analysis factories that create CharFilter instances.

Inheritance
System.Object
AbstractAnalysisFactory
CharFilterFactory
HTMLStripCharFilterFactory
MappingCharFilterFactory
PersianCharFilterFactory
JapaneseIterationMarkCharFilterFactory
PatternReplaceCharFilterFactory
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Analysis.Util
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public abstract class CharFilterFactory : AbstractAnalysisFactory

Constructors

| Improve this Doc View Source

CharFilterFactory(IDictionary<String, String>)

Initialize this factory via a set of key-value pairs.

Declaration
protected CharFilterFactory(IDictionary<string, string> args)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.String> args

Properties

| Improve this Doc View Source

AvailableCharFilters

returns a list of all available charfilter names

Declaration
public static ICollection<string> AvailableCharFilters { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<System.String>

Methods

| Improve this Doc View Source

Create(TextReader)

Wraps the given System.IO.TextReader with a CharFilter.

Declaration
public abstract TextReader Create(TextReader input)
Parameters
Type Name Description
System.IO.TextReader input
Returns
Type Description
System.IO.TextReader
| Improve this Doc View Source

ForName(String, IDictionary<String, String>)

looks up a charfilter by name from the host project's dependent assemblies

Declaration
public static CharFilterFactory ForName(string name, IDictionary<string, string> args)
Parameters
Type Name Description
System.String name
System.Collections.Generic.IDictionary<System.String, System.String> args
Returns
Type Description
CharFilterFactory
| Improve this Doc View Source

LookupClass(String)

looks up a charfilter class by name from the host project's dependent assemblies

Declaration
public static Type LookupClass(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Type
| Improve this Doc View Source

ReloadCharFilters()

Reloads the factory list. Changes to the factories are visible after the method ends, all iterators (AvailableCharFilters,...) stay consistent.

NOTE: Only new factories are added, existing ones are never removed or replaced.

This method is expensive and should only be called for discovery of new factories on the given classpath/classloader!

Declaration
public static void ReloadCharFilters()