com.feilong.excel.definition.ExcelSheet Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.0.8
Show newest version
/*
 * Copyright (C) 2008 feilong
 *
 * 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.feilong.excel.definition;

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

import com.feilong.core.bean.ConvertUtil;

/**
 * The Class ExcelSheet.
 */
public class ExcelSheet{

    /** The name. */
    private String           name;

    /** The display name. */
    private String           displayName;

    //---------------------------------------------------------------

    /** The excel blocks. */
    private List excelBlocks = new ArrayList<>();

    /** The is ordered. */
    private boolean          isOrdered   = false;

    //---------------------------------------------------------------

    /**
     * Gets the name.
     *
     * @return the name
     */
    public String getName(){
        return name;
    }

    /**
     * Sets the name.
     *
     * @param name
     *            the new name
     */
    public void setName(String name){
        this.name = name;
    }

    /**
     * Gets the display name.
     *
     * @return the display name
     */
    public String getDisplayName(){
        return displayName;
    }

    /**
     * Sets the display name.
     *
     * @param displayName
     *            the new display name
     */
    public void setDisplayName(String displayName){
        this.displayName = displayName;
    }

    //---------------------------------------------------------------

    /**
     * Gets the excel blocks.
     *
     * @return the excel blocks
     */
    public List getExcelBlocks(){
        return excelBlocks;
    }

    /**
     * Sets the excel blocks.
     *
     * @param excelBlocks
     *            the new excel blocks
     */
    public void setExcelBlocks(List excelBlocks){
        synchronized (ExcelSheet.class){
            this.excelBlocks = excelBlocks;
            isOrdered = false;
        }
    }

    //---------------------------------------------------------------

    /**
     * Gets the excel block.
     *
     * @return the excel block
     */
    public ExcelBlock getExcelBlock(){
        if (excelBlocks.isEmpty()){
            return null;
        }
        return excelBlocks.iterator().next();
    }

    /**
     * Sets the excel block.
     *
     * @param excelBlock
     *            the new excel block
     */
    public void setExcelBlock(ExcelBlock excelBlock){
        synchronized (ExcelSheet.class){
            excelBlocks.clear();
            excelBlocks.add(excelBlock);
            isOrdered = false;
        }
    }

    /**
     * 添加 excel block.
     *
     * @param excelBlock
     *            the excel block
     */
    public void addExcelBlock(ExcelBlock excelBlock){
        synchronized (ExcelSheet.class){
            excelBlocks.add(excelBlock);
            isOrdered = false;
        }
    }

    /**
     * Gets the sorted excel blocks.
     *
     * @return the sorted excel blocks
     */
    public List getSortedExcelBlocks(){
        synchronized (ExcelSheet.class){
            if (!isOrdered){
                Collections.sort(excelBlocks);
                isOrdered = true;
            }
        }
        return excelBlocks;
    }

    //---------------------------------------------------------------

    /**
     * To string.
     *
     * @return the string
     */
    @Override
    public String toString(){
        return "ExcelSheet [name=" + name + ", excelBlocks=\r\n\t" + ConvertUtil.toString(excelBlocks, "\r\n\t") + "]";
    }
}