Package com.teamten.typeset

Class IndexEntries

java.lang.Object

com.teamten.typeset.IndexEntries

public class IndexEntries
extends Object

Stores a set of index entries.

Constructor Summary

Constructors

Constructor	Description
IndexEntries(Collator collator)	Specify a collator for sorting the index entries.

Method Summary

Modifier and Type	Method	Description
void	add(IndexEntry indexEntry)	Adds an entry to the set.
void	add(List<Block> texts, int physicalPageNumber)	Add an entry by a list of text (entry, sub-entry, etc.) and page number.
List<IndexEntry>	getEntries()	Return a sorted list of index entries.
void	makeFakeIndex(Collator collator, int count)	Fill this object with count entries or sub-entries.
void	mergeWith(IndexEntries other)	Adds a set of entries to our own.
void	println(PrintStream stream, String indent)	Print the entries to the stream.

Methods inherited from class java.lang.Object

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

Constructor Details

IndexEntries

public IndexEntries(Collator collator)

Specify a collator for sorting the index entries.

Method Details

add

public void add(IndexEntry indexEntry)

Adds an entry to the set.

add

public void add(List<Block> texts,
 int physicalPageNumber)

Add an entry by a list of text (entry, sub-entry, etc.) and page number.

mergeWith

public void mergeWith(IndexEntries other)

Adds a set of entries to our own.

getEntries

public List<IndexEntry> getEntries()

Return a sorted list of index entries.

makeFakeIndex

public void makeFakeIndex(Collator collator,
 int count)
                   throws IOException

Fill this object with count entries or sub-entries.

Throws:

IOException

println

public void println(PrintStream stream,
 String indent)

Print the entries to the stream.