Class UserDictionary
  
  Class for building a User Dictionary.
This class allows for custom segmentation of phrases.
 
  
  
    Inheritance
    System.Object
    UserDictionary
   
  
  
    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()
    
   
  
  Assembly: Lucene.Net.Analysis.Kuromoji.dll
  Syntax
  
    public sealed class UserDictionary : IDictionary
   
  Constructors
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  UserDictionary(TextReader)
  
  
  Declaration
  
    public UserDictionary(TextReader reader)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.IO.TextReader | 
        reader | 
         | 
      
    
  
  Fields
  
  
    |
    Improve this Doc
  
  
    View Source
  
  LEFT_ID
  
  
  Declaration
  
    public const int LEFT_ID = 5
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  RIGHT_ID
  
  
  Declaration
  
    public const int RIGHT_ID = 5
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  WORD_COST
  
  
  Declaration
  
    public const int WORD_COST = -100000
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  Properties
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  FST
  
  
  Declaration
  
    public TokenInfoFST FST { get; }
   
  Property Value
  
  Methods
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  
  
  Declaration
  
    public string GetBaseForm(int wordId, char[] surface, int off, int len)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
      
        | System.Char[] | 
        surface | 
         | 
      
      
        | System.Int32 | 
        off | 
         | 
      
      
        | System.Int32 | 
        len | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  
  
  Declaration
  
    public string GetInflectionForm(int wordId)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetInflectionType(Int32)
  
  
  Declaration
  
    public string GetInflectionType(int wordId)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetLeftId(Int32)
  
  
  Declaration
  
    public int GetLeftId(int wordId)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetPartOfSpeech(Int32)
  
  
  Declaration
  
    public string GetPartOfSpeech(int wordId)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetPronunciation(Int32, Char[], Int32, Int32)
  
  
  Declaration
  
    public string GetPronunciation(int wordId, char[] surface, int off, int len)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
      
        | System.Char[] | 
        surface | 
         | 
      
      
        | System.Int32 | 
        off | 
         | 
      
      
        | System.Int32 | 
        len | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetReading(Int32, Char[], Int32, Int32)
  
  
  Declaration
  
    public string GetReading(int wordId, char[] surface, int off, int len)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
      
        | System.Char[] | 
        surface | 
         | 
      
      
        | System.Int32 | 
        off | 
         | 
      
      
        | System.Int32 | 
        len | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetRightId(Int32)
  
  
  Declaration
  
    public int GetRightId(int wordId)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetWordCost(Int32)
  
  
  Declaration
  
    public int GetWordCost(int wordId)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Lookup(Char[], Int32, Int32)
  
  
  Declaration
  
    public int[][] Lookup(char[] chars, int off, int len)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Char[] | 
        chars | 
        Text. 
 | 
      
      
        | System.Int32 | 
        off | 
        Offset into text. 
 | 
      
      
        | System.Int32 | 
        len | 
        Length of text. 
 | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32[][] | 
        Array of {wordId, position, length}. 
 | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  LookupSegmentation(Int32)
  
  
  Declaration
  
    public int[] LookupSegmentation(int phraseID)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        phraseID | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32[] | 
         | 
      
    
  
  Implements