com.northconcepts.datapipeline.shopify.ShopifyOrderReader

public class ShopifyOrderReader extends ShopifyApiReader

Reads orders from a Shopify store, optionally filtered by ShopifyOrder criteria.

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.shopify.ShopifyApiReader
service

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

ShopifyOrderReader(String domain, String token)

Creates a reader for the store at domain, a base URL such as https://example.myshopify.com, using an access token.
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

ShopifyOrder

getOrderCriteria()

Returns the criteria for the orders to read or null for none; it is modified in place when later pages are requested.

protected ArrayValue

getRecordsFromResponse(Record record)

Returns the records in a response from ShopifyApiReader.invokeRequest(), such as its orders array; null or empty ends reading.

protected Record

invokeRequest()

Fetches the page for the ShopifyApiReader.getNextPageInfo() cursor (up to ShopifyApiReader.getBatchSize() records); must not return null.

ShopifyOrderReader

setOrderCriteria(ShopifyOrder orderCriteria)

Sets the criteria for the orders to read or null for none; it is modified in place when later pages are requested.

Methods inherited from class com.northconcepts.datapipeline.shopify.ShopifyApiReader
close, getBatchSize, getInitialRetryDelay, getMaxRetryCount, getNextPageInfo, getRetryStrategy, open, readImpl, setBatchSize, setInitialRetryDelay, setMaxRetryCount, setRetryStrategy

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
- ShopifyOrderReader
  
  public ShopifyOrderReader(String domain, String token)
  
  Creates a reader for the store at domain, a base URL such as https://example.myshopify.com, using an access token.
Method Details
- getOrderCriteria
  
  public ShopifyOrder getOrderCriteria()
  
  Returns the criteria for the orders to read or null for none; it is modified in place when later pages are requested.
- setOrderCriteria
  
  public ShopifyOrderReader setOrderCriteria(ShopifyOrder orderCriteria)
  
  Sets the criteria for the orders to read or null for none; it is modified in place when later pages are requested.
- invokeRequest
  
  protected Record invokeRequest()
  
  Description copied from class: ShopifyApiReader
  
  Fetches the page for the ShopifyApiReader.getNextPageInfo() cursor (up to ShopifyApiReader.getBatchSize() records); must not return null. Reading continues with another page only if the response has a non-empty next field.
  
  Specified by:
  
  invokeRequest in class ShopifyApiReader
- getRecordsFromResponse
  
  protected ArrayValue getRecordsFromResponse(Record record)
  
  Description copied from class: ShopifyApiReader
  
  Returns the records in a response from ShopifyApiReader.invokeRequest(), such as its orders array; null or empty ends reading.
  
  Specified by:
  
  getRecordsFromResponse in class ShopifyApiReader
- 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 ShopifyApiReader

Class ShopifyOrderReader

Nested Class Summary

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

Field Summary

Fields inherited from class com.northconcepts.datapipeline.shopify.ShopifyApiReader

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.shopify.ShopifyApiReader

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

ShopifyOrderReader

Method Details

getOrderCriteria

setOrderCriteria

invokeRequest

getRecordsFromResponse

addExceptionProperties