eu.etaxonomy.cdm.io.csv.in

Class CsvImportConfiguratorBase

java.lang.Object

eu.etaxonomy.cdm.io.common.ObservableBase

eu.etaxonomy.cdm.io.common.IoConfiguratorBase

eu.etaxonomy.cdm.io.common.ImportConfiguratorBase<CsvImportState<CsvImportConfiguratorBase>,java.io.InputStreamReader>

eu.etaxonomy.cdm.io.csv.in.CsvImportConfiguratorBase

All Implemented Interfaces:

IImportConfigurator, IIoConfigurator, IIoObservable, java.io.Serializable

Direct Known Subclasses:

TropicosNameImportConfigurator, WfoAccessImportConfigurator

public abstract class CsvImportConfiguratorBase
extends ImportConfiguratorBase<CsvImportState<CsvImportConfiguratorBase>,java.io.InputStreamReader>

Base class for csv import configuration.

Since:

08.07.2017

Author:

a.mueller

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface eu.etaxonomy.cdm.io.common.IImportConfigurator

IImportConfigurator.CHECK, IImportConfigurator.DO_REFERENCES, IImportConfigurator.EDITOR, IImportConfigurator.SOURCE_TYPE

Field Summary

Fields inherited from class eu.etaxonomy.cdm.io.common.ImportConfiguratorBase

ioBeans, ioClassList, ioList, sourceReference

Fields inherited from class eu.etaxonomy.cdm.io.common.IoConfiguratorBase

authenticationToken, cdmApp, hibernateConfig, INCLUDE_UNPUBLISHED, NO_UNPUBLISHED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CsvImportConfiguratorBase(java.io.InputStreamReader inputStream, ICdmDataSource cdmDestination)
protected	CsvImportConfiguratorBase(java.io.InputStreamReader inputStream, ICdmDataSource cdmDestination, IInputTransformer transformer)
protected	CsvImportConfiguratorBase(java.net.URI uri, ICdmDataSource cdmDestination, IInputTransformer transformer)

Method Summary

Modifier and Type	Method and Description
char	getFieldSeparator() Returns the field separator.
CsvImportState	getNewState() Factory method.
Reference	getSourceReference() The reference that represents the source.
int	getTransactionLineCount()
protected java.io.InputStreamReader	newInputStream()
void	setFieldSeparator(char fieldSeparator)
void	setTransactionLineCount(int transactionLineCount)

Methods inherited from class eu.etaxonomy.cdm.io.common.ImportConfiguratorBase

getAuthenticationToken, getCheck, getClassificationName, getClassificationUuid, getCommentator, getDateString, getDefaultFunction, getDestination, getDestinationNameString, getEditor, getFeatureMap, getFeatureTreeTitle, getIoClassList, getNomenclaturalCode, getSecUuid, getSource, getSourceNameString, getSourceReferenceTitle, getSourceRefUuid, getSourceSecId, getTransformer, getUuidFeatureTree, isCreateNew, isInteractWithUser, isOmitTermLoading, isRegisterAuditing, isValid, makeIoClassList, setCheck, setClassificationName, setClassificationUuid, setCommentator, setDestination, setEditor, setFeatureMap, setFeatureTreeTitle, setInteractWithUser, setIoClassList, setIoClassList, setNomenclaturalCode, setRegisterAuditing, setSecUuid, setSource, setSourceReference, setSourceReferenceTitle, setSourceRefUuid, setSourceSecId, setTransformer, setUuidFeatureTree

Methods inherited from class eu.etaxonomy.cdm.io.common.IoConfiguratorBase

authenticateAsDefaultAdmin, getCdmAppController, getDbSchemaValidation, getHibernateConfig, getProgressMonitor, getUserFriendlyIOName, isUseClassification, setAuthentication, setAuthenticationToken, setCdmAppController, setDbSchemaValidation, setProgressMonitor, setUseClassification, setUserFriendlyIOName

Methods inherited from class eu.etaxonomy.cdm.io.common.ObservableBase

addObserver, addObservers, countObservers, fire, fireWarningEvent, fireWarningEvent, getObservers, removeObserver, removeObservers, setObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.etaxonomy.cdm.io.common.IImportConfigurator

getDbSchemaValidation, setDbSchemaValidation

Methods inherited from interface eu.etaxonomy.cdm.io.common.IIoConfigurator

authenticateAsDefaultAdmin, getCdmAppController, getHibernateConfig, getObservers, getProgressMonitor, getUserFriendlyIOName, setAuthentication, setAuthenticationToken, setCdmAppController, setObservers, setProgressMonitor

Methods inherited from interface eu.etaxonomy.cdm.io.common.IIoObservable

addObserver, addObservers, countObservers, removeObserver, removeObservers

Constructor Detail

CsvImportConfiguratorBase

protected CsvImportConfiguratorBase(java.io.InputStreamReader inputStream,
                                    ICdmDataSource cdmDestination)

CsvImportConfiguratorBase

protected CsvImportConfiguratorBase(java.io.InputStreamReader inputStream,
                                    ICdmDataSource cdmDestination,
                                    IInputTransformer transformer)

CsvImportConfiguratorBase

protected CsvImportConfiguratorBase(java.net.URI uri,
                                    ICdmDataSource cdmDestination,
                                    IInputTransformer transformer)
                             throws java.io.IOException

Throws:

java.io.IOException

Method Detail

newInputStream

protected java.io.InputStreamReader newInputStream()
                                            throws java.io.IOException

Throws:

java.io.IOException

getSourceReference

public Reference getSourceReference()

Description copied from interface: IImportConfigurator

The reference that represents the source. E.g. if the import source is a database the returned reference should be of type eu.etaxonomy.cdm.model.reference.Database and should represent the according database. If the import comes from a file (e.g. XML) the returned value should best represent the source of this file (e.g. if the source of an XML file is a certain database this database should be mentioned as the source. Otherwise a eu.etaxonomy.cdm.model.reference.Generic reference with the name of the XML file should be returned value

Specified by:

getSourceReference in interface IImportConfigurator

Specified by:

getSourceReference in class ImportConfiguratorBase<CsvImportState<CsvImportConfiguratorBase>,java.io.InputStreamReader>

Returns:

getNewState

public CsvImportState getNewState()

Factory method. Creates a new state for the import type and adds this configuration to it.

Returns:

getFieldSeparator

public char getFieldSeparator()

Returns the field separator. Default is ','. In future we may add other types like

setFieldSeparator

public void setFieldSeparator(char fieldSeparator)

getTransactionLineCount

public int getTransactionLineCount()

Returns:

the transactionLineCount

setTransactionLineCount

public void setTransactionLineCount(int transactionLineCount)

Parameters:

transactionLineCount - the transactionLineCount to set