org.hellojavaer.poi.excel.utils.read.ExcelReadCellValueMapping Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi-excel-utils Show documentation

poi-excel-utils makes the conversion between excel file data and java bean easy

There is a newer version: 2.0.0-beta

/*
 * Copyright 2015-2016 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.hellojavaer.poi.excel.utils.read;

import java.util.HashMap;

import org.hellojavaer.poi.excel.utils.write.ExcelWriteCellValueMapping;

/**
 * Config the mapping between source value(which must be convertd to type of
 * String) to target value.

 * If you have used this configration, it also requries that very source value
 * must have a target value. If not, {@code #ExcelWriteException} will been
 * thrown. To process this case, you can use 'setDefaultValue' method or
 * 'setDefaultProcessor' to set default value.
 * 
 * @see ExcelWriteCellValueMapping
 * @author zoukaiming
 */
public class ExcelReadCellValueMapping extends HashMap {

    private static final long      serialVersionUID   = 1L;

    private static final Object    DEFAULT_INPUT      = new Object();
    private boolean                settedDefaultValue = false;
    private Object                 defaultValue       = null;
    private ExcelReadCellProcessor defaultProcessor;

    public Object getDefaultValue() {
        return this.defaultValue;
    }

    public void setDefaultValue(Object val) {
        this.defaultValue = val;
        this.settedDefaultValue = true;
    }

    public void setDefaultValueWithDefaultInput() {
        this.defaultValue = DEFAULT_INPUT;
        this.settedDefaultValue = true;
    }

    public void resetDefaultValue() {
        this.defaultValue = null;
        this.settedDefaultValue = false;
    }

    public boolean isSettedDefaultValue() {
        return settedDefaultValue;
    }

    public boolean isSettedDefaultValueWithDefaultInput() {
        return settedDefaultValue && (defaultValue == DEFAULT_INPUT);
    }

    public ExcelReadCellProcessor getDefaultProcessor() {
        return defaultProcessor;
    }

    public void setDefaultProcessor(ExcelReadCellProcessor defaultProcessor) {
        this.defaultProcessor = defaultProcessor;
    }
}