gov.nih.nci.caarray.external.v1_0.query
Class BiomaterialSearchCriteria
java.lang.Object
gov.nih.nci.caarray.external.v1_0.query.BiomaterialSearchCriteria
- All Implemented Interfaces:
- java.io.Serializable
public class BiomaterialSearchCriteria
- extends java.lang.Object
- implements java.io.Serializable
A BiomaterialSearchCriteria specifies a set of criterions against which Biomaterials are matched.
Each non-null or non-empty (in case of collections) field represents a distinct criterion; a biomaterial must
match all of them in order to match the whole Criteria.
- Author:
- dkokotov
- See Also:
- Serialized Form
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BiomaterialSearchCriteria
public BiomaterialSearchCriteria()
getNames
public java.util.Set<java.lang.String> getNames()
- Returns:
- a Set of names. A Biomaterial's name must be one of the names in this set in order to match.
setNames
public void setNames(java.util.Set<java.lang.String> names)
- Parameters:
names
- the names to set
getTypes
public java.util.Set<BiomaterialType> getTypes()
- Returns:
- a Set of BiomaterialTypes. A Biomaterial must be of one of the types in this set in order to match.
setTypes
public void setTypes(java.util.Set<BiomaterialType> types)
- Parameters:
types
- the types to set
getExperiment
public CaArrayEntityReference getExperiment()
- Returns:
- a reference to an Experiment. A Biomaterial must belong to this experiment in order to match.
setExperiment
public void setExperiment(CaArrayEntityReference experiment)
- Parameters:
experiment
- the experiment to set
getExternalIds
public java.util.Set<java.lang.String> getExternalIds()
- Returns:
- a Set of external ids. A Biomaterial's external id must be one of the ids in this set in order to match.
setExternalIds
public void setExternalIds(java.util.Set<java.lang.String> externalIds)
- Parameters:
externalIds
- the externalIds to set
getAnnotationCriterions
public java.util.Set<AnnotationCriterion> getAnnotationCriterions()
- Returns the Set of AnnotationCriterions to match the Biomaterial against. To determine if a Biomaterial matches,
all the AnnotationCriterions of the same category are OR-ed together, while AnnotationCriterions of different
categories are AND-ed together.
For example, suppose you have the following AnnotationCriterions:
- {category=OrganismPart value=Brain}
- {category=OrganismPart value=Skin}
- {category=DiseaseState value=AbcCarcinoma}
This will search for biomaterials with an organism part(tissue site) of either Brain or Skin, and a disease state
of AbcCarcinoma.
- Returns:
- a Set of AnnotationCriterions.
setAnnotationCriterions
public void setAnnotationCriterions(java.util.Set<AnnotationCriterion> annotationCriterions)
- Parameters:
annotationCriterions
- the annotationCriterions to set