Interface PageIndex

All Known Implementing Classes:
CategoryIndex, ItemIndex, MultiValuedIndex, UniqueIndex
public interface PageIndex
A page index is an index over all guidebook pages that will be automatically built when the guidebook is reloaded, and when individual pages change.

  • Method Details

    • getName

      String getName()

    • supportsUpdate

      boolean supportsUpdate()
      Returns:
      True if this index supports incremental updates via the update(List, List) method.

    • rebuild

      void rebuild(List<ParsedGuidePage> pages)
      Fully rebuilds this index.

    • update

      void update(List<ParsedGuidePage> allPages, List<GuidePageChange> changes)
      Applies an incremental update to this index.

    • export

      void export(com.google.gson.stream.JsonWriter writer) throws IOException
      Serialize the index to JSON for export to the website.
      Throws:
      IOException