Package com.helger.photon.exchange.bulkimport

Class AbstractBulkImport

java.lang.Object

com.helger.photon.exchange.bulkimport.AbstractBulkImport

All Implemented Interfaces:

IBulkImport

Direct Known Subclasses:

AbstractBulkImportExcel

public abstract class AbstractBulkImport
extends Object
implements IBulkImport

Base class for IBulkImport implementations.

Author:

Philip Helger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBulkImport(int nHeaderRowsToSkip, List<com.helger.commons.text.display.IHasDisplayText> aColumnNames, EExchangeFileType... aFileTypes)

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()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.exchange.bulkimport.IBulkImport

importObjects

Constructor Detail

AbstractBulkImport

protected AbstractBulkImport(@Nonnegative
                             int nHeaderRowsToSkip,
                             @Nonnull @Nonempty
                             List<com.helger.commons.text.display.IHasDisplayText> aColumnNames,
                             @Nonnull @Nonempty
                             EExchangeFileType... aFileTypes)

Method Detail

getHeaderRowsToSkip

@Nonnegative
public final int getHeaderRowsToSkip()

Specified by:

getHeaderRowsToSkip in interface IBulkImport

Returns:

The initial rows to skip.

getColumnCount

@Nonnegative
public final int getColumnCount()

Specified by:

getColumnCount in interface IBulkImport

Returns:

The number of columns the input data is required to have

getColumnDescriptions

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

Description copied from interface: IBulkImport

Get a list of all column descriptions.

Specified by:

getColumnDescriptions in interface IBulkImport

Parameters:

aContentLocale - The locale to be used.

Returns:

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

getSupportedFileTypes

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

Specified by:

getSupportedFileTypes in interface IBulkImport

Returns:

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

toString

public String toString()

Overrides:

toString in class Object