Package ubic.gemma.model.common.description

Class CharacteristicValueObject

java.lang.Object
ubic.gemma.model.common.IdentifiableValueObject<Characteristic>
ubic.gemma.model.common.description.CharacteristicValueObject
All Implemented Interfaces:
Serializable, Comparable<CharacteristicValueObject>, Identifiable
public class CharacteristicValueObject extends IdentifiableValueObject<Characteristic> implements Comparable<CharacteristicValueObject>
Value object representation of a Characteristic.
Author:
poirigui
See Also:

  • Field Details

    • valueId

      public String valueId
      A unique ontology identifier (i.e. IRI) for this characteristic.

  • Constructor Details

    • CharacteristicValueObject

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

    • CharacteristicValueObject

      public CharacteristicValueObject(Long id)

    • CharacteristicValueObject

      public CharacteristicValueObject(Characteristic characteristic)

    • CharacteristicValueObject

      public CharacteristicValueObject(String value, @Nullable String valueUri)

    • CharacteristicValueObject

      public CharacteristicValueObject(String value, @Nullable String valueUri, String category, @Nullable String categoryUri)

  • Method Details

    • characteristic2CharacteristicVO

      public static Collection<CharacteristicValueObject> characteristic2CharacteristicVO(Collection<? extends Characteristic> characteristics)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class IdentifiableValueObject<Characteristic>

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class IdentifiableValueObject<Characteristic>

    • compareTo

      public int compareTo(@Nonnull CharacteristicValueObject that)
      Specified by:
      compareTo in interface Comparable<CharacteristicValueObject>

    • toString

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

    • incrementOccurrenceCount

      public void incrementOccurrenceCount()

    • getCategory

      public String getCategory()

    • getCategoryUri

      public String getCategoryUri()

    • getValue

      public String getValue()

    • getValueUri

      public String getValueUri()

    • getOriginalValue

      public String getOriginalValue()

    • getValueId

      public String getValueId()
      A unique ontology identifier (i.e. IRI) for this characteristic.

    • getUrlId

      public String getUrlId()
      id used by url on the client side

    • isAlreadyPresentInDatabase

      public boolean isAlreadyPresentInDatabase()

    • isAlreadyPresentOnGene

      public boolean isAlreadyPresentOnGene()

    • isChild

      public boolean isChild()
      child term from a root

    • getNumTimesUsed

      public int getNumTimesUsed()

    • getOntologyUsed

      public String getOntologyUsed()
      what Ontology uses this term

    • getPrivateGeneCount

      public long getPrivateGeneCount()

    • getPublicGeneCount

      public long getPublicGeneCount()
      number of occurrences in all genes

    • isRoot

      public boolean isRoot()
      root of a query

    • getTaxon

      public String getTaxon()

    • getValueDefinition

      public String getValueDefinition()
      The definition of the value, if it is an ontology term, as supplied by the ontology. If the value is free text, this will be empty

    • setCategory

      public void setCategory(String category)

    • setCategoryUri

      public void setCategoryUri(String categoryUri)

    • setValue

      public void setValue(String value)

    • setValueUri

      public void setValueUri(String valueUri)

    • setOriginalValue

      public void setOriginalValue(String originalValue)

    • setValueId

      public void setValueId(String valueId)
      A unique ontology identifier (i.e. IRI) for this characteristic.

    • setUrlId

      public void setUrlId(String urlId)
      id used by url on the client side

    • setAlreadyPresentInDatabase

      public void setAlreadyPresentInDatabase(boolean alreadyPresentInDatabase)

    • setAlreadyPresentOnGene

      public void setAlreadyPresentOnGene(boolean alreadyPresentOnGene)

    • setChild

      public void setChild(boolean child)
      child term from a root

    • setNumTimesUsed

      public void setNumTimesUsed(int numTimesUsed)

    • setOntologyUsed

      public void setOntologyUsed(String ontologyUsed)
      what Ontology uses this term

    • setPrivateGeneCount

      public void setPrivateGeneCount(long privateGeneCount)

    • setPublicGeneCount

      public void setPublicGeneCount(long publicGeneCount)
      number of occurrences in all genes

    • setRoot

      public void setRoot(boolean root)
      root of a query

    • setTaxon

      public void setTaxon(String taxon)

    • setValueDefinition

      public void setValueDefinition(String valueDefinition)
      The definition of the value, if it is an ontology term, as supplied by the ontology. If the value is free text, this will be empty