Package com._1c.g5.v8.dt.core.provider

Interface IResourceContentImporter

All Known Implementing Classes:

BaseSingleEmfResourceObjectImporter, BaseSingleResourceObjectImporter, BinaryResourceContentImporter, CaiResourceContentImporter, CmiResourceContentImporter, GraphicalSchemeBmContentImporter, HpwaResourceContentImporter, ScheduleResourceContentImporter

public interface IResourceContentImporter

Resource content importer.

Implementations should be registered by com._1c.g5.v8.bm.resourceContentImporter extension point. How model merging is performed can be defined by IResourceContentImporter.IMergeStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IResourceContentImporter.IImportTask	Import task.
static interface	IResourceContentImporter.IMergeStrategy	Model to BM model merge strategy

Field Summary

Fields

Modifier and Type	Field	Description
static String	PLATFORM_VERSION	Platform version parameter name.

Method Summary

Modifier and Type	Method	Description
Collection<? extends IResourceContentImporter.IImportTask>	createTasks(Collection<org.eclipse.core.runtime.IPath> affectedPaths)	Creates tasks based on the specified collection of affected (created, modified, deleted) resource paths.
int	getOrder()	Gets importer order.
void	processTask(IBmEngine engine, IBmTransaction transaction, IDtProject project, IResourceContentImporter.IImportTask task, IResourceAccessor resourceAccessor, boolean fullOverride)	Processes the specified import task.
boolean	supports(org.eclipse.core.runtime.IPath path)	Checks if this importer supports the specified resource.

Field Detail

PLATFORM_VERSION

static final String PLATFORM_VERSION

Platform version parameter name. Being transferred as an option during the resource loading

See Also:

Constant Field Values

Method Detail

getOrder

int getOrder()

Gets importer order. The lower the order value is, the earlier tasks created by this importer must be processed.

Returns:

the order value.

supports

boolean supports(org.eclipse.core.runtime.IPath path)

Checks if this importer supports the specified resource.

Parameters:

path - The path to the resource to check. May not be null.

Returns:

true if the resource is supported, false otherwise.

createTasks

Collection<? extends IResourceContentImporter.IImportTask> createTasks(Collection<org.eclipse.core.runtime.IPath> affectedPaths)

Creates tasks based on the specified collection of affected (created, modified, deleted) resource paths. The returned tasks can be processed in parallel. In case the affectedPaths contains unsupported resources the behaviour of this method is not specified.

Parameters:

affectedPaths - The affected resource paths. May not be null.

Returns:

a collection of tasks. Never null.

processTask

void processTask(IBmEngine engine,
                 IBmTransaction transaction,
                 IDtProject project,
                 IResourceContentImporter.IImportTask task,
                 IResourceAccessor resourceAccessor,
                 boolean fullOverride)

Processes the specified import task. In case the task has not been created by this importer, the behaviour of this method is not specified.

Parameters:

engine - The BM engine to import the object into. May not be null.

transaction - The BM transaction to import the object within. May not be null.

project - The project the object belongs to. May not be null.

task - The task. May not be null.

resourceAccessor - The accessor to use to obtain the resource content etc. May not be null.

fullOverride - The flag indicating that the full override strategy rather that merge must be used in case the object already exists.