com.asakusafw.testdriver.excel

Interface ExcelRuleExtractor

All Known Implementing Classes:

DefaultExcelRuleExtractor, LegacyExcelRuleExtractor

public interface ExcelRuleExtractor

Extracts rules from Excel sheet.

Since:

0.2.0

Version:

0.7.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExcelRuleExtractor.FormatException Invalid format of excel condition sheet.

Method Summary

Modifier and Type	Method and Description
String	extractComments(org.apache.poi.ss.usermodel.Row row) Extracts comments from the row.
Set<DataModelCondition>	extractDataModelCondition(org.apache.poi.ss.usermodel.Sheet sheet) Extract predicates about presence/absense of each data model objects.
String	extractName(org.apache.poi.ss.usermodel.Row row) Extract property name from the row.
NullityConditionKind	extractNullityCondition(org.apache.poi.ss.usermodel.Row row) Extract nullity predicate from the row.
String	extractOptions(org.apache.poi.ss.usermodel.Row row) Extracts extra options from the row.
int	extractPropertyRowStartIndex(org.apache.poi.ss.usermodel.Sheet sheet) Extract row index of describing conditions about each property.
ValueConditionKind	extractValueCondition(org.apache.poi.ss.usermodel.Row row) Extract value predicate from the row.
boolean	supports(org.apache.poi.ss.usermodel.Sheet sheet) Returns true iff this extractor supports the sheet.

Method Detail

supports

boolean supports(org.apache.poi.ss.usermodel.Sheet sheet)

Returns true iff this extractor supports the sheet.

Parameters:

sheet - target sheet

Returns:

true iff this extractor supports the sheet, or false otherwise

Throws:

IllegalArgumentException - if some parameters were null

extractDataModelCondition

Set<DataModelCondition> extractDataModelCondition(org.apache.poi.ss.usermodel.Sheet sheet)
                                           throws ExcelRuleExtractor.FormatException

Extract predicates about presence/absense of each data model objects.

Parameters:

sheet - target sheet

Returns:

the extracted value

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

IllegalArgumentException - if some parameters were null

extractPropertyRowStartIndex

int extractPropertyRowStartIndex(org.apache.poi.ss.usermodel.Sheet sheet)
                          throws ExcelRuleExtractor.FormatException

Extract row index of describing conditions about each property.

Parameters:

sheet - target sheet

Returns:

the start row index (0-origin)

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

IllegalArgumentException - if some parameters were null

extractName

String extractName(org.apache.poi.ss.usermodel.Row row)
            throws ExcelRuleExtractor.FormatException

Extract property name from the row.

Parameters:

row - source row

Returns:

the extracted value, or null if target cell is blank

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

IllegalArgumentException - if some parameters were null

extractValueCondition

ValueConditionKind extractValueCondition(org.apache.poi.ss.usermodel.Row row)
                                  throws ExcelRuleExtractor.FormatException

Extract value predicate from the row.

Parameters:

row - source row

Returns:

the extracted value

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

IllegalArgumentException - if some parameters were null

extractNullityCondition

NullityConditionKind extractNullityCondition(org.apache.poi.ss.usermodel.Row row)
                                      throws ExcelRuleExtractor.FormatException

Extract nullity predicate from the row.

Parameters:

row - source row

Returns:

the extracted value

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

IllegalArgumentException - if some parameters were null

extractComments

String extractComments(org.apache.poi.ss.usermodel.Row row)
                throws ExcelRuleExtractor.FormatException

Extracts comments from the row.

Parameters:

row - source row

Returns:

comment for the property, or an empty string if there are no comments

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

IllegalArgumentException - if some parameters were null

Since:

0.7.0

extractOptions

String extractOptions(org.apache.poi.ss.usermodel.Row row)
               throws ExcelRuleExtractor.FormatException

Extracts extra options from the row.

Parameters:

row - source row

Returns:

extra options for the property, or an empty string if there are no comments

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

IllegalArgumentException - if some parameters were null

Since:

0.7.0