Package sc.fiji.snt.analysis.curation

Record Class CurationTags.Partition

java.lang.Object
java.lang.Record
sc.fiji.snt.analysis.curation.CurationTags.Partition
Enclosing class:
CurationTags
public static record CurationTags.Partition(List<Path> positive, List<Path> negative, List<Path> unsure, List<Path> unreviewed) extends Record
Four-bucket breakdown returned by CurationTags.partitionByReviewStatus(Tree). Lists are never null; they may be empty.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Partition(List<Path> positive, List<Path> negative, List<Path> unsure, List<Path> unreviewed)
    Creates an instance of a Partition record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    List<Path>
    negative()
    Returns the value of the negative record component.
    List<Path>
    positive()
    Returns the value of the positive record component.
    int
    reviewed()
    Paths with any review status (i.e. any cur:* tag).
    final String
    toString()
    Returns a string representation of this record class.
    int
    total()
    Total path count across all four buckets.
    List<Path>
    unreviewed()
    Returns the value of the unreviewed record component.
    List<Path>
    unsure()
    Returns the value of the unsure record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Partition

      public Partition(List<Path> positive, List<Path> negative, List<Path> unsure, List<Path> unreviewed)
      Creates an instance of a Partition record class.
      Parameters:
      positive - the value for the positive record component
      negative - the value for the negative record component
      unsure - the value for the unsure record component
      unreviewed - the value for the unreviewed record component

  • Method Details

    • total

      public int total()
      Total path count across all four buckets.

    • reviewed

      public int reviewed()
      Paths with any review status (i.e. any cur:* tag).

    • 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.

    • positive

      public List<Path> positive()
      Returns the value of the positive record component.
      Returns:
      the value of the positive record component

    • negative

      public List<Path> negative()
      Returns the value of the negative record component.
      Returns:
      the value of the negative record component

    • unsure

      public List<Path> unsure()
      Returns the value of the unsure record component.
      Returns:
      the value of the unsure record component

    • unreviewed

      public List<Path> unreviewed()
      Returns the value of the unreviewed record component.
      Returns:
      the value of the unreviewed record component