de.smartics.testdoc.report.index
Class ExportMultiIndex

java.lang.Object
  de.smartics.testdoc.report.index.ExportMultiIndex

All Implemented Interfaces:

ExportIndex, Serializable

@NotThreadSafe
public class ExportMultiIndex
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      ExportIndex
     
     

Provides means to handle multiple export indexes.

Author:

Robert Reiner

See Also:

Serialized Form

Field Summary

static String

SECTION_NAME The name of the section generated by this index.

Constructor Summary

ExportMultiIndex()
Default constructor.

Method Summary

void	addIndex(ExportIndex index) Adds the given index to the list of indexes.
void	addToIndex(UnitTestDoc testDoc) Adds the given test documentation instance to the index.
List<ExportIndex>	getIndexes() Returns a reference to an unmodifiable instance of the list of indexes.
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.

Methods inherited from class java.lang.Object

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

Field Detail

SECTION_NAME

public static final String SECTION_NAME

The name of the section generated by this index.

The value of this constant is "allSections".

Constant Field Value:

"allSections"

Constructor Detail

ExportMultiIndex

public ExportMultiIndex()

Default constructor.

Method Detail

getSectionName

public String getSectionName()

Returns the name of the section generated by this index.

Specified by:

getSectionName in interface ExportIndex

Returns:

the name of the generated section.

See Also:

ExportIndex.getSectionName()

addIndex

public void addIndex(ExportIndex index)

Adds the given index to the list of indexes.

Parameters:

index - the index to be added.

addToIndex

public void addToIndex(UnitTestDoc testDoc)

Adds the given test documentation instance to the index.

Specified by:

addToIndex in interface ExportIndex

Parameters:

testDoc - the instance to be added.

See Also:

ExportIndex.addToIndex(de.smartics.testdoc.core.doc.UnitTestDoc)

getIndexes

public List<ExportIndex> getIndexes()

Returns a reference to an unmodifiable instance of the list of indexes.

Returns:

the list of indexes.

getSection

public Section<UnitTestDoc> getSection()

Returns a reference to the root section of the index.

Returns the sections of all its indexes as subsections.

Specified by:

getSection in interface ExportIndex

Returns:

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

See Also:

ExportIndex.getSection()

isEmpty

public boolean isEmpty()

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

Specified by:

isEmpty in interface ExportIndex

Returns:

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

See Also:

ExportIndex.isEmpty()