gov.nih.nlm.umls.meta
Interface CoocurrenceContext

All Superinterfaces:
Comparable, ContentViewElement, SourceElement
All Known Implementing Classes:
CoocurrenceContextImpl

public interface CoocurrenceContext
extends Comparable, ContentViewElement, SourceElement

Represents part of a CoocurrenceGroup, containing more detailed information about how two co ocurring meanings (or identifiers) are related in a particular source of biomedical literature.

Following is a UML Class diagram showing the neighborhood around CoocurrenceContext

Author:
Brian Carlsen, Deborah Shapiro
See Also:
CoocurrenceGroup

Nested Class Summary
 
Nested classes inherited from class gov.nih.nlm.umls.meta.SourceElement
SourceElement.BySourceComparator, SourceElement.BySourceRestrictor
 
Method Summary
 void addQualifier(QualifierFrequency qual)
          Adds the specified QualifierFrequency.
 void clearQualifiers()
          Removes all QualifierFrequencys.
 int getCof()
          Returns the CoocurrenceContext frequency (COF).
 int getCoocurrenceContextFrequency()
          Returns the CoocurrenceContext frequency (COF).
 CoocurrenceGroup getCoocurrenceGroup()
          Returns the CoocurrenceGroup that holds this CoocurrenceContext.
 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 removeQualifier(QualifierFrequency qual)
          Removes the specified QualifierFrequency.
 void setCof(int cof)
          Sets the CoocurrenceContext frequency (COF).
 void setCoocurrenceContextFrequency(int cof)
          Sets the CoocurrenceContext frequency (COF).
 void setCoocurrenceGroup(CoocurrenceGroup group)
          Sets the CoocurrenceGroup that holds this CoocurrenceContext.
 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.ContentViewElement
getContentView, getCvf, setContentView, setCvf
 
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

getCoocurrenceContextFrequency

public int getCoocurrenceContextFrequency()
Returns the CoocurrenceContext frequency (COF).

Returns:
the CoocurrenceContext frequency

getCof

public int getCof()
Returns the CoocurrenceContext frequency (COF). This is shorthand for getCoocurrenceContextFrequency().

Returns:
the CoocurrenceContext frequency

setCoocurrenceContextFrequency

public void setCoocurrenceContextFrequency(int cof)
Sets the CoocurrenceContext frequency (COF).

Parameters:
cof - the CoocurrenceContext frequency

setCof

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

Parameters:
cof - the CoocurrenceContext frequency

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

addQualifier

public void addQualifier(QualifierFrequency qual)
Adds the specified QualifierFrequency.

Parameters:
qual - the QualifierFrequency to be added

removeQualifier

public void removeQualifier(QualifierFrequency qual)
Removes the specified QualifierFrequency.

Parameters:
qual - the QualifierFrequency to be removed

clearQualifiers

public void clearQualifiers()
Removes all QualifierFrequencys.


getCoocurrenceGroup

public CoocurrenceGroup getCoocurrenceGroup()
Returns the CoocurrenceGroup that holds this CoocurrenceContext.

Returns:
the CoocurrenceGroup that holds this CoocurrenceContext

setCoocurrenceGroup

public void setCoocurrenceGroup(CoocurrenceGroup group)
Sets the CoocurrenceGroup that holds this CoocurrenceContext.

Parameters:
group - the CoocurrenceGroup that holds this CoocurrenceContext

getKeyFields

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

Returns:
a String composed from key Atom fields


Copyright ©2005