org.apache.maven.doxia.book.services.indexer
Interface BookIndexer

All Known Implementing Classes:

DefaultBookIndexer

public interface BookIndexer

Index a book.

Version:

$Id: BookIndexer.java 746976 2009-02-23 12:15:38Z vsiveton $

Author:

Trygve Laugstøl

Field Summary

static String

ROLE The plexus lookup role.

Method Summary

void	indexBook(BookModel book, BookContext bookContext) Index a book.

Field Detail

ROLE

static final String ROLE

The plexus lookup role.

Method Detail

indexBook

void indexBook(BookModel book,
               BookContext bookContext)
               throws BookDoxiaException

Index a book.

Parameters:

book - the book to index.

bookContext - the BookContext.

Throws:

BookDoxiaException - if the book cannot be indexed.