Package com.hybris.cockpitng.dataquality

Interface DataQualityCalculationService

  • public interface DataQualityCalculationService
    This service provides functionality to calculate the state of an item in terms of data coverage. An item (e.g. Product) with lot of unfilled important attributes has low coverage. An item with all important attributes filled with correct data has high coverage. How this coverage information is calculated, which attributes are taking into account and if semantic of the data is considered as well is up to the implementation.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Optional<DataQuality> calculate​(java.lang.Object object, java.lang.String domainId)
      Calculates the coverage of the given object.
      java.util.Optional<DataQuality> calculate​(java.lang.Object object, java.lang.String templateCode, java.lang.String domainId)
      Calculates the coverage of the given object.

    • Method Detail

      • calculate

        java.util.Optional<DataQuality> calculate​(java.lang.Object object,
                                          java.lang.String domainId)
        Calculates the coverage of the given object. The domainId can be used to distinguish between multiple coverage calculation strategies per domain (e.g. text translation coverage, print related coverage etc.)
        Parameters:
        object - the object to calculate the coverage for
        domainId - the domain Id if applicable
        Returns:
        the Optional<DataQuality> object with cumulated coverage information or Optional.empty() value if no strategy was registered for given object and domain ID

      • calculate

        java.util.Optional<DataQuality> calculate​(java.lang.Object object,
                                          java.lang.String templateCode,
                                          java.lang.String domainId)
        Calculates the coverage of the given object. The domainId can be used to distinguish between multiple coverage calculation strategies per domain (e.g. text translation coverage, print related coverage etc.)
        Parameters:
        object - the object to calculate the coverage for
        templateCode - the object template to be used for finding the proper calculation strategy
        domainId - the domain Id if applicable
        Returns:
        the Optional<DataQuality> object with cumulated coverage information or Optional.empty() if no strategy was registered for given object and domain ID