Package guideme.indices

Class MultiValuedIndex<K,V>

java.lang.Object

guideme.indices.MultiValuedIndex<K,V>

All Implemented Interfaces:

PageIndex

Direct Known Subclasses:

CategoryIndex

public class MultiValuedIndex<K,V>
extends Object
implements PageIndex

A convenient index base-class for indices that map keys to multiple pages.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MultiValuedIndex.EntryFunction<K,V>

Nested classes/interfaces inherited from interface guideme.indices.PageIndex

PageIndex.JsonSerializer<T>

Constructor Summary

Constructors

Constructor	Description
MultiValuedIndex(String name, MultiValuedIndex.EntryFunction<K,V> entryFunction, PageIndex.JsonSerializer<K> keySerializer, PageIndex.JsonSerializer<V> valueSerializer)

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.
List<V>	get(K key)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MultiValuedIndex

public MultiValuedIndex(String name,
 MultiValuedIndex.EntryFunction<K,V> entryFunction,
 PageIndex.JsonSerializer<K> keySerializer,
 PageIndex.JsonSerializer<V> valueSerializer)

Method Details

getName

public String getName()

Specified by:

getName in interface PageIndex

get

public List<V> get(K key)

supportsUpdate

public boolean supportsUpdate()

Specified by:

supportsUpdate in interface PageIndex

Returns:

True if this index supports incremental updates via the PageIndex.update(java.util.List<guideme.compiler.ParsedGuidePage>, java.util.List<guideme.GuidePageChange>) method.

rebuild

public void rebuild(List<ParsedGuidePage> pages)

Description copied from interface: PageIndex

Fully rebuilds this index.

Specified by:

rebuild in interface PageIndex

update

public void update(List<ParsedGuidePage> allPages,
 List<GuidePageChange> changes)

Description copied from interface: PageIndex

Applies an incremental update to this index.

Specified by:

update in interface PageIndex

export

public void export(com.google.gson.stream.JsonWriter writer)
            throws IOException

Description copied from interface: PageIndex

Serialize the index to JSON for export to the website.

Specified by:

export in interface PageIndex

Throws:

IOException