Package org.apache.drill.exec.store.googlesheets.utils

Class GoogleSheetsRangeBuilder

java.lang.Object

org.apache.drill.exec.store.googlesheets.utils.GoogleSheetsRangeBuilder

All Implemented Interfaces:

Iterator<String>

public class GoogleSheetsRangeBuilder
extends Object
implements Iterator<String>

This class is used to construct a range with the GoogleSheet reader in Drill. This builder generates ranges and can apply the projection and limit pushdowns to the ranges. GoogleSheets uses A1 notation for defining columns and ranges. An example would be: 'Sheet1'!A11:F20

Constructor Summary

Constructors

Constructor	Description
GoogleSheetsRangeBuilder(String sheetName, int batchSize)

Method Summary

Modifier and Type	Method	Description
GoogleSheetsRangeBuilder	addColumn(int columnIndex)
GoogleSheetsRangeBuilder	addColumn(String columnLetter)
GoogleSheetsRangeBuilder	addFirstColumn(String column)
GoogleSheetsRangeBuilder	addLastColumn(String column)
GoogleSheetsRangeBuilder	addLimit(int limit)	Adds a limit to the range builder.
GoogleSheetsRangeBuilder	addProjectedRanges(List<GoogleSheetsColumnRange> projectedRanges)
GoogleSheetsRangeBuilder	addRowCount(int rowCount)
int	getRowCount()
boolean	hasNext()
GoogleSheetsRangeBuilder	isStarQuery(boolean isStarQuery)
void	lastBatch()	When a limit is not present, the BatchReader must call this method to indicate when there are no more results and to stop generating new ranges.
String	next()
List<String>	nextBatch()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Details

GoogleSheetsRangeBuilder

public GoogleSheetsRangeBuilder(String sheetName,
 int batchSize)

Method Details

addColumn

public GoogleSheetsRangeBuilder addColumn(String columnLetter)

addColumn

public GoogleSheetsRangeBuilder addColumn(int columnIndex)

addLimit

public GoogleSheetsRangeBuilder addLimit(int limit)

Adds a limit to the range builder.

Parameters:

limit - The maximum number of total results returned

Returns:

The range builder with the limit applied

addFirstColumn

public GoogleSheetsRangeBuilder addFirstColumn(String column)

addLastColumn

public GoogleSheetsRangeBuilder addLastColumn(String column)

addRowCount

public GoogleSheetsRangeBuilder addRowCount(int rowCount)

addProjectedRanges

public GoogleSheetsRangeBuilder addProjectedRanges(List<GoogleSheetsColumnRange> projectedRanges)

isStarQuery

public GoogleSheetsRangeBuilder isStarQuery(boolean isStarQuery)

lastBatch

public void lastBatch()

When a limit is not present, the BatchReader must call this method to indicate when there are no more results and to stop generating new ranges.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<String>

next

public String next()

Specified by:

next in interface Iterator<String>

nextBatch

public List<String> nextBatch()

getRowCount

public int getRowCount()

toString

public String toString()

Overrides:

toString in class Object