com.vordel.es.xes

Class ExportEngine

java.lang.Object

com.vordel.es.xes.ExportEngine

public class ExportEngine
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportEngine.Directives

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DIRECTIVE_ADD_IF_ABSENT
static java.lang.String	DIRECTIVE_ADD_OR_REPLACE
static java.lang.String	DIRECTIVE_CUT_BRANCH

Constructor Summary

Constructors

Constructor and Description
ExportEngine(EntityStore store)

Method Summary

Modifier and Type	Method and Description
void	exportContents(java.io.OutputStream out, java.util.Collection<ESPK> rootPKs, int flags)
void	exportContents(java.io.OutputStream out, java.util.Collection<ESPK> rootPKs, int flags, java.util.Set<ESPK> additions, java.util.Set<ESPK> overrides, java.util.Set<PortableESPK> removalBranches) Export the contents of the entity store.
void	exportEntitiesWithImportDirectives(java.io.OutputStream out, java.util.Set<ESPK> startNodes, ExportEngine.Directives d)
protected Entity	retrieveEntity(ESPK pk) Override this method if your instance of the engine has a more efficient way of retrieving the Entity.

Methods inherited from class java.lang.Object

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

Field Detail

DIRECTIVE_ADD_IF_ABSENT

public static final java.lang.String DIRECTIVE_ADD_IF_ABSENT

See Also:

Constant Field Values

DIRECTIVE_ADD_OR_REPLACE

public static final java.lang.String DIRECTIVE_ADD_OR_REPLACE

See Also:

Constant Field Values

DIRECTIVE_CUT_BRANCH

public static final java.lang.String DIRECTIVE_CUT_BRANCH

See Also:

Constant Field Values

Constructor Detail

ExportEngine

public ExportEngine(EntityStore store)

Method Detail

exportEntitiesWithImportDirectives

public void exportEntitiesWithImportDirectives(java.io.OutputStream out,
                                               java.util.Set<ESPK> startNodes,
                                               ExportEngine.Directives d)
                                        throws EntityStoreException

Throws:

EntityStoreException

exportContents

public void exportContents(java.io.OutputStream out,
                           java.util.Collection<ESPK> rootPKs,
                           int flags)
                    throws EntityStoreException

Throws:

EntityStoreException

exportContents

public void exportContents(java.io.OutputStream out,
                           java.util.Collection<ESPK> rootPKs,
                           int flags,
                           java.util.Set<ESPK> additions,
                           java.util.Set<ESPK> overrides,
                           java.util.Set<PortableESPK> removalBranches)
                    throws EntityStoreException

Export the contents of the entity store. The export file with have specific instructions to the importing store to say which Entities should be added if they don't exist in the target store, overridden by those in the import set should they exist, and which Entities should be removed from the target store should they exist there. The additions/ overrides/removalBranches will usually be specified as the result of an analysis of this store w.r.t. another specific store following an analysis with DiffNodes.

Parameters:

out - The OutputStream to export to.

rootPKs - The targeted nodes to export, or null if root.

flags - Export flags affecting what gets exported and how. See EntityStore for values.

additions - Explicitly define the subset of Entities which must be added on import if they don't already exist. This set cannot contain the root PK.

overrides - A set of keys indicating the Entities in this store which will be flagged in the export file for overridding. If an equivalent Entity exists in the target entity store on import, the definition in the import file will replace the one in the target store. This set cannot contain the root PK.

removalBranches - A set of store-neutral keys which will indicate Entities to be cut from the target import store if they exist. The Entity and all its children will be cut from the target store tree, nullifying any references to deleted entities from any remaining Entities in the store. This set cannot contain the root PK.

Throws:

EntityStoreException

retrieveEntity

protected Entity retrieveEntity(ESPK pk)
                         throws EntityStoreException

Override this method if your instance of the engine has a more efficient way of retrieving the Entity.

Parameters:

pk - The Entity's ESPK

Returns:

the Entity identified by the ESPK

Throws:

EntityStoreException