com.asakusafw.testdriver.excel

Class DefaultExcelRuleExtractor

java.lang.Object

com.asakusafw.testdriver.excel.DefaultExcelRuleExtractor

All Implemented Interfaces:

ExcelRuleExtractor

public class DefaultExcelRuleExtractor
extends Object
implements ExcelRuleExtractor

Default implementation of ExcelRuleExtractor.

Since:

0.6.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.asakusafw.testdriver.excel.ExcelRuleExtractor

ExcelRuleExtractor.FormatException

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	SUPPORTED_FORMATS Format IDs which this extractor supports.

Constructor Summary

Constructors

Constructor and Description
DefaultExcelRuleExtractor()

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.

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_FORMATS

public static final Set<String> SUPPORTED_FORMATS

Format IDs which this extractor supports.

Since:

0.7.0

Constructor Detail

DefaultExcelRuleExtractor

public DefaultExcelRuleExtractor()

Method Detail

supports

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

Description copied from interface: ExcelRuleExtractor

Returns true iff this extractor supports the sheet.

Specified by:

supports in interface ExcelRuleExtractor

Parameters:

sheet - target sheet

Returns:

true iff this extractor supports the sheet, or false otherwise

extractDataModelCondition

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

Description copied from interface: ExcelRuleExtractor

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

Specified by:

extractDataModelCondition in interface ExcelRuleExtractor

Parameters:

sheet - target sheet

Returns:

the extracted value

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

extractPropertyRowStartIndex

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

Description copied from interface: ExcelRuleExtractor

Extract row index of describing conditions about each property.

Specified by:

extractPropertyRowStartIndex in interface ExcelRuleExtractor

Parameters:

sheet - target sheet

Returns:

the start row index (0-origin)

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

extractName

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

Description copied from interface: ExcelRuleExtractor

Extract property name from the row.

Specified by:

extractName in interface ExcelRuleExtractor

Parameters:

row - source row

Returns:

the extracted value, or null if target cell is blank

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

extractValueCondition

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

Description copied from interface: ExcelRuleExtractor

Extract value predicate from the row.

Specified by:

extractValueCondition in interface ExcelRuleExtractor

Parameters:

row - source row

Returns:

the extracted value

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

extractNullityCondition

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

Description copied from interface: ExcelRuleExtractor

Extract nullity predicate from the row.

Specified by:

extractNullityCondition in interface ExcelRuleExtractor

Parameters:

row - source row

Returns:

the extracted value

Throws:

ExcelRuleExtractor.FormatException - if the sheet format is invalid

extractComments

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

Description copied from interface: ExcelRuleExtractor

Extracts comments from the row.

Specified by:

extractComments in interface ExcelRuleExtractor

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

extractOptions

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

Description copied from interface: ExcelRuleExtractor

Extracts extra options from the row.

Specified by:

extractOptions in interface ExcelRuleExtractor

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