Package guideme.indices

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PageIndex.JsonSerializer<T>

Method Summary

Modifier and Type	Method	Description
void	export(com.google.gson.stream.JsonWriter writer)	Serialize the index to JSON for export to the website.
String	getName()
void	rebuild(List<ParsedGuidePage> pages)	Fully rebuilds this index.
boolean	supportsUpdate()
void	update(List<ParsedGuidePage> allPages, List<GuidePageChange> changes)	Applies an incremental update to this index.

Method Details

getName

String getName()

supportsUpdate

boolean supportsUpdate()

Returns:

True if this index supports incremental updates via the update(java.util.List<guideme.compiler.ParsedGuidePage>, java.util.List<guideme.GuidePageChange>) 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