com.northconcepts.datapipeline.trello.TrelloBoardListsReader

public class TrelloBoardListsReader extends TrelloApiReader

Reads the list of Trello lists belonging to a board.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint
DataEndpoint.State
Field Summary

Fields inherited from class com.northconcepts.datapipeline.trello.TrelloApiReader
trelloStub

Fields inherited from class com.northconcepts.datapipeline.core.DataReader
fieldLineage, recordLineage

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint
lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint
BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject
id, log, name, TIMESTAMP_FORMAT
Constructor Summary

Constructors

Constructor

Description

TrelloBoardListsReader(String apiKey, String apiToken, String boardId)
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

String

getBoardId()

CardFilter

getCardFilter()

Returns which cards are requested along with the board's lists (defaults to CardFilter.NONE).

ListFilter

getListFilter()

Returns which of the board's lists are read (defaults to ListFilter.OPEN).

protected ArrayValue

readNextBatchImpl()

Fetches the next page of items as records using trelloStub; each item needs an id field and a page smaller than TrelloApiReader.getBatchSize() ends the read.

TrelloBoardListsReader

setCardFilter(CardFilter cardFilter)

Sets which cards are requested along with the board's lists; null means CardFilter.NONE and CardFilter.VISIBLE is rejected with an exception.

TrelloBoardListsReader

setListFilter(ListFilter listFilter)

Sets which of the board's lists are read; null means ListFilter.OPEN, the default.

Methods inherited from class com.northconcepts.datapipeline.trello.TrelloApiReader
close, getBatchSize, getBefore, getSince, open, readImpl, setBefore, setSince

Methods inherited from class com.northconcepts.datapipeline.core.DataReader
addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint
decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint
addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject
exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- TrelloBoardListsReader
  
  public TrelloBoardListsReader(String apiKey, String apiToken, String boardId)
Method Details
- getBoardId
  
  public String getBoardId()
- getCardFilter
  
  public CardFilter getCardFilter()
  
  Returns which cards are requested along with the board's lists (defaults to CardFilter.NONE).
- setCardFilter
  
  public TrelloBoardListsReader setCardFilter(CardFilter cardFilter)
  
  Sets which cards are requested along with the board's lists; null means CardFilter.NONE and CardFilter.VISIBLE is rejected with an exception.
- getListFilter
  
  public ListFilter getListFilter()
  
  Returns which of the board's lists are read (defaults to ListFilter.OPEN).
- setListFilter
  
  public TrelloBoardListsReader setListFilter(ListFilter listFilter)
  
  Sets which of the board's lists are read; null means ListFilter.OPEN, the default.
- readNextBatchImpl
  
  protected ArrayValue readNextBatchImpl()
  
  Description copied from class: TrelloApiReader
  
  Fetches the next page of items as records using trelloStub; each item needs an id field and a page smaller than TrelloApiReader.getBatchSize() ends the read.
  
  Specified by:
  
  readNextBatchImpl in class TrelloApiReader
- addExceptionProperties
  
  public DataException addExceptionProperties(DataException exception)
  
  Description copied from class: Endpoint
  
  Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.
  
  Overrides:
  
  addExceptionProperties in class TrelloApiReader

Class TrelloBoardListsReader

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Field Summary

Fields inherited from class com.northconcepts.datapipeline.trello.TrelloApiReader

Fields inherited from class com.northconcepts.datapipeline.core.DataReader

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.trello.TrelloApiReader

Methods inherited from class com.northconcepts.datapipeline.core.DataReader

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

Methods inherited from class java.lang.Object

Constructor Details

TrelloBoardListsReader

Method Details

getBoardId

getCardFilter

setCardFilter

getListFilter

setListFilter

readNextBatchImpl

addExceptionProperties