com.northconcepts.datapipeline.google.calendar

Class GoogleCalendarReader

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataReader

com.northconcepts.datapipeline.internal.lang.IntegrationReader

com.northconcepts.datapipeline.google.GoogleApiReader

com.northconcepts.datapipeline.google.calendar.GoogleCalendarReader

public class GoogleCalendarReader
extends GoogleApiReader

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.google.GoogleApiReader

credentials, JSON_FACTORY, transport

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 and Description
GoogleCalendarReader(Credential credential, HttpTransport httpTransport)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
int	getBatchSize()
String	getCalendarId()
DataException	getException()
String	getOrderBy()
Date	getTimeMax()
Date	getTimeMin()
Date	getUpdatedMin()
boolean	isAlwaysIncludeEmail()
boolean	isSingleEvent()
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
GoogleCalendarReader	setAlwaysIncludeEmail(boolean alwaysIncludeEmail)
GoogleCalendarReader	setBatchSize(int batchSize)
GoogleCalendarReader	setCalendarId(String calendarId)
GoogleCalendarReader	setOrderBy(String orderBy)
GoogleCalendarReader	setSingleEvent(boolean singleEvent)
GoogleCalendarReader	setTimeMax(Date timeMax)
GoogleCalendarReader	setTimeMin(Date timeMin)
GoogleCalendarReader	setUpdatedMin(Date updatedMin)

Methods inherited from class com.northconcepts.datapipeline.google.GoogleApiReader

getApplicationName, setApplicationName, setJsonFactory, toDate, toException

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 Detail

GoogleCalendarReader

public GoogleCalendarReader(Credential credential,
                            HttpTransport httpTransport)

Method Detail

getBatchSize

public int getBatchSize()

setBatchSize

public GoogleCalendarReader setBatchSize(int batchSize)

getTimeMin

public Date getTimeMin()

setTimeMin

public GoogleCalendarReader setTimeMin(Date timeMin)

getTimeMax

public Date getTimeMax()

setTimeMax

public GoogleCalendarReader setTimeMax(Date timeMax)

getUpdatedMin

public Date getUpdatedMin()

setUpdatedMin

public GoogleCalendarReader setUpdatedMin(Date updatedMin)

getCalendarId

public String getCalendarId()

setCalendarId

public GoogleCalendarReader setCalendarId(String calendarId)

getOrderBy

public String getOrderBy()

setOrderBy

public GoogleCalendarReader setOrderBy(String orderBy)

isSingleEvent

public boolean isSingleEvent()

setSingleEvent

public GoogleCalendarReader setSingleEvent(boolean singleEvent)

isAlwaysIncludeEmail

public boolean isAlwaysIncludeEmail()

setAlwaysIncludeEmail

public GoogleCalendarReader setAlwaysIncludeEmail(boolean alwaysIncludeEmail)

getException

public DataException getException()

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class IntegrationReader

Throws:

DataException

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class GoogleApiReader

Throws:

DataException

readImpl

protected Record readImpl()
                   throws Throwable

Description copied from class: DataReader

Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

If no record is available, null will be returned.

Specified by:

readImpl in class DataReader

Throws:

Throwable

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 GoogleApiReader