com.jkoolcloud.tnt4j.streams.parsers.AbstractExcelParser.java Source code

Introduction

Here is the source code for com.jkoolcloud.tnt4j.streams.parsers.AbstractExcelParser.java

Source

/*
 * Copyright 2014-2017 JKOOL, LLC.
 *
 * 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.jkoolcloud.tnt4j.streams.parsers;

import java.util.Collection;
import java.util.Map;

import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellValue;
import org.apache.poi.ss.usermodel.FormulaEvaluator;
import org.apache.poi.ss.usermodel.Workbook;

/**
 * Base class for abstract activity data parser that assumes each activity data item can MS Excel
 * {@link org.apache.poi.ss.usermodel.Workbook} contained data structure (e.g.,
 * {@link org.apache.poi.ss.usermodel.Sheet} or {@link org.apache.poi.ss.usermodel.Row}), where each field is
 * represented by a {@link org.apache.poi.ss.usermodel.Cell} and the sheet name and cell identifier (row number and
 * column letter) is used to map cell(s) contained data into its corresponding activity field.
 *
 * @version $Revision: 1 $
 */
public abstract class AbstractExcelParser<T> extends GenericActivityParser<T> {

    private FormulaEvaluator evaluator;

    protected final Object EVALUATOR_LOCK = new Object();

    @Override
    public void setProperties(Collection<Map.Entry<String, String>> props) throws Exception {
        if (props == null) {
            return;
        }

        super.setProperties(props);

        // for (Map.Entry<String, String> prop : props) {
        // String name = prop.getKey();
        // String value = prop.getValue();
        //
        // // no any additional properties are required yet.
        // if (false) {
        // logger().log(OpLevel.DEBUG,
        // StreamsResources.getString(StreamsResources.RESOURCE_BUNDLE_NAME, "ActivityParser.setting"),
        // name, value);
        // }
        // }
    }

    /**
     * Evaluates and returns cell contained value.
     *
     * @param cell
     *            cell instance to evaluate value
     * @return evaluated cell value
     */
    protected Object getCellValue(Cell cell) {
        CellValue cellValue;
        synchronized (EVALUATOR_LOCK) {
            if (evaluator == null) {
                Workbook workbook = cell.getSheet().getWorkbook();
                evaluator = workbook.getCreationHelper().createFormulaEvaluator();
            }

            cellValue = evaluator.evaluate(cell);
        }

        if (cellValue == null) {
            return cell.toString();
        }

        switch (cellValue.getCellTypeEnum()) {
        case BOOLEAN:
            return cellValue.getBooleanValue();
        case NUMERIC:
            return cellValue.getNumberValue();
        case STRING:
            return cellValue.getStringValue();
        default:
            return cellValue.formatAsString();
        }
    }
}