Class HeatmapDataValueObject.RowMeta

java.lang.Object
ubic.gemma.rest.HeatmapDataValueObject.RowMeta
Enclosing class:
HeatmapDataValueObject
public static class HeatmapDataValueObject.RowMeta extends Object
Author:
claude

  • Constructor Details

    • RowMeta

      public RowMeta()

  • Method Details

    • getDesignElementId

      @Nullable public Long getDesignElementId()

    • getDesignElementName

      @Nullable public String getDesignElementName()

    • getGenes

      @Nullable public List<HeatmapDataValueObject.GeneRef> getGenes()
      Genes mapped to this probe. Each entry carries the official symbol, full gene name and stable Gemma ID — the client uses the ID to build a deep link to the gene page. null / empty when there is no gene mapping or the producer didn't attach gene info.

    • getPvalue

      @Nullable public Double getPvalue()
      Differential-expression p-value, or any single per-row numeric statistic the producer wants the client to know. null when not applicable.

    • getValidated

      @Nullable public Boolean getValidated()
      Diffex "validated" highlight flag. null on non-diffex requests.

    • getRankByMean

      @Nullable public Double getRankByMean()
      Stored expression-level rank of this probe's vector, by mean and by max, in [0, 1].

      🛑 Experiment-scoped, not request-scoped. Both are computed over the whole experiment when the vectors are processed, and are reported unchanged when a subset narrows the column axis — so on a subset request the rank describes the full experiment while the matrix beside it does not. That makes them the right input for "is this probe generally expressed in this study" and the wrong one for ordering the rows actually returned; a client wanting the latter should compute it over the columns it received.

      null on paths that do not carry processed vectors.

    • getRankByMax

      @Nullable public Double getRankByMax()

    • getAnnotations

      @Nullable public Map<String,Object> getAnnotations()
      Free-form, gene-shaped annotation bag. Keys are short, client-visible labels; values are primitives the client will display alongside the row: Number for numeric stats (e.g. logFC, FDR, rank), String for categorical labels (e.g. module="purple"), Boolean for flags (e.g. isMultifunctional). The client renders numeric values as small bars, categories as chips, booleans as ticks. Producers should leave the map null or omit unwanted keys; the client tolerates any subset.

    • setDesignElementId

      public void setDesignElementId(@Nullable Long designElementId)

    • setDesignElementName

      public void setDesignElementName(@Nullable String designElementName)

    • setGenes

      public void setGenes(@Nullable List<HeatmapDataValueObject.GeneRef> genes)
      Genes mapped to this probe. Each entry carries the official symbol, full gene name and stable Gemma ID — the client uses the ID to build a deep link to the gene page. null / empty when there is no gene mapping or the producer didn't attach gene info.

    • setPvalue

      public void setPvalue(@Nullable Double pvalue)
      Differential-expression p-value, or any single per-row numeric statistic the producer wants the client to know. null when not applicable.

    • setValidated

      public void setValidated(@Nullable Boolean validated)
      Diffex "validated" highlight flag. null on non-diffex requests.

    • setRankByMean

      public void setRankByMean(@Nullable Double rankByMean)
      Stored expression-level rank of this probe's vector, by mean and by max, in [0, 1].

      🛑 Experiment-scoped, not request-scoped. Both are computed over the whole experiment when the vectors are processed, and are reported unchanged when a subset narrows the column axis — so on a subset request the rank describes the full experiment while the matrix beside it does not. That makes them the right input for "is this probe generally expressed in this study" and the wrong one for ordering the rows actually returned; a client wanting the latter should compute it over the columns it received.

      null on paths that do not carry processed vectors.

    • setRankByMax

      public void setRankByMax(@Nullable Double rankByMax)

    • setAnnotations

      public void setAnnotations(@Nullable Map<String,Object> annotations)
      Free-form, gene-shaped annotation bag. Keys are short, client-visible labels; values are primitives the client will display alongside the row: Number for numeric stats (e.g. logFC, FDR, rank), String for categorical labels (e.g. module="purple"), Boolean for flags (e.g. isMultifunctional). The client renders numeric values as small bars, categories as chips, booleans as ticks. Producers should leave the map null or omit unwanted keys; the client tolerates any subset.