Package ubic.gemma.model.common.description

Class Characteristic

    • Constructor Detail

      • Characteristic

        public Characteristic()
        No-arg constructor added to satisfy javabean contract

    • Method Detail

      • getComparator

        public static Comparator<Characteristic> getComparator()
        Obtain a full comparator for characteristics that fallbacks on the ID if everything else is equal.

        The following fields are compared: category, value, ID.

      • getByCategoryComparator

        public static Comparator<Characteristic> getByCategoryComparator()
        Obtain a comparator to compare terms by category URI (or category if null) in a case-insensitive manner.

        Two terms that are equal in terms of category will be collapsed if using a TreeSet.

        Use this if you want to get a summary of the categories used by a collection of terms irrespective of their IDs.

      • getByCategoryAndValueComparator

        public static Comparator<Characteristic> getByCategoryAndValueComparator()
        Obtain a comparator to order terms by value URI (or value if null) in a case-insensitive manner.

        Two terms that are equal in terms of category and value (i.e. sharing the same ID) will be collapsed if using a TreeSet.

        Use this if you want to get a summary of the annotations used by a collection of terms irrespective of their IDs.

      • getCategory

        @Field
@Nullable
public String getCategory()
        Returns:
        either the human readable form of the classUri or a free text version if no classUri exists

      • getCategoryUri

        @Nullable
@Field(analyze=NO)
public String getCategoryUri()
        Returns:
        The URI of the class that this is an instance of. Will only be different from the termUri when the class is effectively abstract, and this is a concrete instance. By putting the abstract class URI in the object we can more readily group together Characteristics that are instances of the same class. For example: If the classUri is "Sex", then the termUri might be "male" or "female" for various instances. Otherwise, the classUri and the termUri can be the same; for example, for "Age", if the "Age" is defined through its properties declared as associations with this.

      • setCategoryUri

        public void setCategoryUri​(@Nullable
                           String categoryUri)

      • setEvidenceCode

        public void setEvidenceCode​(GOEvidenceCode evidenceCode)

      • getOriginalValue

        @Nullable
public String getOriginalValue()
        Returns:
        the originalValue

      • setOriginalValue

        public void setOriginalValue​(@Nullable
                             String originalValue)

      • getValue

        @Field
public String getValue()
        Returns:
        The human-readable term (e.g., "OrganismPart"; "kinase")

      • setValue

        public void setValue​(String value)

      • getValueUri

        @Nullable
@Field(analyze=NO)
public String getValueUri()
        Returns:
        This can be a URI to any resources that describes the characteristic. Often it might be a URI to an OWL ontology term. If the URI is an instance of an abstract class, the classUri should be filled in with the URI for the abstract class.

      • isMigratedToStatement

        @Deprecated
public boolean isMigratedToStatement()
        Deprecated.

      • setMigratedToStatement

        @Deprecated
public void setMigratedToStatement​(boolean migratedToStatement)
        Deprecated.

      • equals

        public boolean equals​(Object object)
        Description copied from class: AbstractDescribable
        Returns true if the argument is an Describable instance and all identifiers for this entity equal the identifiers of the argument entity. Returns false otherwise.
        Overrides:
        equals in class AbstractDescribable