com.welemski.wrench.poi.util.SheetQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wrench-poi Show documentation
Wrenches for POI
The newest version!
/*
 * The MIT License
 *
 * Copyright 2016 Lemuel Raganas.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.welemski.wrench.poi.util;

import java.util.List;
import org.apache.poi.ss.usermodel.Workbook;

/**
 *
 * @author Lemuel Raganas 
 */
public interface SheetQuery {
    
    /**
     * Sets the default sheet to query.
     * 
     * @param sheetName the sheet's name/title
     * @return SheetQuery
     */
    public SheetQuery from(String sheetName);
    
    /**
     * Sets the default sheet to query.
     * 
     * @param sheetIndex 0 based index
     * @return 
     */
    public SheetQuery from(int sheetIndex);
    
    /**
     * Conditions or custom filters.
     * 
     * @param condition a filter
     * @return 
     */
    public SheetQuery where(SpreadsheetQueryCondition condition);
    
    /**
     * Retrieve all rows.
     * 
     * @return a list of SpreadsheetRow
     */
    public List findAll();
    
    /**
     * Sets a maxim number of rows to fetch from a sheet.
     * 
     * @param limit maximum number of rows to fetch
     * @return  a list of SpreadsheetRow
     */
    public List findAll(int limit);
    
    /**
     * Get a single row from the current sheet.
     * 
     * @return SpreadsheetRow
     */
    public SpreadsheetRow get();
    
    /**
     * Get a single row from the current sheet at index.
     * 
     * @param atIndex 0 based index.
     * @return 
     */
    public SpreadsheetRow get(int atIndex);
    
    public SpreadsheetCell getCell(String cellAddress);
            
    public SheetQuery setLimit(int limit);
    
    public SheetQuery atRow(int rowIndex);
    
    public Workbook getWorkbook();
    
    
    public int count();
}