Package es.uam.eps.ir.relison.content.index

Interface DocumentMap<C>

All Known Subinterfaces:
ForwardIndex<C>, Index<C>, IndividualContentIndex<C,​U>
All Known Implementing Classes:
AbstractIndex, AbstractIndividualContentIndex, LuceneForwardIndex, LuceneIndex, LucenePositionalIndex, WrapperIndividualContentIndex, WrapperIndividualForwardContentIndex
public interface DocumentMap<C>
Document map containing information about the documents in an index.

  • Method Summary

    Modifier and Type Method Description
    C getContent​(int contentId)
    Obtains the user corresponding to an identifier.
    int getContentId​(C content)
    Obtains the identifier of a content in the index.
    int numDocs()
    Obtains the number of contents.

  • Method Details

    • getContent

      C getContent​(int contentId) throws java.io.IOException
      Obtains the user corresponding to an identifier.
      Parameters:
      contentId - document identifier.
      Returns:
      the content corresponding to such identifier.
      Throws:
      java.io.IOException - if something fails while reading the value.

    • getContentId

      int getContentId​(C content)
      Obtains the identifier of a content in the index.
      Parameters:
      content - the content to look up.
      Returns:
      the identifier of the content.

    • numDocs

      int numDocs()
      Obtains the number of contents.
      Returns:
      the number of contents.