gov.nih.nlm.umls.meta
Interface CoocurrenceGroup

All Superinterfaces:

AtomElement, Comparable, ConceptElement, RelatedAtomElement, RelatedConceptElement

All Known Implementing Classes:

CoocurrenceGroupImpl

public interface CoocurrenceGroup

extends AtomElement, Comparable, ConceptElement, RelatedAtomElement, RelatedConceptElement

Represents a group of co-ocurring Concepts or Atoms.

Following is a UML Class diagram showing the neighborhood around CoocurrenceGroup

Author:

Brian Carlsen, Deborah Shapiro

Nested Class Summary

Nested classes inherited from class gov.nih.nlm.umls.meta.AtomElement

AtomElement.ByLanguageRestrictor, AtomElement.BySourceRestrictor

Method Summary

void	addCoocurrenceContext(CoocurrenceContext coc_context) Adds the specified CoocurrenceContext.
void	clearCoocurrenceContexts() Removes all CoocurrenceContexts.
CoocurrenceContext[]	getCoocurrenceContexts() Returns the CoocurrenceContexts.
List	getCoocurrenceContextsAsList() Returns the CoocurrenceContexts as a List.
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
void	removeCoocurrenceContext(CoocurrenceContext coc_context) Removes the specified CoocurrenceContext.
void	setCoocurrenceContexts(CoocurrenceContext[] coc_contexts) Replaces the CoocurrenceContexts with those in the specified array.
void	setCoocurrenceContexts(List coc_contexts) Replaces the CoocurrenceContexts with those in the specified List
void	setCoocurrenceContexts(String coc_contexts) Sets the coocurrence attribute value.

Methods inherited from interface gov.nih.nlm.umls.meta.AtomElement

getAtom, setAtom

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.RelatedAtomElement

getRelatedAtom, setRelatedAtom

Methods inherited from interface gov.nih.nlm.umls.meta.RelatedConceptElement

getRelatedConcept, setRelatedConcept

Method Detail

getCoocurrenceContexts

public CoocurrenceContext[] getCoocurrenceContexts()

Returns the CoocurrenceContexts.

Returns:

an array of CoocurrenceContexts

getCoocurrenceContextsAsList

public List getCoocurrenceContextsAsList()

Returns the CoocurrenceContexts as a List.

Returns:

the CoocurrenceContexts as a List

setCoocurrenceContexts

public void setCoocurrenceContexts(String coc_contexts)

Sets the coocurrence attribute value. This is a comma separated list of name=value pairs.

Parameters:

coc_contexts - the coocuurence attribute value

setCoocurrenceContexts

public void setCoocurrenceContexts(CoocurrenceContext[] coc_contexts)

Replaces the CoocurrenceContexts with those in the specified array.

Parameters:

coc_contexts - an array of CoocurrenceContexts

setCoocurrenceContexts

public void setCoocurrenceContexts(List coc_contexts)

Replaces the CoocurrenceContexts with those in the specified List

Parameters:

coc_contexts - a List of CoocurrenceContexts

addCoocurrenceContext

public void addCoocurrenceContext(CoocurrenceContext coc_context)

Adds the specified CoocurrenceContext.

Parameters:

coc_context - the CoocurrenceContext to be added

removeCoocurrenceContext

public void removeCoocurrenceContext(CoocurrenceContext coc_context)

Removes the specified CoocurrenceContext.

Parameters:

coc_context - the CoocurrenceContext to be removed

clearCoocurrenceContexts

public void clearCoocurrenceContexts()

Removes all CoocurrenceContexts.

getKeyFields

public String getKeyFields()

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

Returns:

a String composed from key CoocurrenceGroup fields