Interface MemoryIndex

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
AbstractMemoryIndex, CpeMemoryIndex, NpmCpeMemoryIndex
public interface MemoryIndex extends AutoCloseable
Author:
Jeremy Long

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closes the MemoryIndex.
    org.apache.lucene.document.Document
    getDocument(int documentId)
    Retrieves a document from the Index.
    void
    open(Set<Pair<String,String>> data, Settings settings)
    Creates and loads data into an in memory index.
    org.apache.lucene.search.Query
    parseQuery(String searchString)
    Parses the given string into a Lucene Query.
    org.apache.lucene.search.TopDocs
    search(String searchString, int maxQueryResults)
    Searches the index using the given search string.
    org.apache.lucene.search.TopDocs
    search(org.apache.lucene.search.Query query, int maxQueryResults)
    Searches the index using the given query.

  • Method Details

    • getDocument

      org.apache.lucene.document.Document getDocument(int documentId) throws IOException
      Retrieves a document from the Index.
      Parameters:
      documentId - the id of the document to retrieve
      Returns:
      the Document
      Throws:
      IOException - thrown if there is an IOException

    • open

      void open(Set<Pair<String,String>> data, Settings settings) throws IndexException
      Creates and loads data into an in memory index.
      Parameters:
      data - the CPE data
      settings - a reference to the dependency-check settings
      Throws:
      IndexException - thrown if there is an error creating the index

    • parseQuery

      org.apache.lucene.search.Query parseQuery(String searchString) throws org.apache.lucene.queryparser.classic.ParseException, IndexException
      Parses the given string into a Lucene Query.
      Parameters:
      searchString - the search text
      Returns:
      the Query object
      Throws:
      org.apache.lucene.queryparser.classic.ParseException - thrown if the search text cannot be parsed
      IndexException - thrown if there is an error resetting the analyzers

    • search

      org.apache.lucene.search.TopDocs search(String searchString, int maxQueryResults) throws org.apache.lucene.queryparser.classic.ParseException, IndexException, IOException
      Searches the index using the given search string.
      Parameters:
      searchString - the query text
      maxQueryResults - the maximum number of documents to return
      Returns:
      the TopDocs found by the search
      Throws:
      org.apache.lucene.queryparser.classic.ParseException - thrown when the searchString is invalid
      IndexException - thrown when there is an internal error resetting the search analyzer
      IOException - is thrown if there is an issue with the underlying Index

    • search

      org.apache.lucene.search.TopDocs search(org.apache.lucene.search.Query query, int maxQueryResults) throws org.apache.lucene.index.CorruptIndexException, IOException
      Searches the index using the given query.
      Parameters:
      query - the query used to search the index
      maxQueryResults - the max number of results to return
      Returns:
      the TopDocs found be the query
      Throws:
      org.apache.lucene.index.CorruptIndexException - thrown if the Index is corrupt
      IOException - thrown if there is an IOException

    • close

      void close()
      Closes the MemoryIndex.
      Specified by:
      close in interface AutoCloseable