Package edu.cmu.tetrad.search.blocks

Class LatentNameAssigner.Config

java.lang.Object
edu.cmu.tetrad.search.blocks.LatentNameAssigner.Config
Enclosing class:
LatentNameAssigner
public static final class LatentNameAssigner.Config extends Object
A Config instance with the current builder's configuration settings.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    LatentNameAssigner.Config.Builder
    Builder class for constructing instances of the Config class with customizable properties.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final boolean
    collapseTrailingCap
    A configuration flag that determines whether trailing capital letters following a digit in mixed alphanumeric strings should be collapsed during processing.
    final String
    defaultMixedName
    Represents the default name used for blocks when no match is identified.
    final boolean
    keepReservedLiteral
    Indicates whether reserved literals should be retained in their original form when processing or transforming text or structures.
    final int
    maxOverlapParts
    Specifies the maximum number of overlapping true clusters to display.
    final String
    numericSep
    Represents the separator used for numeric disambiguation in configurations.
    final String
    overflowPrefix
    Represents the prefix string to be applied when the configured overlap or part limit is exceeded.
    final String
    overlapJoiner
    Specifies the string used to join parts in cases of overlap within a configuration.
    final Set<String>
    reservedLiteralNames
    A set of reserved literal names that must be preserved as-is during processing.
    final boolean
    showOverflowCount
    Indicates whether to display the count of overflow items in a concatenated string.

  • Method Summary

    Modifier and Type
    Method
    Description
    static LatentNameAssigner.Config.Builder
    builder()
    Creates and returns a new instance of the Builder class initialized with default configuration values.
    static LatentNameAssigner.Config
    defaults()
    Creates and returns a new instance of the Config class initialized with default configuration values.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • maxOverlapParts

      public final int maxOverlapParts
      Specifies the maximum number of overlapping true clusters to display.

      This value determines how many concurrent overlaps in data clusters will be visually represented or processed in certain contexts.

    • showOverflowCount

      public final boolean showOverflowCount
      Indicates whether to display the count of overflow items in a concatenated string. If set to true, an additional count (e.g., "+N more") is appended to denote the number of overflow elements that cannot be displayed within the specified limit.

    • overlapJoiner

      public final String overlapJoiner
      Specifies the string used to join parts in cases of overlap within a configuration. It defines a delimiter that is applied when multiple components need to be combined and overlap resolution is required.

    • overflowPrefix

      public final String overflowPrefix
      Represents the prefix string to be applied when the configured overlap or part limit is exceeded. Typically used to indicate an overflow condition in generated or processed output.

      This value allows customization of how overflows are marked, providing flexibility in format representation.

    • defaultMixedName

      public final String defaultMixedName
      Represents the default name used for blocks when no match is identified. This variable is part of the configuration settings for managing naming behavior in scenarios where specific identifiers are unavailable or not applicable.

    • collapseTrailingCap

      public final boolean collapseTrailingCap
      A configuration flag that determines whether trailing capital letters following a digit in mixed alphanumeric strings should be collapsed during processing.

    • numericSep

      public final String numericSep
      Represents the separator used for numeric disambiguation in configurations. It is commonly utilized to denote a boundary or separation for numeric values, such as the inclusion of a dash ("-") in certain contexts.

    • reservedLiteralNames

      public final Set<String> reservedLiteralNames
      A set of reserved literal names that must be preserved as-is during processing. This collection typically includes predefined strings or values that should not be altered or replaced. It can be useful in scenarios where specific keywords or identifiers need to remain intact, ensuring they retain their intended meaning or function.

    • keepReservedLiteral

      public final boolean keepReservedLiteral
      Indicates whether reserved literals should be retained in their original form when processing or transforming text or structures. If set to true, the reserved literals will not be altered or replaced during processing. If set to false, reserved literals may be modified based on the processing logic.

  • Method Details

    • defaults

      public static LatentNameAssigner.Config defaults()
      Creates and returns a new instance of the Config class initialized with default configuration values.
      Returns:
      a Config instance preconfigured with default settings, including default values for maxOverlapParts, showOverflowCount, overlapJoiner, overflowPrefix, defaultMixedName, collapseTrailingCap, numericSep, reservedLiteralNames, and keepReservedLiteral properties.

    • builder

      public static LatentNameAssigner.Config.Builder builder()
      Creates and returns a new instance of the Builder class initialized with default configuration values.
      Returns:
      a new Builder instance preconfigured with the default configuration properties of the Config class.