Class ExperimentalFactorValueObject

java.lang.Object
ubic.gemma.model.common.IdentifiableValueObject<ExperimentalFactor>
ubic.gemma.model.expression.experiment.ExperimentalFactorValueObject
All Implemented Interfaces:
Serializable, Identifiable
public class ExperimentalFactorValueObject extends IdentifiableValueObject<ExperimentalFactor>
Author:
luke, keshav
See Also:

  • Constructor Details

    • ExperimentalFactorValueObject

      public ExperimentalFactorValueObject()
      Required when using the class as a spring bean.

    • ExperimentalFactorValueObject

      public ExperimentalFactorValueObject(Long id)

    • ExperimentalFactorValueObject

      public ExperimentalFactorValueObject(ExperimentalFactor factor)

    • ExperimentalFactorValueObject

      public ExperimentalFactorValueObject(ExperimentalFactor factor, boolean includeValues)
      Parameters:
      includeValues - whether to include factor values or not in the serialization

  • Method Details

    • getNumValues

      public int getNumValues()
      Number of factor values.

    • getName

      public String getName()

    • getDescription

      public String getDescription()

    • getType

      public String getType()

    • getCategory

      public String getCategory()

    • getCategoryUri

      public String getCategoryUri()

    • getBaselineRelevance

      @Nullable public String getBaselineRelevance()
      Curator/agent hint about baseline relevance. Mirrors the curation-ui Factor.baseline_relevance field. "required", "not_applicable" and "uncertain" are the values in use; null when the curation pipeline has not set it.

      The list is documented and not enforced. It used to be a closed allowableValues set, which a generated client turns into an enum that fails to deserialize the first response carrying a word the vocabulary has since gained — and this one has moved once already. The write side (DatasetsWebService.FactorCommit.baselineRelevance) accepts an unfamiliar value rather than 400ing it, so advertising a closed set here would promise a constraint the server does not keep.

    • getBaselineRelevanceReason

      @Nullable public String getBaselineRelevanceReason()
      Free-text rationale paired with baselineRelevance. null when unset.

    • getFactorValues

      @Deprecated @Nullable public String getFactorValues()
      Deprecated.

    • getValues

      @Nullable public Collection<FactorValueValueObject> getValues()

    • setName

      public void setName(String name)

    • setDescription

      public void setDescription(String description)

    • setType

      public void setType(String type)

    • setCategory

      public void setCategory(String category)

    • setCategoryUri

      public void setCategoryUri(String categoryUri)

    • setBaselineRelevance

      public void setBaselineRelevance(@Nullable String baselineRelevance)
      Curator/agent hint about baseline relevance. Mirrors the curation-ui Factor.baseline_relevance field. "required", "not_applicable" and "uncertain" are the values in use; null when the curation pipeline has not set it.

      The list is documented and not enforced. It used to be a closed allowableValues set, which a generated client turns into an enum that fails to deserialize the first response carrying a word the vocabulary has since gained — and this one has moved once already. The write side (DatasetsWebService.FactorCommit.baselineRelevance) accepts an unfamiliar value rather than 400ing it, so advertising a closed set here would promise a constraint the server does not keep.

    • setBaselineRelevanceReason

      public void setBaselineRelevanceReason(@Nullable String baselineRelevanceReason)
      Free-text rationale paired with baselineRelevance. null when unset.

    • setFactorValues

      @Deprecated public void setFactorValues(@Nullable String factorValues)
      Deprecated.

    • setValues

      public void setValues(@Nullable Collection<FactorValueValueObject> values)

    • toString

      public String toString()
      Overrides:
      toString in class IdentifiableValueObject<ExperimentalFactor>