Package com.commercetools.ml.models.similar_products

Interface SimilarProductPair

public interface SimilarProductPair

A pair of SimilarProducts

Example to create an instance using the builder pattern 

     SimilarProductPair similarProductPair = SimilarProductPair.builder()
             .confidence(0.3)
             .plusProducts(productsBuilder -> productsBuilder)
             .build()

  • Method Details

    • getConfidence

      @NotNull @NotNull Double getConfidence()

      The probability of product similarity.

      Returns:
      confidence

    • getProducts

      @NotNull @Valid @NotNull @Valid List<SimilarProduct> getProducts()
      Returns:
      products

    • setConfidence

      void setConfidence(Double confidence)

      The probability of product similarity.

      Parameters:
      confidence - value to be set

    • setProducts

      void setProducts(SimilarProduct... products)
      set products
      Parameters:
      products - values to be set

    • setProducts

      void setProducts(List<SimilarProduct> products)
      set products
      Parameters:
      products - values to be set

    • of

      static SimilarProductPair of()
      factory method
      Returns:
      instance of SimilarProductPair

    • of

      static SimilarProductPair of(SimilarProductPair template)
      factory method to create a shallow copy SimilarProductPair
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static SimilarProductPair deepCopy(@Nullable SimilarProductPair template)
      factory method to create a deep copy of SimilarProductPair
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static SimilarProductPairBuilder builder()
      builder factory method for SimilarProductPair
      Returns:
      builder

    • builder

      static SimilarProductPairBuilder builder(SimilarProductPair template)
      create builder for SimilarProductPair instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withSimilarProductPair

      default <T> T withSimilarProductPair(Function<SimilarProductPair,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<SimilarProductPair> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference