de.smartics.testdoc.report.index
Interface ExportIndex

All Superinterfaces:

Serializable

All Known Implementing Classes:

ExportMultiIndex, UutNameIndex, UutPackageIndex

public interface ExportIndex
     
     

      
      extends 
      
      Serializable
     
     

The export index creates the configured indexes.

Test documentation entries can be structured in more than one way.

Author:

Robert Reiner

Method Summary

void	addToIndex(UnitTestDoc testDoc) Adds the given test documentation instance to the index.
Section<UnitTestDoc>	getSection() Returns a reference to the root section of the index.
String	getSectionName() Returns the name of the section generated by this index.
boolean	isEmpty() Checks if this or any sub sections contains at least one item.

Method Detail

getSectionName

String getSectionName()

Returns the name of the section generated by this index.

Returns:

the name of the generated section.

addToIndex

void addToIndex(UnitTestDoc testDoc)

Adds the given test documentation instance to the index.

Parameters:

testDoc - the instance to be added.

getSection

Section<UnitTestDoc> getSection()

Returns a reference to the root section of the index.

Returns:

a reference to the root section of the index. Never returns null.

isEmpty

boolean isEmpty()

Checks if this or any sub sections contains at least one item.

Returns:

true if at least one item is in this index, false otherwise.