com.northconcepts.datapipeline.google.analytics

Class GoogleAnalyticsReportReader

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.analytics.GoogleAnalyticsReportReader

public class GoogleAnalyticsReportReader
extends GoogleApiReader

Nested Class Summary

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

DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_14_DAYS_AGO
static String	DATE_30_DAYS_AGO
static String	DATE_60_DAYS_AGO
static String	DATE_7_DAYS_AGO
static String	DATE_90_DAYS_AGO
static String	DATE_TODAY
static String	DATE_YESTERDAY

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
GoogleAnalyticsReportReader(GoogleCredential credential, HttpTransport httpTransport, String viewId)
GoogleAnalyticsReportReader(GoogleCredential credentials, String viewId)

Method Summary

Modifier and Type	Method and Description
GoogleAnalyticsReportReader	addDateRange(String startDate, String endDate)
GoogleAnalyticsReportReader	addDimension(String name)
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
GoogleAnalyticsReportReader	addMetric(String expression)
GoogleAnalyticsReportReader	addMetric(String expression, String alias)
void	close() Indicates that this endpoint has finished reading or writing.
String	getViewId()
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.

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

Field Detail

DATE_TODAY

public static final String DATE_TODAY

See Also:

Constant Field Values

DATE_YESTERDAY

public static final String DATE_YESTERDAY

See Also:

Constant Field Values

DATE_7_DAYS_AGO

public static final String DATE_7_DAYS_AGO

See Also:

Constant Field Values

DATE_14_DAYS_AGO

public static final String DATE_14_DAYS_AGO

See Also:

Constant Field Values

DATE_30_DAYS_AGO

public static final String DATE_30_DAYS_AGO

See Also:

Constant Field Values

DATE_60_DAYS_AGO

public static final String DATE_60_DAYS_AGO

See Also:

Constant Field Values

DATE_90_DAYS_AGO

public static final String DATE_90_DAYS_AGO

See Also:

Constant Field Values

Constructor Detail

GoogleAnalyticsReportReader

public GoogleAnalyticsReportReader(GoogleCredential credential,
                                   HttpTransport httpTransport,
                                   String viewId)

GoogleAnalyticsReportReader

public GoogleAnalyticsReportReader(GoogleCredential credentials,
                                   String viewId)

Method Detail

getViewId

public String getViewId()

addDateRange

public GoogleAnalyticsReportReader addDateRange(String startDate,
                                                String endDate)

addMetric

public GoogleAnalyticsReportReader addMetric(String expression)

addMetric

public GoogleAnalyticsReportReader addMetric(String expression,
                                             String alias)

addDimension

public GoogleAnalyticsReportReader addDimension(String name)

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