Class StopwordAnalyzerBase

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    Direct Known Subclasses:
    StandardAnalyzer

    public abstract class StopwordAnalyzerBase
    extends Analyzer
    Base class for Analyzers that need to make use of stopword sets.
    Since:
    3.1
    • Field Detail

      • stopwords

        protected final CharArraySet stopwords
        An immutable stopword set
    • Constructor Detail

      • StopwordAnalyzerBase

        protected StopwordAnalyzerBase​(CharArraySet stopwords)
        Creates a new instance initialized with the given stopword set
        Parameters:
        stopwords - the analyzer's stopword set
      • StopwordAnalyzerBase

        protected StopwordAnalyzerBase()
        Creates a new Analyzer with an empty stopword set
    • Method Detail

      • getStopwordSet

        public CharArraySet getStopwordSet()
        Returns the analyzer's stopword set or an empty set if the analyzer has no stopwords
        Returns:
        the analyzer's stopword set or an empty set if the analyzer has no stopwords
      • loadStopwordSet

        protected static CharArraySet loadStopwordSet​(Path stopwords)
                                               throws IOException
        Creates a CharArraySet from a path.
        Parameters:
        stopwords - the stopwords file to load
        Returns:
        a CharArraySet containing the distinct stopwords from the given file
        Throws:
        IOException - if loading the stopwords throws an IOException
      • loadStopwordSet

        protected static CharArraySet loadStopwordSet​(Reader stopwords)
                                               throws IOException
        Creates a CharArraySet from a file.
        Parameters:
        stopwords - the stopwords reader to load
        Returns:
        a CharArraySet containing the distinct stopwords from the given reader
        Throws:
        IOException - if loading the stopwords throws an IOException