@PublicAPI public interface IWorkbookReader
Modifier and Type | Method and Description |
---|---|
boolean |
getDetectHeader()
Get if the the header row should be identified automatically.
|
int |
getDocumentType()
Returns the type of the currently read xls document.
|
java.lang.Integer |
getEndColumnIndex()
Get the index of the column where the data reading should finish.
|
java.lang.Integer |
getEndRowIndex()
Get the index of the row where the data reading should finish.
|
java.lang.Integer |
getHeaderRowIndex()
Gets the absolute index of the header row.
|
boolean |
getIsReadStructuresOnly()
Defines if only the structures should be read from the workbook or the properties as well.
|
java.util.ArrayList<java.lang.String> |
getSheetNames()
Returns the list of Worksheet names from the Xls Workbook
|
java.lang.Integer |
getStartColumnIndex()
Get the index of the column from where the data reading should start.
|
java.lang.Integer |
getStartRowIndex()
Get the index of the row from where the data reading should start.
|
java.lang.Object |
getWorkBook()
Get the XSSFWorkBook as object
|
boolean |
isDocumentJCXL()
Determines if the document has ever contained JCXL structures.
|
java.lang.Iterable<IMoleculeMap> |
read(java.lang.String sheetName)
Gets all the structures from the given sheet based on the range given in FirstRowIndex,
LastRowIndex, FirstColumnIndex, LastColumnIndex.
|
java.lang.Iterable<IMoleculeMap> |
readActiveSheet()
Gets all the structures from the active sheet based on the range given in FirstRowIndex,
LastRowIndex, FirstColumnIndex, LastColumnIndex.
|
java.lang.Iterable<IMoleculeMap> |
readAllSheets()
Gets all the structures from the workbook based on the range given in FirstRowIndex,
LastRowIndex, FirstColumnIndex, LastColumnIndex.
|
void |
setDetectHeader(boolean detectHeader)
Set if the the header row should be identified automatically.
|
void |
setEndColumnIndex(java.lang.Integer index)
Set the index of the column where the data reading should finish.
|
void |
setEndRowIndex(java.lang.Integer index)
Set the index of the row where the data reading should finish.
|
void |
setHeaderRowIndex(java.lang.Integer headerRowIndex)
Sets the absolute index of the header row.
|
void |
setIsReadStructuresOnly(boolean readStructuresOnly)
Defines if only the structures should be read from the workbook or the properties as well.
|
void |
setStartColumnIndex(java.lang.Integer index)
Set the index of the column from where the data reading should start.
|
void |
setStartRowIndex(java.lang.Integer index)
Set the index of the row from where the data reading should start.
|
java.lang.Object getWorkBook()
int getDocumentType()
java.util.ArrayList<java.lang.String> getSheetNames()
java.lang.Integer getStartRowIndex()
void setStartRowIndex(java.lang.Integer index)
index
- : the start row index (indexing start from 0). Default is null.java.lang.Integer getEndRowIndex()
void setEndRowIndex(java.lang.Integer index)
index
- : the end row index (indexing start from 0). Default is null.java.lang.Integer getStartColumnIndex()
void setStartColumnIndex(java.lang.Integer index)
index
- : the start column index (indexing start from 0). Default is null.java.lang.Integer getEndColumnIndex()
void setEndColumnIndex(java.lang.Integer index)
index
- : the end column index (indexing start from 0). Default is null.boolean getDetectHeader()
void setDetectHeader(boolean detectHeader)
detectHeader
- : true if the header should be identified automatically, false otherwise. Default
is false.java.lang.Integer getHeaderRowIndex()
void setHeaderRowIndex(java.lang.Integer headerRowIndex)
headerRowIndex
- : 0 based index of the header row. Default is null.boolean getIsReadStructuresOnly()
void setIsReadStructuresOnly(boolean readStructuresOnly)
readStructuresOnly
- : true if only the structures should be read from the workbook otherwise false.
Default false.java.lang.Iterable<IMoleculeMap> readActiveSheet() throws java.lang.Exception
java.lang.Exception
java.lang.Iterable<IMoleculeMap> read(java.lang.String sheetName) throws java.lang.Exception
java.lang.Exception
java.lang.Iterable<IMoleculeMap> readAllSheets() throws java.lang.Exception
java.lang.Exception
boolean isDocumentJCXL()