org.springframework.data.hadoop.store.dataset

Class AbstractDatasetStoreWriter<T,R>

java.lang.Object

org.springframework.data.hadoop.store.support.LifecycleObjectSupport

org.springframework.data.hadoop.store.dataset.DatasetStoreObjectSupport

org.springframework.data.hadoop.store.dataset.AbstractDatasetStoreWriter<T,R>

Type Parameters:

T - the type of entity to write

R - the type of entity in writer

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, DataStoreWriter<T>, DataWriter<T>

Direct Known Subclasses:

AvroPojoDatasetStoreWriter, ParquetDatasetStoreWriter

public abstract class AbstractDatasetStoreWriter<T,R>
extends DatasetStoreObjectSupport
implements DataStoreWriter<T>

An abstract DataStoreWriter to be extended for providing Dataset writing capabilities for specific use cases.

Author:

Thomas Risberg, Janne Valkealahti

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDatasetStoreWriter(java.lang.Class<T> entityClass, DatasetRepositoryFactory datasetRepositoryFactory, DatasetDefinition datasetDefinition) Instantiates a new DataStoreWriter for writing to a org.kitesdk.data.Dataset.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected abstract R	convertEntity(T entity) Convert entity to be written into a entity used by a writer.
protected abstract org.kitesdk.data.DatasetWriter<R>	createWriter() Creates a DatasetWriter.
void	flush()
protected DatasetDefinition	getDatasetDefinition() Gets the dataset definition.
protected DatasetRepositoryFactory	getDatasetRepositoryFactory() Gets the dataset repository factory.
protected java.lang.Class<T>	getEntityClass() Gets the entity class.
protected void	handleTimeout() Handle idle timeout.
void	write(T entity) Write an entity.

Methods inherited from class org.springframework.data.hadoop.store.dataset.DatasetStoreObjectSupport

doStart, doStop, onInit, resetIdleTimeout, setCloseTimeout, setIdleTimeout

Methods inherited from class org.springframework.data.hadoop.store.support.LifecycleObjectSupport

afterPropertiesSet, getBeanFactory, getPhase, getStoreEventPublisher, getTaskExecutor, getTaskScheduler, isAutoStartup, isRunning, setAutoStartup, setBeanFactory, setPhase, setStoreEventPublisher, setTaskExecutor, setTaskScheduler, start, stop, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDatasetStoreWriter

protected AbstractDatasetStoreWriter(java.lang.Class<T> entityClass,
                          DatasetRepositoryFactory datasetRepositoryFactory,
                          DatasetDefinition datasetDefinition)

Instantiates a new DataStoreWriter for writing to a org.kitesdk.data.Dataset.

Parameters:

entityClass - the Class that the writer will write to the Dataset

datasetRepositoryFactory - the DatasetRepositoryFactory to be used for the writer

datasetDefinition - the DatasetDefinition to be used for the writer

Method Detail

write

public void write(T entity)
           throws java.io.IOException

Description copied from interface: DataWriter

Write an entity.

Specified by:

write in interface DataWriter<T>

Parameters:

entity - the entity to write

Throws:

java.io.IOException - if an I/O error occurs

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

handleTimeout

protected void handleTimeout()

Description copied from class: DatasetStoreObjectSupport

Handle idle timeout. This method should be overriden to be notified of idle timeouts. Default implementation doesn't do anything.

Overrides:

handleTimeout in class DatasetStoreObjectSupport

convertEntity

protected abstract R convertEntity(T entity)

Convert entity to be written into a entity used by a writer.

Parameters:

entity - the entity

Returns:

the converted entity

getEntityClass

protected java.lang.Class<T> getEntityClass()

Gets the entity class.

Returns:

the entity class

getDatasetRepositoryFactory

protected DatasetRepositoryFactory getDatasetRepositoryFactory()

Gets the dataset repository factory.

Returns:

the dataset repository factory

getDatasetDefinition

protected DatasetDefinition getDatasetDefinition()

Gets the dataset definition.

Returns:

the dataset definition

createWriter

protected abstract org.kitesdk.data.DatasetWriter<R> createWriter()

Creates a DatasetWriter.

Returns:

the dataset writer