org.jxls.command.AbstractCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jxls Show documentation
Small library for Excel generation based on XLS templates
The newest version!
package org.jxls.command;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.jxls.area.Area;
import org.jxls.common.Context;
import org.jxls.common.JxlsException;
import org.jxls.logging.JxlsLogger;
import org.jxls.transform.Transformer;

/**
 * Implements basic command methods and is a convenient base class for other commands
 *
 * @author Leonid Vysochyn
 */
public abstract class AbstractCommand implements Command {
    protected List areaList = new ArrayList<>();
    private String shiftMode;
    /**
     * Whether the image area is locked
     * Other commands will no longer execute in this area after locking
     * default true
     */
    private Boolean lockRange = Boolean.TRUE;

    @Override
    public Command addArea(Area area) {
        areaList.add(area);
        area.setParentCommand(this);
        return this;
    }

    @Override
    public void reset() {
    	areaList.forEach(area -> area.reset());
    }

    @Override
    public void setShiftMode(String mode) {
    	if (Command.INNER_SHIFT_MODE.equals(mode) || Command.ADJACENT_SHIFT_MODE.equals(mode)) {
    		shiftMode = mode;
    	} else {
			throw new IllegalArgumentException("Use \"" + Command.INNER_SHIFT_MODE + "\" or \""
					+ Command.ADJACENT_SHIFT_MODE + "\" for shiftMode.");
    	}
    }

    @Override
    public String getShiftMode() {
        return shiftMode;
    }

    @Override
    public List getAreaList() {
        return areaList;
    }

    @Override
    public Boolean getLockRange() {
        return lockRange;
    }

    @Override
    public void setLockRange(String isLock) {
        if (isLock != null && !isLock.isEmpty()) {
            this.lockRange = Boolean.valueOf(isLock);
        }
    }

    public void setLockRange(Boolean lockRange) {
        this.lockRange = lockRange;
    }

    protected Transformer getTransformer() {
        return areaList.isEmpty() ? null : areaList.get(0).getTransformer();
    }
    
    protected JxlsLogger getLogger() {
        Transformer transformer = getTransformer();
        if (transformer == null) {
            throw new JxlsException("Command has no transformer and can not write to log");
        }
        return transformer.getLogger();
    }

    /**
     * Evaluates the passed collection name into an {@link Iterable} object
     * @param collectionName -
     * @param context -
     * @return an iterable object from the {@link Context} under given name
     */
    protected Iterable