Package com.inductiveautomation.ignition.common.i18n.translation

Record Class KeyHashRule

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.i18n.translation.KeyHashRule
Record Components:
caseInsensitive - Whether to lowercase the term.
ignoreWS - Whether to remove whitespace.
ignorePunct - Whether to remove punctuation.
ignoreTags - Whether to remove HTML tags.
public record KeyHashRule(boolean caseInsensitive, boolean ignoreWS, boolean ignorePunct, boolean ignoreTags) extends Record
Defines the normalization rules for creating a search key from a source term.

  • Constructor Details

    • KeyHashRule

      public KeyHashRule()

    • KeyHashRule

      public KeyHashRule(boolean caseInsensitive, boolean ignoreWS, boolean ignorePunct, boolean ignoreTags)
      Creates an instance of a KeyHashRule record class.
      Parameters:
      caseInsensitive - the value for the caseInsensitive record component
      ignoreWS - the value for the ignoreWS record component
      ignorePunct - the value for the ignorePunct record component
      ignoreTags - the value for the ignoreTags record component

  • Method Details

    • createDefault

      public static KeyHashRule createDefault()

    • getKey

      public String getKey(String term)
      Generates a normalized hash key for the given term based on the rules.
      Parameters:
      term - The raw source term.
      Returns:
      The normalized "hash key" used for lookups, based on the enabled rules (e.g., lowercased, tags removed).

    • matches

      public boolean matches(String keyA, String keyB)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • caseInsensitive

      public boolean caseInsensitive()
      Returns the value of the caseInsensitive record component.
      Returns:
      the value of the caseInsensitive record component

    • ignoreWS

      public boolean ignoreWS()
      Returns the value of the ignoreWS record component.
      Returns:
      the value of the ignoreWS record component

    • ignorePunct

      public boolean ignorePunct()
      Returns the value of the ignorePunct record component.
      Returns:
      the value of the ignorePunct record component

    • ignoreTags

      public boolean ignoreTags()
      Returns the value of the ignoreTags record component.
      Returns:
      the value of the ignoreTags record component