gov.nih.nlm.umls.meta
Interface Coocurrence

All Superinterfaces:
Comparable, ConceptElement, ContentViewElement, RelatedConceptElement, SourceElement
All Known Subinterfaces:
AtomCoocurrence
All Known Implementing Classes:
AtomCoocurrenceImpl, CoocurrenceImpl

public interface Coocurrence
extends Comparable, ConceptElement, ContentViewElement, RelatedConceptElement, SourceElement

Represents a co-ocurring of two names (Atoms) or meanings (Concepts) in a source of biomedical literature.

Following is a UML Class diagram showing the neighborhood around Coocurrence

All data in a row of the MRCOC file is represented here.

Author:
Brian Carlsen, Deborah Shapiro

Nested Class Summary
 
Nested classes inherited from class gov.nih.nlm.umls.meta.SourceElement
SourceElement.BySourceComparator, SourceElement.BySourceRestrictor
 
Method Summary
 String getCoa()
          Returns the coocurrence attribute value (COA).
 int getCof()
          Returns the coocurrence frequency (COF).
 String getCoocurrenceAttribute()
          Returns the coocurrence attribute value (COA).
 int getCoocurrenceFrequency()
          Returns the coocurrence frequency (COF).
 CoocurrenceType getCoocurrenceType()
          Returns the CoocurrenceType (COT).
 CoocurrenceType getCot()
          Returns the CoocurrenceType (COT).
 String getKeyFields()
          Returns a String key which can be used by equals, compareTo, and hashCode methods.
 List getQualifierAsList()
          Returns the QualifierFrequency values as a List.
 QualifierFrequency[] getQualifiers()
          Returns the QualifierFrequency list.
 void setCoa(String coa)
          Sets the coocurrence attribute value (COA).
 void setCof(int cof)
          Sets the coocurrence frequency (COF).
 void setCoocurrenceAttribute(String coa)
          Sets the coocurrence attribute value (COA).
 void setCoocurrenceFrequency(int cof)
          Sets the coocurrence frequency (COF).
 void setCoocurrenceType(CoocurrenceType cot)
          Sets the CoocurrenceType (COT).
 void setCot(CoocurrenceType cot)
          Sets the CoocurrenceType (COT).
 void setQualifiers(List coa)
          Replaces the QualifierFrequency values with those in the specified List
 void setQualifiers(QualifierFrequency[] coa)
          Replaces the QualifierFrequency values with those in the specified array.
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface gov.nih.nlm.umls.meta.ConceptElement
getConcept, setConcept
 
Methods inherited from interface gov.nih.nlm.umls.meta.ContentViewElement
getContentView, getCvf, setContentView, setCvf
 
Methods inherited from interface gov.nih.nlm.umls.meta.RelatedConceptElement
getRelatedConcept, setRelatedConcept
 
Methods inherited from interface gov.nih.nlm.umls.meta.SourceElement
getSource, setSource
 

Method Detail

getCoocurrenceType

public CoocurrenceType getCoocurrenceType()
Returns the CoocurrenceType (COT).

Returns:
the CoocurrenceType

getCot

public CoocurrenceType getCot()
Returns the CoocurrenceType (COT). This is shorthand for getCoocurrenceType().

Returns:
the CoocurrenceType

setCoocurrenceType

public void setCoocurrenceType(CoocurrenceType cot)
Sets the CoocurrenceType (COT).

Parameters:
cot - the CoocurrenceType

setCot

public void setCot(CoocurrenceType cot)
Sets the CoocurrenceType (COT). This is shorthand for setCoocurrenceType(CoocurrenceType).

Parameters:
cot - the CoocurrenceType

getCoocurrenceFrequency

public int getCoocurrenceFrequency()
Returns the coocurrence frequency (COF).

Returns:
the coocurrence frequency

getCof

public int getCof()
Returns the coocurrence frequency (COF). This is shorthand for getCoocurrenceFrequency().

Returns:
the coocurrence frequency

setCoocurrenceFrequency

public void setCoocurrenceFrequency(int cof)
Sets the coocurrence frequency (COF).

Parameters:
cof - the coocurrence frequency

setCof

public void setCof(int cof)
Sets the coocurrence frequency (COF). This is shorthand for setCoocurrenceFrequency(int).

Parameters:
cof - the coocurrence frequency

getCoa

public String getCoa()
Returns the coocurrence attribute value (COA). This is shorthand for getCoocurrenceAttribute().

Returns:
the coocurrence attribute value

getCoocurrenceAttribute

public String getCoocurrenceAttribute()
Returns the coocurrence attribute value (COA).

Returns:
the coocurrence attribute value

setCoocurrenceAttribute

public void setCoocurrenceAttribute(String coa)
Sets the coocurrence attribute value (COA). This is a comma separated list of nqualifier=frequency pairs.

Parameters:
coa - the coocuurence attribute value

setCoa

public void setCoa(String coa)
Sets the coocurrence attribute value (COA). This is a comma separated list of name=value pairs. This is shorthand for setCoocurrenceAttribute(String).

Parameters:
coa - the coocuurence attribute value

getQualifiers

public QualifierFrequency[] getQualifiers()
Returns the QualifierFrequency list.

Returns:
an array of QualifierFrequencys

getQualifierAsList

public List getQualifierAsList()
Returns the QualifierFrequency values as a List.

Returns:
the QualifierFrequency values as a List

setQualifiers

public void setQualifiers(QualifierFrequency[] coa)
Replaces the QualifierFrequency values with those in the specified array.

Parameters:
coa - an array of QualifierFrequency values

setQualifiers

public void setQualifiers(List coa)
Replaces the QualifierFrequency values with those in the specified List

Parameters:
coa - a List of QualifierFrequency values

getKeyFields

public String getKeyFields()
Returns a String key which can be used by equals, compareTo, and hashCode methods.

Returns:
a String composed from key Coocurrence fields


Copyright ©2005