Record Class DocumentCategorizerConfig

java.lang.Object
java.lang.Record
opennlp.dl.doccat.DocumentCategorizerConfig
Record Components:
id2label - The labels by output index.

public record DocumentCategorizerConfig(Map<String,String> id2label) extends Record
The part of a model configuration that a DocumentCategorizerDL uses: the id2label map of output index to label.
  • Constructor Details

    • DocumentCategorizerConfig

      public DocumentCategorizerConfig(Map<String,String> id2label)
      Creates an instance of a DocumentCategorizerConfig record class.
      Parameters:
      id2label - the value for the id2label record component
  • Method Details

    • id2label

      public Map<String,String> id2label()
      Returns the value of the id2label record component.
      Returns:
      the value of the id2label record component
    • fromJson

      public static DocumentCategorizerConfig fromJson(String json)
      Reads the top-level id2label member of a model configuration, the object that maps each output index to its label in the config.json files that accompany classification models. Keys and labels are decoded from their escapes, and a later entry for the same key overwrites an earlier one. An id2label member nested in another member is not the configuration's map.
      Parameters:
      json - The JSON text of the configuration. Blank text, with or without a leading byte order mark, is a configuration without labels. Must not be null.
      Returns:
      The configuration, with an empty map if the configuration has no top-level id2label member.
      Throws:
      IllegalArgumentException - Thrown if json is null, if the text is neither blank nor a single well-formed JSON object, if id2label is not an object, or if a label is not a string. The message names the offset or the key.
    • 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 Objects::equals(Object,Object).
      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.