toxgene.interfaces.ToXgeneDocumentCollection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ToxGene Show documentation
Show all versions of ToxGene Show documentation
Modified ToXGene for the iBench project.
The newest version!
package toxgene.interfaces;
/**
* Interface to accessing document collections inside a template.
*
* @author Denilson Barbosa
*
* @version 0.1
*/
public interface ToXgeneDocumentCollection{
/**
* Returns the name of the tox-document element in the template
*/
public String getName();
/**
* Returns the number of documents in the collection.
*/
public int getSize();
/**
* This method is useful for dumping the tox-documents into files,
* and returns the starting number used to identify the different
* documents in the collection. This information is declared in th
* template.
*/
public int getStartingNumber();
/**
* This method is useful for dumping the tox-documents into files,
* and returns whether to pad the numbers identifying the documents
* with leading '0's.
*/
public boolean pad();
}