de.hybris.platform.bmecat.xmlwriter

Class BMECatWriter

java.lang.Object

de.hybris.platform.bmecat.xmlwriter.BMECatWriter

Direct Known Subclasses:

BMECatExportJob.MyBMECatWriter

public class BMECatWriter
extends Object

The BMECatWriter is an interface to easy specify an BMECatExport. The mandatory informations have to be specified in the constructor. If you want to customize the export via the USER_DEFINED_EXTENSIONS you can add own XMLTagWriter to the UserDefinedExtensionsTagWriter provided by the methods:

• getHeaderUserDefinedExtensionsTagWriter()
• getArticleUserDefinedExtensionsTagWriter()
• getCatalogStructureUserDefinedExtensionsTagWriter()

of BMECatTagWriter Here is an example:

 final UserDefinedExtensionsTagWriter articleUdxTagWriter = bmeCatTagWriter.getArticleUserDefinedExtensionsTagWriter();
 articleUdxTagWriter.addSubTagWriter(new SimpleTagWriter(articleUdxTagWriter, "UDX.HYBRIS.PK")
 {
        protected void writeContent(final XMLOutputter xmlOut, final Object object) throws IOException
        {
                final Product p = (Product) object;
                xmlOut.setLineBreak(LineBreak.NONE);
                xmlOut.pcdata(p.getPK().toString());
        }
 });
 

You can also add, remove or replace any XMLTagWriter via the addSubTagWriter-methods of XMLTagWriter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BMECatWriter.MyBMECatTagWriter
static interface	BMECatWriter.RangedItemProvider An interface to provide items in a range.
protected static class	BMECatWriter.SessionSettings

Constructor Summary

Constructors

Constructor and Description

BMECatWriter(CatalogVersion catVersion, EnumerationValue transactionMode, Collection classificationSystemVersions, Language exportLang, Map hybris2bmecatMediaMap, Media exportedMedias, Map priceMapping, boolean udpNet, Date refDate, Customer refCustomer, Currency exportCurrency, boolean ignoreErrors, boolean suppressEmptyCategories, boolean suppressProductsWithoutPrices, String classificationNumberFormat) Constructs an BMECatWriter.

Method Summary

Modifier and Type	Method and Description
protected BMECatWriter.SessionSettings	changeSessionSettings(JaloSession session)
protected XMLOutputter	createXMLOutputter(Writer writer)
protected void	debug(String message)
protected void	error(String message)
boolean	errorsOccured()
BMECatTagWriter	getBMECatTagWriter()
BMECatWriter.RangedItemProvider	getCategoriesProvider()
CatalogVersion	getCatVersion()
String	getClassificationNumberFormat()
Collection	getClassificationSystemVersions()
int	getCurrentItemsCount()
Currency	getExportCurrency()
Language	getExportLang()
Map	getHybris2bmecatMediaMap()
Map	getPriceMapping()
BMECatWriter.RangedItemProvider	getProductsProvider()
Customer	getReferenceCustomer()
Date	getReferenceDate()
int	getTotalItemsCount()
EnumerationValue	getTransactionMode()
boolean	ignoreErrors()
protected void	info(String message)
protected boolean	isDebugEnabled()
protected boolean	isErrorEnabled()
protected boolean	isInfoEnabled()
boolean	isUDPNet()
protected boolean	isWarnEnabled()
void	setCategoriesProvider(BMECatWriter.RangedItemProvider categoriesProvider) Here you can specify the categories that you want to export.
void	setProductsProvider(BMECatWriter.RangedItemProvider productsProvider) Here you can specify the products that you want to export.
boolean	suppressEmptyCategories()
boolean	suppressProductsWithoutPrices()
protected void	warn(String message)
void	write(Writer writer) Writes a BMECat catalog to the given Writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BMECatWriter

public BMECatWriter(CatalogVersion catVersion,
                    EnumerationValue transactionMode,
                    Collection classificationSystemVersions,
                    Language exportLang,
                    Map hybris2bmecatMediaMap,
                    Media exportedMedias,
                    Map priceMapping,
                    boolean udpNet,
                    Date refDate,
                    Customer refCustomer,
                    Currency exportCurrency,
                    boolean ignoreErrors,
                    boolean suppressEmptyCategories,
                    boolean suppressProductsWithoutPrices,
                    String classificationNumberFormat)

Constructs an BMECatWriter.

Parameters:

catVersion - CatalogVersion that should be exported

transactionMode - the BMECat mode that should be exported

classificationSystemVersions - a Collection of ClassificationSystemVersions that should be exported

exportLang - the Language of the BMECat export

Method Detail

isInfoEnabled

protected boolean isInfoEnabled()

isDebugEnabled

protected boolean isDebugEnabled()

isWarnEnabled

protected boolean isWarnEnabled()

isErrorEnabled

protected boolean isErrorEnabled()

info

protected void info(String message)

debug

protected void debug(String message)

warn

protected void warn(String message)

error

protected void error(String message)

getClassificationNumberFormat

public String getClassificationNumberFormat()

suppressEmptyCategories

public boolean suppressEmptyCategories()

suppressProductsWithoutPrices

public boolean suppressProductsWithoutPrices()

getReferenceCustomer

public Customer getReferenceCustomer()

isUDPNet

public boolean isUDPNet()

ignoreErrors

public boolean ignoreErrors()

getExportCurrency

public Currency getExportCurrency()

errorsOccured

public boolean errorsOccured()

createXMLOutputter

protected XMLOutputter createXMLOutputter(Writer writer)
                                   throws IllegalStateException,
                                          IllegalArgumentException,
                                          IOException

Throws:

IllegalStateException

IllegalArgumentException

IOException

getReferenceDate

public Date getReferenceDate()

changeSessionSettings

protected BMECatWriter.SessionSettings changeSessionSettings(JaloSession session)

write

public void write(Writer writer)
           throws IOException

Writes a BMECat catalog to the given Writer.

Parameters:

writer - the Writer the export should be written to

Throws:

IOException

getTotalItemsCount

public int getTotalItemsCount()

getCurrentItemsCount

public int getCurrentItemsCount()

getBMECatTagWriter

public BMECatTagWriter getBMECatTagWriter()

Returns:

the BMECatTagWriter from there you have access to all subwriters

getCategoriesProvider

public BMECatWriter.RangedItemProvider getCategoriesProvider()

Returns:

the provider of the categories to export or null if not set

setCategoriesProvider

public void setCategoriesProvider(BMECatWriter.RangedItemProvider categoriesProvider)

Here you can specify the categories that you want to export. If you don't specify an RangedItemProvider here, all categories of the selected CatalogVersion will be exported.

Parameters:

categoriesProvider - the RangedItemProvider for the categories to export

getProductsProvider

public BMECatWriter.RangedItemProvider getProductsProvider()

Returns:

the provider of the products to export or null if not set

setProductsProvider

public void setProductsProvider(BMECatWriter.RangedItemProvider productsProvider)

Here you can specify the products that you want to export. If you don't specify an RangedItemProvider here, all products of the selected CatalogVersion will be exported.

Parameters:

productsProvider - the RangedItemProvider for the products to export

getCatVersion

public CatalogVersion getCatVersion()

Returns:

Returns the catVersion.

getClassificationSystemVersions

public Collection getClassificationSystemVersions()

Returns:

Returns the classificationSystemVersions.

getExportLang

public Language getExportLang()

Returns:

Returns the exportLang.

getTransactionMode

public EnumerationValue getTransactionMode()

Returns:

Returns the transactionMode.

getHybris2bmecatMediaMap

public Map getHybris2bmecatMediaMap()

Returns:

Returns the hybris2bmecatMediaMap.

getPriceMapping

public Map getPriceMapping()

Returns:

Returns the price mapping map.