/**
* Copyright 2011-2017 Asakusa Framework Team.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.asakusafw.testdriver.excel;
import java.io.IOException;
import java.math.BigDecimal;
import java.net.URI;
import java.text.MessageFormat;
import java.util.Calendar;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.asakusafw.testdriver.core.DataModelDefinition;
import com.asakusafw.testdriver.core.DataModelDefinition.Builder;
import com.asakusafw.testdriver.core.DataModelReflection;
import com.asakusafw.testdriver.core.DataModelScanner;
import com.asakusafw.testdriver.core.PropertyName;
/**
* Extracts a model object from a row on Excel sheet.
* @since 0.2.0
*/
@SuppressWarnings("deprecation") // FIXME POI API is currently transitive
class ExcelDataDriver {
static final Logger LOG = LoggerFactory.getLogger(ExcelDataDriver.class);
private final Engine engine;
/**
* Creates a new instance.
* @param definition model definition
* @param id source ID (nullable)
* @throws IllegalArgumentException if some parameters were {@code null}
*/
ExcelDataDriver(DataModelDefinition<?> definition, URI id) {
if (definition == null) {
throw new IllegalArgumentException("definition must not be null"); //$NON-NLS-1$
}
this.engine = new Engine(definition, id);
}
/**
* Processes the target property and the corresponded cell.
* @param propertyName target property name
* @param cell target cell
* @throws IOException if failed to process the target cell
* @throws IllegalArgumentException if some parameters were {@code null}
*/
public void process(PropertyName propertyName, Cell cell) throws IOException {
if (propertyName == null) {
throw new IllegalArgumentException("propertyName must not be null"); //$NON-NLS-1$
}
if (cell == null) {
throw new IllegalArgumentException("cell must not be null"); //$NON-NLS-1$
}
if (cell.getCellTypeEnum() == CellType.BLANK) {
return;
}
engine.scan(engine.definition, propertyName, cell);
}
/**
* Returns the created model.
* @return the created model object
*/
public DataModelReflection getReflection() {
return engine.builder.build();
}
private static class Engine extends DataModelScanner<Cell, IOException> {
final DataModelDefinition<?> definition;
final URI id;
final Builder<?> builder;
Engine(DataModelDefinition<?> definition, URI id) {
assert definition != null;
this.definition = definition;
this.id = id;
this.builder = definition.newReflection();
}
@Override
public void booleanProperty(PropertyName name, Cell context) throws IOException {
if (context.getCellTypeEnum() == CellType.BOOLEAN) {
builder.add(name, context.getBooleanCellValue());
} else {
String string = context.getStringCellValue();
if (string.equalsIgnoreCase("true")) { //$NON-NLS-1$
builder.add(name, true);
} else if (string.equalsIgnoreCase("false")) { //$NON-NLS-1$
builder.add(name, false);
} else {
throw exception(name, context, "boolean"); //$NON-NLS-1$
}
}
}
@Override
public void byteProperty(PropertyName name, Cell context) throws IOException {
long value = toLong(name, context, "byte"); //$NON-NLS-1$
checkRange(name, context, value, Byte.MIN_VALUE, Byte.MAX_VALUE);
builder.add(name, (byte) value);
}
@Override
public void shortProperty(PropertyName name, Cell context) throws IOException {
long value = toLong(name, context, "short"); //$NON-NLS-1$
checkRange(name, context, value, Short.MIN_VALUE, Short.MAX_VALUE);
builder.add(name, (short) value);
}
@Override
public void intProperty(PropertyName name, Cell context) throws IOException {
long value = toLong(name, context, "int"); //$NON-NLS-1$
checkRange(name, context, value, Integer.MIN_VALUE, Integer.MAX_VALUE);
builder.add(name, (int) value);
}
@Override
public void longProperty(PropertyName name, Cell context) throws IOException {
long value = toLong(name, context, "long"); //$NON-NLS-1$
builder.add(name, value);
}
private long toLong(PropertyName name, Cell cell, String expected) throws IOException {
assert name != null;
assert cell != null;
assert expected != null;
if (cell.getCellTypeEnum() == CellType.NUMERIC) {
return (long) cell.getNumericCellValue();
} else if (cell.getCellTypeEnum() == CellType.STRING) {
String stringValue = cell.getStringCellValue();
try {
return Long.parseLong(stripNumber(stringValue));
} catch (NumberFormatException e) {
if (LOG.isDebugEnabled()) {
LOG.debug(MessageFormat.format(
"invalid long number: {0} (cell=({1}, {2}))", //$NON-NLS-1$
stringValue,
cell.getRowIndex() + 1,
cell.getColumnIndex() + 1), e);
}
// fall through
}
}
throw exception(name, cell, expected);
}
private String stripNumber(String string) {
if (string == null) {
return null;
}
String trimmed = string.trim().replaceAll("[_,]", ""); //$NON-NLS-1$ //$NON-NLS-2$
if (trimmed.startsWith("+")) { //$NON-NLS-1$
return trimmed.substring(1).trim();
}
return trimmed;
}
private void checkRange(PropertyName name, Cell cell, long value, int min, int max) throws IOException {
assert name != null;
assert cell != null;
if (value < min || max < value) {
throw new IOException(MessageFormat.format(
Messages.getString("ExcelDataDriver.errorInvalidNumberRange"), //$NON-NLS-1$
name,
value,
min,
max,
id,
cell.getRowIndex() + 1,
cell.getColumnIndex() + 1));
}
}
@Override
public void floatProperty(PropertyName name, Cell context) throws IOException {
double value = toDouble(name, context, "float"); //$NON-NLS-1$
builder.add(name, (float) value);
}
@Override
public void doubleProperty(PropertyName name, Cell context) throws IOException {
double value = toDouble(name, context, "double"); //$NON-NLS-1$
builder.add(name, value);
}
private double toDouble(PropertyName name, Cell cell, String expected) throws IOException {
assert name != null;
assert cell != null;
assert expected != null;
if (cell.getCellTypeEnum() == CellType.NUMERIC) {
return cell.getNumericCellValue();
} else if (cell.getCellTypeEnum() == CellType.STRING) {
String stringValue = cell.getStringCellValue();
try {
return Double.parseDouble(stripNumber(stringValue));
} catch (NumberFormatException e) {
if (LOG.isDebugEnabled()) {
LOG.debug(MessageFormat.format(
"invalid double number: {0} (cell=({1}, {2}))", //$NON-NLS-1$
stringValue,
cell.getRowIndex() + 1,
cell.getColumnIndex() + 1), e);
}
// fall through
}
}
throw exception(name, cell, expected);
}
@Override
public void integerProperty(PropertyName name, Cell context) throws IOException {
BigDecimal decimal = toDecimal(name, context, "integer"); //$NON-NLS-1$
builder.add(name, decimal.toBigInteger());
}
@Override
public void decimalProperty(PropertyName name, Cell context) throws IOException {
BigDecimal decimal = toDecimal(name, context, "decimal"); //$NON-NLS-1$
builder.add(name, decimal);
}
private BigDecimal toDecimal(PropertyName name, Cell cell, String expected) throws IOException {
assert name != null;
assert cell != null;
assert expected != null;
if (cell.getCellTypeEnum() == CellType.NUMERIC) {
return new BigDecimal(cell.getNumericCellValue());
} else if (cell.getCellTypeEnum() == CellType.STRING) {
String stringValue = cell.getStringCellValue();
try {
return new BigDecimal(stripNumber(stringValue));
} catch (NumberFormatException e) {
if (LOG.isDebugEnabled()) {
LOG.debug(MessageFormat.format(
"invalid decimal number: {0} (cell=({1}, {2}))", //$NON-NLS-1$
stringValue,
cell.getRowIndex() + 1,
cell.getColumnIndex() + 1), e);
}
// fall through
}
}
throw exception(name, cell, expected);
}
@Override
public void stringProperty(PropertyName name, Cell context) throws IOException {
if (context.getCellTypeEnum() != CellType.STRING) {
throw new IOException(MessageFormat.format(
Messages.getString("ExcelDataDriver.errorNotExplicitString"), //$NON-NLS-1$
id,
context.getRowIndex() + 1,
context.getColumnIndex() + 1));
}
builder.add(name, context.getStringCellValue());
}
@Override
public void dateProperty(PropertyName name, Cell context) throws IOException {
if (context.getCellTypeEnum() != CellType.NUMERIC) {
throw exception(name, context, "date/datetime"); //$NON-NLS-1$
}
Calendar calendar = Calendar.getInstance();
calendar.setTime(context.getDateCellValue());
Calendar result = Calendar.getInstance();
result.clear();
result.set(
calendar.get(Calendar.YEAR),
calendar.get(Calendar.MONTH),
calendar.get(Calendar.DATE));
builder.add(name, result);
}
@Override
public void timeProperty(PropertyName name, Cell context) throws IOException {
if (context.getCellTypeEnum() != CellType.NUMERIC) {
throw exception(name, context, "date/datetime"); //$NON-NLS-1$
}
Calendar calendar = Calendar.getInstance();
calendar.setTime(context.getDateCellValue());
Calendar result = Calendar.getInstance();
result.clear();
result.set(Calendar.HOUR_OF_DAY, calendar.get(Calendar.HOUR_OF_DAY));
result.set(Calendar.MINUTE, calendar.get(Calendar.MINUTE));
result.set(Calendar.SECOND, calendar.get(Calendar.SECOND));
builder.add(name, result);
}
@Override
public void datetimeProperty(PropertyName name, Cell context) throws IOException {
if (context.getCellTypeEnum() != CellType.NUMERIC) {
throw exception(name, context, "date/datetime"); //$NON-NLS-1$
}
Calendar calendar = Calendar.getInstance();
calendar.setTime(context.getDateCellValue());
Calendar result = Calendar.getInstance();
result.clear();
result.set(
calendar.get(Calendar.YEAR),
calendar.get(Calendar.MONTH),
calendar.get(Calendar.DATE),
calendar.get(Calendar.HOUR_OF_DAY),
calendar.get(Calendar.MINUTE),
calendar.get(Calendar.SECOND));
builder.add(name, result);
}
@Override
public void anyProperty(PropertyName name, Cell context) throws IOException {
throw exception(name, context, "(BLANK)"); //$NON-NLS-1$
}
private IOException exception(PropertyName name, Cell cell, String expected) {
return new IOException(MessageFormat.format(
Messages.getString("ExcelDataDriver.errorUnexpectedCellType"), //$NON-NLS-1$
name,
expected,
id,
cell.getRowIndex() + 1,
cell.getColumnIndex() + 1));
}
}
}