Package com.helger.photon.exchange.bulkimport

Interface IBulkImport

All Known Implementing Classes:

AbstractBulkImport, AbstractBulkImportExcel

public interface IBulkImport

Base interface for a bulk import action.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
int	getColumnCount()
com.helger.commons.collection.impl.ICommonsList<String>	getColumnDescriptions(Locale aContentLocale)	Get a list of all column descriptions.
int	getHeaderRowsToSkip()
com.helger.commons.collection.impl.ICommonsList<EExchangeFileType>	getSupportedFileTypes()
BulkImportResult	importObjects(com.helger.commons.io.IHasInputStream aIIS, Locale aDisplayLocale)	Read the objects from the passed input stream.

Method Detail

getSupportedFileTypes

@Nonnull
@Nonempty
com.helger.commons.collection.impl.ICommonsList<EExchangeFileType> getSupportedFileTypes()

Returns:

A non-null, non-empty set of all supported file types.

getHeaderRowsToSkip

@Nonnegative
int getHeaderRowsToSkip()

Returns:

The initial rows to skip.

getColumnCount

@Nonnegative
int getColumnCount()

Returns:

The number of columns the input data is required to have

getColumnDescriptions

@Nonnull
@Nonempty
com.helger.commons.collection.impl.ICommonsList<String> getColumnDescriptions(@Nonnull
                                                                              Locale aContentLocale)

Get a list of all column descriptions.

Parameters:

aContentLocale - The locale to be used.

Returns:

The non-null, non-empty list of column descriptions.

importObjects

@Nonnull
BulkImportResult importObjects(@Nonnull
                               com.helger.commons.io.IHasInputStream aIIS,
                               @Nonnull
                               Locale aDisplayLocale)

Read the objects from the passed input stream.

Parameters:

aIIS - The input stream provider to read from. May not be null .

aDisplayLocale - The display locale. May not be null.

Returns:

The import result. Never null.