org.springframework.batch.item.excel.jxl.JxlUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-batch-excel Show documentation
Excel reader for Spring batch
The newest version!
/*
 * Copyright 2006-2019 the original author or authors.
 *
 * 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 org.springframework.batch.item.excel.jxl;

import jxl.Cell;
import jxl.Workbook;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;

import java.util.ArrayList;
import java.util.List;

/**
 * Class containing utility methods to work with JXL.
 *
 * @author Marten Deinum
 * @since 0.5.0
 */
public final class JxlUtils {

    /**
     * Private constructor to prevent easy instantiation.
     */
    private JxlUtils() {
    }

    /**
     * Checks if the given cell is emtpy. The cell is empty if it contains no characters,
     * it will trim spaces.
     *
     * @param cell to check
     * @return true/false
     * @see org.springframework.util.StringUtils#hasText(String)
     */
    public static boolean isEmpty(final Cell cell) {
        return cell == null || !StringUtils.hasText(cell.getContents());
    }

    /**
     * Check if the given row (Cell[]) is empty. It is considered empty when the row is
     * {@code null}, the array is empty or all the cells in the row are empty.
     *
     * @param row to check
     * @return true/false
     */
    public static boolean isEmpty(final Cell[] row) {
        if (ObjectUtils.isEmpty(row)) {
            return true;
        }
        for (final Cell cell : row) {
            if (!isEmpty(cell)) {
                return false;
            }
        }
        return true;
    }

    /**
     * Check if the given workbook has any sheets.
     *
     * @param workbook to check
     * @return true/false
     */
    public static boolean hasSheets(final Workbook workbook) {
        return workbook != null && workbook.getNumberOfSheets() > 0;
    }

    /**
     * Extract the content from the given row.
     *
     * @param row the row
     * @return the content as String[]
     */
    public static String[] extractContents(final Cell[] row) {
        final List values = new ArrayList<>();
        if (!ObjectUtils.isEmpty(row)) {
            for (final Cell cell : row) {
                if (!isEmpty(cell)) {
                    values.add(cell.getColumn(), cell.getContents());
                } else {
                    values.add(cell.getColumn(), "");
                }
            }
        }
        return values.toArray(new String[0]);
    }
}