toxgene.interfaces
Interface ToXgeneDocumentCollection


public interface ToXgeneDocumentCollection

Interface to accessing document collections inside a template.

Version:
0.1
Author:
Denilson Barbosa

Method Summary
 java.lang.String getName()
          Returns the name of the tox-document element in the template
 int getSize()
          Returns the number of documents in the collection.
 int getStartingNumber()
          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.
 boolean pad()
          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.
 

Method Detail

getName

public java.lang.String getName()
Returns the name of the tox-document element in the template


getSize

public int getSize()
Returns the number of documents in the collection.


getStartingNumber

public int getStartingNumber()
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.


pad

public boolean pad()
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.