de.xima.fc.exporter

Class AEntityExporter<T extends de.xima.cmn.dao.interfaces.IEntity<Long>>

java.lang.Object

de.xima.fc.exporter.AEntityExporter<T>

All Implemented Interfaces:

IEntityExporter<T>

Direct Known Subclasses:

ProjectExporter, TemplateExporter

public abstract class AEntityExporter<T extends de.xima.cmn.dao.interfaces.IEntity<Long>>
extends Object
implements IEntityExporter<T>

Abstract base class for entity exporters

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<de.xima.cmn.dao.interfaces.IEntity<Long>,Boolean>	dependencies
protected T	entity
static String	EXPORT_PROCESSING_VERSION
static String	FC_EXPORT_METADATA
protected static org.slf4j.Logger	LOG
protected static String	LOG_PREFIX
protected Benutzer	user

Constructor Summary

Constructors

Constructor and Description
AEntityExporter(IEntityContext ec, T... entities) Deprecated.
AEntityExporter(IEntityContext ec, T entity)
AEntityExporter(IEntityContext ec, T entity, boolean withoutDependencies)

Method Summary

Modifier and Type	Method and Description
List<DeserializedEntity>	doExport(IEntityContext ec)
File	doExport(IEntityContext ec, File outDir, Benutzer user) Exports the set entities to the given directory
Map<de.xima.cmn.dao.interfaces.IEntity<Long>,Boolean>	getDependencies()
List<T>	getEntities() Deprecated. Use getEntity() isntead.
T	getEntity()
protected void	initDependencies(IEntityContext ec)
protected void	initInternalDependenciesOnly(IEntityContext ec)
IEntityExporter<T>	withCompatitbiltyMode(boolean compatitbiltyMode)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

LOG_PREFIX

protected static final String LOG_PREFIX

See Also:

Constant Field Values

EXPORT_PROCESSING_VERSION

public static final String EXPORT_PROCESSING_VERSION

See Also:

Constant Field Values

FC_EXPORT_METADATA

public static final String FC_EXPORT_METADATA

See Also:

Constant Field Values

entity

protected T extends de.xima.cmn.dao.interfaces.IEntity<Long> entity

dependencies

protected Map<de.xima.cmn.dao.interfaces.IEntity<Long>,Boolean> dependencies

user

protected Benutzer user

Constructor Detail

AEntityExporter

public AEntityExporter(IEntityContext ec,
                       T entity)

AEntityExporter

public AEntityExporter(IEntityContext ec,
                       T entity,
                       boolean withoutDependencies)

AEntityExporter

@Deprecated
public AEntityExporter(IEntityContext ec,
                                   T... entities)

Deprecated.

use AEntityExporter(IEntityContext, IEntity) instead

Method Detail

withCompatitbiltyMode

public IEntityExporter<T> withCompatitbiltyMode(boolean compatitbiltyMode)

Specified by:

withCompatitbiltyMode in interface IEntityExporter<T extends de.xima.cmn.dao.interfaces.IEntity<Long>>

Parameters:

compatitbiltyMode - Boolean whether or not entities should be exportedt in compatibility mode

Returns:

IEntityExporter the exporter

doExport

public List<DeserializedEntity> doExport(IEntityContext ec)
                                  throws Exception

Throws:

Exception

doExport

public File doExport(IEntityContext ec,
                     File outDir,
                     Benutzer user)
              throws Exception

Description copied from interface: IEntityExporter

Exports the set entities to the given directory

Specified by:

doExport in interface IEntityExporter<T extends de.xima.cmn.dao.interfaces.IEntity<Long>>

outDir - File to export files to

user - Benutzer to export the entities for

Returns:

File export file

Throws:

Exception

getEntity

public T getEntity()

Specified by:

getEntity in interface IEntityExporter<T extends de.xima.cmn.dao.interfaces.IEntity<Long>>

Returns:

entity that should be exported

getEntities

@Deprecated
public List<T> getEntities()

Deprecated. Use getEntity() isntead.

Specified by:

getEntities in interface IEntityExporter<T extends de.xima.cmn.dao.interfaces.IEntity<Long>>

getDependencies

public Map<de.xima.cmn.dao.interfaces.IEntity<Long>,Boolean> getDependencies()

initInternalDependenciesOnly

protected void initInternalDependenciesOnly(IEntityContext ec)

initDependencies

protected void initDependencies(IEntityContext ec)