de.hybris.platform.impex.jalo

Class BeanShellImporter

java.lang.Object

de.hybris.platform.impex.jalo.BeanShellImporter

All Implemented Interfaces:

BeanShellImportable

public class BeanShellImporter
extends java.lang.Object
implements BeanShellImportable

Constructor Summary

Constructors

Constructor and Description
BeanShellImporter(ImpExReader impExReader, ModelService modelService)

Method Summary

Modifier and Type	Method and Description
void	enableBeanShellCodeExecution(boolean enable) Delegates to underlying ImpExReader.
void	enableBeanShellSyntaxParsing(boolean enable) Delegates to underlying ImpExReader.
void	enableResolving(boolean enable) Enables/disables dumping mechanism for the impex.
void	enableSLModeForImport(boolean value) Enables/disables a service layer mode flag for a importer context object.
ItemModel	getLastImportedData() Gets last imported ItemModel instance if impex is in 'servicelayer mode' otherwise it returns null.
java.util.Locale	getLocale()
void	importFile(java.io.File file, java.lang.String encoding, int linesToSkip) Creates a new temporary reader with given file and encoding and redirects the main reader to that temporary reader for including external data.
void	importMedia(ImpExMedia media, java.lang.Integer columnOffset, java.lang.String encoding, java.lang.Character delimiter, java.lang.Integer linesToSkip) Delegates to underlying ImpExReader.
void	importQuery(java.lang.String url, java.lang.String user, java.lang.String password, java.lang.String className, java.lang.String sqlStatement) Delegates to underlying ImpExReader.
void	importStream(java.io.InputStream inputStream, java.lang.String encoding, char[] delimiter, int linesToSkip, int columnOffset) Creates a new temporary reader with given input stream and encoding and redirects the main reader to that temporary reader for including external data.
boolean	isBeanShellCodeExecutionEnabled()
boolean	isBeanShellSyntaxParsingEnabled()
boolean	isResolvingEnabled()
boolean	isSLModeEnabled()
void	setLocale(java.util.Locale locale) Delegates to underlying ImpExReader.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanShellImporter

public BeanShellImporter(ImpExReader impExReader,
                         ModelService modelService)

Method Detail

enableSLModeForImport

public void enableSLModeForImport(boolean value)

Description copied from interface: BeanShellImportable

Enables/disables a service layer mode flag for a importer context object. This value could be used inside an impex process as marker of pending impex mode.

Specified by:

enableSLModeForImport in interface BeanShellImportable

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: BeanShellImportable

Delegates to underlying ImpExReader.

Specified by:

setLocale in interface BeanShellImportable

See Also:

ImpExReader.setLocale(Locale)

importQuery

public void importQuery(java.lang.String url,
                        java.lang.String user,
                        java.lang.String password,
                        java.lang.String className,
                        java.lang.String sqlStatement)

Description copied from interface: BeanShellImportable

Delegates to underlying ImpExReader.

Specified by:

importQuery in interface BeanShellImportable

See Also:

ImpExReader.includeSQLData(String, String, String, String, String)

importFile

public void importFile(java.io.File file,
                       java.lang.String encoding,
                       int linesToSkip)
                throws java.io.UnsupportedEncodingException,
                       java.io.FileNotFoundException,
                       ImpExException

Description copied from interface: BeanShellImportable

Creates a new temporary reader with given file and encoding and redirects the main reader to that temporary reader for including external data. So you can include external data within the main reader flow. Reading from temporary reader can be stopped by reaching the end of stream (switches back automatically). The column offset will be set to -1, so normal CSV data is assumed (not in hybris style).

Specified by:

importFile in interface BeanShellImportable

Parameters:

file - file which contains external data to be included

encoding - the encoding used in given file

linesToSkip - amount of lines the reader of the file will initial skip

Throws:

java.io.UnsupportedEncodingException - given encoding is unknown

java.io.FileNotFoundException - given file is not found

ImpExException

importStream

public void importStream(java.io.InputStream inputStream,
                         java.lang.String encoding,
                         char[] delimiter,
                         int linesToSkip,
                         int columnOffset)
                  throws java.io.UnsupportedEncodingException

Description copied from interface: BeanShellImportable

Creates a new temporary reader with given input stream and encoding and redirects the main reader to that temporary reader for including external data. So you can include external data within the main reader flow.

Specified by:

importStream in interface BeanShellImportable

Parameters:

inputStream - input stream from which external data to be included is accessable

encoding - the used encoding

delimiter - field separators used in external data

linesToSkip - amount of lines the reader of the stream will initial skip

columnOffset - position difference of header columns to data columns. Is data in hybris style, use 0 because data columns positions are exactly the same as in header. In default style use -1, because the data columns do not have a first column with type information. So the header columns have to be shifted one to the left =>-1.

Throws:

java.io.UnsupportedEncodingException - given encoding is unknown

importMedia

public void importMedia(ImpExMedia media,
                        java.lang.Integer columnOffset,
                        java.lang.String encoding,
                        java.lang.Character delimiter,
                        java.lang.Integer linesToSkip)
                 throws java.io.UnsupportedEncodingException

Description copied from interface: BeanShellImportable

Delegates to underlying ImpExReader.

Specified by:

importMedia in interface BeanShellImportable

Throws:

java.io.UnsupportedEncodingException

See Also:

ImpExReader.includeExternalDataMedia(ImpExMedia, String, char, int, int)

enableBeanShellCodeExecution

public void enableBeanShellCodeExecution(boolean enable)

Description copied from interface: BeanShellImportable

Delegates to underlying ImpExReader.

Specified by:

enableBeanShellCodeExecution in interface BeanShellImportable

See Also:

ImpExReader.enableExternalCodeExecution(boolean)

enableBeanShellSyntaxParsing

public void enableBeanShellSyntaxParsing(boolean enable)

Description copied from interface: BeanShellImportable

Delegates to underlying ImpExReader.

Specified by:

enableBeanShellSyntaxParsing in interface BeanShellImportable

See Also:

ImpExReader.enableExternalSyntaxParsing(boolean)

enableResolving

public void enableResolving(boolean enable)

Description copied from interface: BeanShellImportable

Enables/disables dumping mechanism for the impex. ` *

Specified by:

enableResolving in interface BeanShellImportable

See Also:

ImpExImportReader.setDumpingAllowed(boolean)

getLastImportedData

public ItemModel getLastImportedData()

Description copied from interface: BeanShellImportable

Gets last imported ItemModel instance if impex is in 'servicelayer mode' otherwise it returns null.

Specified by:

getLastImportedData in interface BeanShellImportable

isSLModeEnabled

public boolean isSLModeEnabled()

Returns:

the sLModeEnabled

getLocale

public java.util.Locale getLocale()

Returns:

the locale

isBeanShellCodeExecutionEnabled

public boolean isBeanShellCodeExecutionEnabled()

Returns:

the beanShellCodeExecutionEnabled

isBeanShellSyntaxParsingEnabled

public boolean isBeanShellSyntaxParsingEnabled()

Returns:

the beanShellSyntaxParsingEnabled

isResolvingEnabled

public boolean isResolvingEnabled()

Returns:

the resolvingEnabled