org.apache.maven.doxia.index
Class IndexingSink

java.lang.Object
  org.apache.maven.doxia.sink.SinkAdapter
      org.apache.maven.doxia.index.IndexingSink

All Implemented Interfaces:

Sink

public class IndexingSink
extends SinkAdapter

A sink implementation for index

Version:

$Id: IndexingSink.java 559578 2007-07-25 20:12:56Z ltheussl $

Author:

Trygve Laugstøl, Vincent Siveton

Field Summary

Fields inherited from interface org.apache.maven.doxia.sink.Sink

NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5

Constructor Summary

IndexingSink(IndexEntry sectionEntry)
Default constructor.

Method Summary

java.lang.String	getTitle()
IndexEntry	peek()
void	pop() Removes the IndexEntry at the top of this stack
void	push(IndexEntry entry) Pushes an IndexEntry onto the top of this stack
void	section1_() Ending a first heading element.
void	section2_() Ending a second heading element.
void	section3_() Ending a third heading element.
void	section4_() Ending a 4th heading element.
void	section5_() Ending a 5th heading element.
void	sectionTitle1() Starting a first title heading element.
void	sectionTitle2() Starting a second title heading element.
void	sectionTitle3() Starting a third title heading element.
void	sectionTitle4() Starting a 4th title heading element.
void	sectionTitle5() Starting a 5th title heading element.
void	text(java.lang.String text) Adding a text.
void	title() Starting the title element which is used to identify the document.

Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter

anchor_, anchor, author_, author, body_, body, bold_, bold, close, date_, date, definedTerm_, definedTerm, definition_, definition, definitionList_, definitionList, definitionListItem_, definitionListItem, figure_, figure, figureCaption_, figureCaption, figureGraphics, flush, head_, head, horizontalRule, italic_, italic, lineBreak, link_, link, list_, list, listItem_, listItem, monospaced_, monospaced, nonBreakingSpace, numberedList_, numberedList, numberedListItem_, numberedListItem, pageBreak, paragraph_, paragraph, rawText, section1, section2, section3, section4, section5, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle2_, sectionTitle3_, sectionTitle4_, sectionTitle5_, table_, table, tableCaption_, tableCaption, tableCell_, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell, tableRow_, tableRow, tableRows_, tableRows, title_, verbatim_, verbatim

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexingSink

public IndexingSink(IndexEntry sectionEntry)

Default constructor.

Parameters:

sectionEntry - The first index entry.

Method Detail

getTitle

public java.lang.String getTitle()

Returns:

the title

title

public void title()

Starting the title element which is used to identify the document.

Specified by:

title in interface Sink

Overrides:

title in class SinkAdapter

sectionTitle1

public void sectionTitle1()

Starting a first title heading element.

Specified by:

sectionTitle1 in interface Sink

Overrides:

sectionTitle1 in class SinkAdapter

section1_

public void section1_()

Ending a first heading element.

Specified by:

section1_ in interface Sink

Overrides:

section1_ in class SinkAdapter

sectionTitle2

public void sectionTitle2()

Starting a second title heading element.

Specified by:

sectionTitle2 in interface Sink

Overrides:

sectionTitle2 in class SinkAdapter

section2_

public void section2_()

Ending a second heading element.

Specified by:

section2_ in interface Sink

Overrides:

section2_ in class SinkAdapter

sectionTitle3

public void sectionTitle3()

Starting a third title heading element.

Specified by:

sectionTitle3 in interface Sink

Overrides:

sectionTitle3 in class SinkAdapter

section3_

public void section3_()

Ending a third heading element.

Specified by:

section3_ in interface Sink

Overrides:

section3_ in class SinkAdapter

sectionTitle4

public void sectionTitle4()

Starting a 4th title heading element.

Specified by:

sectionTitle4 in interface Sink

Overrides:

sectionTitle4 in class SinkAdapter

section4_

public void section4_()

Ending a 4th heading element.

Specified by:

section4_ in interface Sink

Overrides:

section4_ in class SinkAdapter

sectionTitle5

public void sectionTitle5()

Starting a 5th title heading element.

Specified by:

sectionTitle5 in interface Sink

Overrides:

sectionTitle5 in class SinkAdapter

section5_

public void section5_()

Ending a 5th heading element.

Specified by:

section5_ in interface Sink

Overrides:

section5_ in class SinkAdapter

text

public void text(java.lang.String text)

Adding a text.

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

Parameters:

text - The text to write.

push

public void push(IndexEntry entry)

Pushes an IndexEntry onto the top of this stack

Parameters:

entry - to put

pop

public void pop()

Removes the IndexEntry at the top of this stack

peek

public IndexEntry peek()

Returns:

Looks at the IndexEntry at the top of this stack