Package com._1c.g5.v8.dt.export.xml

Interface IExporter

All Known Implementing Classes:
AdditionalIndexesXmlExporter, AggregatesXmlExporter, BasicCommandXmlExporter, BasicExporter, CaiXmlExporter, CmiExtensionXmlExporter, CmiXmlExporter, CommonPictureXmlExporter, EmptyRoleDescriptionXmlExporter, ExchangePlanXmlExporter, FlowchartXmlExporter, FormExtensionXmlExporter, FormXmlExporter, GeographicalSchemaXmlExporter, GeographicalSchemaXmlExtensionExporter, HpwaXmlExporter, MetadataHelpXmlExporter, MetadataPictureXmlExporter, MetadataXmlExporter, ModuleExporter, ParentConfigurationsBinaryExporter, PredefinedXmlExporter, RightsXmlExporter, ScheduleXmlExporter, StandaloneConfiguratuinContentXmlExporter, StyleXmlExporter, TemplateXmlExporter, WsReferenceXmlExporter, XdtoExporter, XDTOPackageXmlExporter
public interface IExporter
Exporter of specific objects group.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EXPORTER_TRACE_OPTION
    Trace option constant for xml exporting

  • Method Summary

    Modifier and Type
    Method
    Description
    default Path
    getOutputPath(org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature feature, Version version)
    Get path to export object.
    Path
    getOutputPath(org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature feature, String fileExtension, Version version)
    Get path to export object.
    boolean
    isAppropriate(Version version, org.eclipse.emf.ecore.EObject eObject)
    Determines exporter corresponds to the file and version.
    org.eclipse.core.runtime.IStatus
    work(org.eclipse.emf.ecore.EObject eObject, IExportContext exportContext, IExportArtifactBuilder artifactBuilder, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
    Method to build export of file in target folder.

  • Field Details

    • EXPORTER_TRACE_OPTION

      static final String EXPORTER_TRACE_OPTION
      Trace option constant for xml exporting
      See Also:

  • Method Details

    • isAppropriate

      boolean isAppropriate(Version version, org.eclipse.emf.ecore.EObject eObject)
      Determines exporter corresponds to the file and version.
      Parameters:
      version - the version of 1C:Enterprise not null
      eObject - the object for export not null
      Returns:
      true if exporter can do work to this file and version, false if not

    • work

      org.eclipse.core.runtime.IStatus work(org.eclipse.emf.ecore.EObject eObject, IExportContext exportContext, IExportArtifactBuilder artifactBuilder, org.eclipse.core.runtime.IProgressMonitor progressMonitor) throws ExportException
      Method to build export of file in target folder.
      Parameters:
      eObject - the object for export, not null
      exportContext - the static data for export, not null
      artifactBuilder - the artifact builder, not null
      progressMonitor - ui process monitor, not null
      Returns:
      IStatus of export work result, never null
      Throws:
      ExportException - if export processing errors

    • getOutputPath

      default Path getOutputPath(org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature feature, Version version) throws ExportException
      Get path to export object.
      Parameters:
      eObject - the export object, not null
      feature - the reference to child object, can be null
      version - the 1C:Runtime version, cannot be null
      Returns:
      the export path for this object or null if exporter not support this object
      Throws:
      ExportException - if export processing errors

    • getOutputPath

      Path getOutputPath(org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature feature, String fileExtension, Version version) throws ExportException
      Get path to export object.
      Parameters:
      eObject - the export object, not null
      feature - the reference to child object, can be null
      fileExtension - the output file extension, can be null
      version - the 1C:Runtime version, cannot be null
      Returns:
      the export path for this object or null if exporter not support this object
      Throws:
      ExportException - if export processing errors