Package com.intellij.internal.statistic.eventLog.validator.rules.beans

Class DataValidationRules

  • Direct Known Subclasses:
    EventGroupRules
    public class DataValidationRules
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected DataValidationRules​(@NotNull ValidationSimpleRuleFactory factory, @Nullable java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> eventDataRules, @NotNull EventGroupContextData contextData, @NotNull java.util.List<java.lang.String> excludedFields)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean areEventDataRulesDefined()  
      static @NotNull DataValidationRules create​(@Nullable java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> eventDataRules, @NotNull com.intellij.internal.statistic.eventLog.validator.storage.GlobalRulesHolder globalRulesHolder, @NotNull ValidationSimpleRuleFactory factory, @NotNull java.util.List<java.lang.String> excludedFields)  
      java.util.Map<java.lang.String,​FUSRule[]> getEventDataRules()  
      com.intellij.internal.statistic.eventLog.validator.rules.impl.beans.EventDataField validateData​(@NotNull java.lang.String key, @Nullable java.lang.Object data, @NotNull EventContext context, @NotNull java.lang.String jsonPath)
      Validates the data inside log event.
      com.intellij.internal.statistic.eventLog.validator.rules.impl.beans.EventDataField validateEventData​(@NotNull java.lang.String key, @Nullable java.lang.Object data, @NotNull EventContext context)
      Validates the data for a given event field.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • eventDataRules

        protected final java.util.Map<java.lang.String,​FUSRule[]> eventDataRules

      • myExcludedFields

        protected final java.util.List<java.lang.String> myExcludedFields

    • Constructor Detail

      • DataValidationRules

        protected DataValidationRules​(@NotNull
                              @NotNull ValidationSimpleRuleFactory factory,
                              @Nullable
                              @Nullable java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> eventDataRules,
                              @NotNull
                              @NotNull EventGroupContextData contextData,
                              @NotNull
                              @NotNull java.util.List<java.lang.String> excludedFields)

    • Method Detail

      • create

        @NotNull
public static @NotNull DataValidationRules create​(@Nullable
                                                  @Nullable java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> eventDataRules,
                                                  @NotNull
                                                  @NotNull com.intellij.internal.statistic.eventLog.validator.storage.GlobalRulesHolder globalRulesHolder,
                                                  @NotNull
                                                  @NotNull ValidationSimpleRuleFactory factory,
                                                  @NotNull
                                                  @NotNull java.util.List<java.lang.String> excludedFields)

      • validateEventData

        public com.intellij.internal.statistic.eventLog.validator.rules.impl.beans.EventDataField validateEventData​(@NotNull
                                                                                                            @NotNull java.lang.String key,
                                                                                                            @Nullable
                                                                                                            @Nullable java.lang.Object data,
                                                                                                            @NotNull
                                                                                                            @NotNull EventContext context)
        Validates the data for a given event field.
        Parameters:
        key - The name of event field.
        data - The data to be validated.
        context - The event context to store errors.
        Returns:
        validated event data field, incorrect values are replaced with ValidationResultType.getDescription().

      • validateData

        public com.intellij.internal.statistic.eventLog.validator.rules.impl.beans.EventDataField validateData​(@NotNull
                                                                                                       @NotNull java.lang.String key,
                                                                                                       @Nullable
                                                                                                       @Nullable java.lang.Object data,
                                                                                                       @NotNull
                                                                                                       @NotNull EventContext context,
                                                                                                       @NotNull
                                                                                                       @NotNull java.lang.String jsonPath)
        Validates the data inside log event.
        Parameters:
        key - The key used to get the validation rules.
        data - The data to be validated.
        context - The event context to store errors.
        jsonPath - JSON path to validated field inside event, e.g "event.data", "client_data", "system_data", "ids", etc. Used to distinguish error in context.
        Returns:
        validated data, incorrect values are replaced with ValidationResultType.getDescription()

      • areEventDataRulesDefined

        public boolean areEventDataRulesDefined()

      • getEventDataRules

        public java.util.Map<java.lang.String,​FUSRule[]> getEventDataRules()