Class BinaryDictionary
  
  Base class for a binary-encoded in-memory dictionary.
NOTE: To use an alternate dicationary than the built-in one, put the data files in a subdirectory of
your application named "kuromoji-data". This subdirectory
can be placed in any directory up to and including the root directory (if the OS permission allows).
To place the files in an alternate location, set an environment variable named "kuromoji.data.dir"
with the name of the directory the data files can be located within.
 
  
  
    Inheritance
    System.Object
    BinaryDictionary
      
      
   
  
  
    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 abstract class BinaryDictionary : IDictionary
   
  Constructors
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  BinaryDictionary()
  
  
  Declaration
  
    protected BinaryDictionary()
   
  Fields
  
  
    |
    Improve this Doc
  
  
    View Source
  
  DICT_FILENAME_SUFFIX
  
  
  Declaration
  
    public static readonly string DICT_FILENAME_SUFFIX
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  
  Declaration
  
    public static readonly string DICT_HEADER
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  flag that the entry has baseform data. otherwise its not inflected (same as surface form)
 
  
  Declaration
  
    public static readonly int HAS_BASEFORM
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  HAS_PRONUNCIATION
  flag that the entry has pronunciation data. otherwise pronunciation is the reading
 
  
  Declaration
  
    public static readonly int HAS_PRONUNCIATION
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  HAS_READING
  flag that the entry has reading data. otherwise reading is surface form converted to katakana
 
  
  Declaration
  
    public static readonly int HAS_READING
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  POSDICT_FILENAME_SUFFIX
  
  
  Declaration
  
    public static readonly string POSDICT_FILENAME_SUFFIX
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  
  Declaration
  
    public static readonly string POSDICT_HEADER
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  TARGETMAP_FILENAME_SUFFIX
  
  
  Declaration
  
    public static readonly string TARGETMAP_FILENAME_SUFFIX
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  
  Declaration
  
    public static readonly string TARGETMAP_HEADER
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  VERSION
  
  
  Declaration
  
    public static readonly int VERSION
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  Methods
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  
  
  Declaration
  
    public virtual string GetBaseForm(int wordId, char[] surfaceForm, int off, int len)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
      
        | System.Char[] | 
        surfaceForm | 
         | 
      
      
        | System.Int32 | 
        off | 
         | 
      
      
        | System.Int32 | 
        len | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  
  
  Declaration
  
    public virtual 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 virtual 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 virtual 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 virtual 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 virtual 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 virtual 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
  
  
  GetResource(String)
  
  
  Declaration
  
    protected Stream GetResource(string suffix)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.String | 
        suffix | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.IO.Stream | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetRightId(Int32)
  
  
  Declaration
  
    public virtual int GetRightId(int wordId)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetTypeResource(Type, String)
  
  
  Declaration
  
    public static Stream GetTypeResource(Type clazz, string suffix)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Type | 
        clazz | 
         | 
      
      
        | System.String | 
        suffix | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.IO.Stream | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetWordCost(Int32)
  
  
  Declaration
  
    public virtual int GetWordCost(int wordId)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        wordId | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Int32 | 
         | 
      
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  LookupWordIds(Int32, Int32sRef)
  
  
  Declaration
  
    public virtual void LookupWordIds(int sourceId, Int32sRef ref)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.Int32 | 
        sourceId | 
         | 
      
      
        | Lucene.Net.Util.Int32sRef | 
        ref | 
         | 
      
    
  
  Implements