Package de.espirit.firstspirit.feature

Interface FeatureAnalyseResult

All Superinterfaces:
Serializable
public interface FeatureAnalyseResult extends Serializable
Definition representing the result of a feature analyze process.
The analyze result provides information about problems which could appear during the installation of a feature. First of all the error count indicates whether the related feature transport file is installable or not.
Since:
5.0.111
See Also:

  • Method Details

    • getElementCount

      int getElementCount()
      Returns the count of elements (non data records) contained in this feature.
      Since:
      5.0.111
      See Also:

    • getDatarecordsCount

      Map<String,Integer> getDatarecordsCount()
      Returns a mapping of schema uid to count of data records contained in this feature.
      Since:
      5.0.111
      See Also:

    • getErrorsCount

      int getErrorsCount()
      Returns the error count of this feature analyze result. If count > 0 the belonging feature transport file is not installable. Therefore calling FeatureInstallAgent.installFeature(FeatureFile, Map) will throw an exception.
      Since:
      5.0.111
      See Also:

    • getWarningCount

      int getWarningCount()
      Returns the warning count of this analyze result. If count > 0 the belonging feature transport file will cause some problems during the installation. Possible problems causing warnings:
      • missing optional references which couldn't be mapped to target nodes
      • differences between source and target project (e.g. languages, resolutions or templatesets)
      Since:
      5.0.111
      See Also:

    • getGlobalErrors

      @NotNull @NotNull List<FeatureError> getGlobalErrors()
      Returns the list of global errors. Global errors could be for example languages, resolutions or templatesets which exists in the source project but not in the target project.
      Since:
      5.0.111

    • getEntryErrors

      @NotNull @NotNull Map<Long,List<FeatureError>> getEntryErrors()
      Returns the feature errors of this analyze result.
      Since:
      5.0.111

    • getServerName

      String getServerName()
      The name of the source FirstSpirit server the feature transport file was created on.
      Since:
      5.0.111

    • getServerVersion

      ServerInformationAgent.VersionInfo getServerVersion()
      The version of the FirstSpirit server the feature transport file was created on.
      Since:
      5.0.111

    • getProjectName

      String getProjectName()
      The name of the source project the feature transport file was created in.
      Since:
      5.0.111

    • getRevisionTime

      Date getRevisionTime()
      The time of the revision the feature transport file belongs to.
      Since:
      5.0.111
      See Also:

    • getMappedLayers

      @NotNull @NotNull Map<String,String> getMappedLayers()
      Mapping of layer names (key = layer name in source project; value = layer name in target project). This map will be filled in case updates to schema nodes.
      Since:
      5.0.111
      See Also:

    • getUnmappedLayers

      @NotNull @NotNull List<String> getUnmappedLayers()
      List of layer names of the source project which exists in the feature because of schema nodes or datarecords which couldn't be mapped to existing layers in target project. Normally this will happen, when the schema transported via the feature transport file doesn't exist in the target project and will be created during the installation.
      The mapping for these layers must be passed as parameter to the install call.
      Since:
      5.0.111
      See Also: