gov.nih.nlm.umls.meta
Interface ContextGroup

All Superinterfaces:

Comparable, ConceptElement

All Known Implementing Classes:

ContextGroupImpl

public interface ContextGroup

extends Comparable, ConceptElement

Represents a grouping of StringContexts all of which share the same string identifier.

Following is a UML Class diagram showing the neighborhood around ContextGroup

Author:

Brian Carlsen, Deborah Shapiro

Method Summary

void	addStringContext(StringContext sc) Adds the specified StringContext.
void	clearStringContexts() Removes all StringContexts.
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
StringContext[]	getStringContexts() Returns all StringContexts.
List	getStringContextsAsList() Returns all StringContexts as a List
StringInfo	getStringInfo() Return the StringInfo.
void	removeStringContext(StringContext sc) Removes the specified StringContext.
void	setStringContexts(List scs) replaces the StringContexts with the ones in the specified List.
void	setStringContexts(StringContext[] scs) Replaces the StringContexts with the ones in the specified array.
void	setStringInfo(StringInfo string_info) Sets the StringInfo.

Methods inherited from interface java.lang.Comparable

compareTo

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

getConcept, setConcept

Method Detail

getStringInfo

public StringInfo getStringInfo()

Return the StringInfo.

Returns:

the StringInfo

setStringInfo

public void setStringInfo(StringInfo string_info)

Sets the StringInfo.

Parameters:

string_info - the StringInfo

getStringContexts

public StringContext[] getStringContexts()

Returns all StringContexts.

Returns:

an array of StringContexts

getStringContextsAsList

public List getStringContextsAsList()

Returns all StringContexts as a List

Returns:

a List of StringContexts

addStringContext

public void addStringContext(StringContext sc)

Adds the specified StringContext.

Parameters:

sc - the StringContext to be added

removeStringContext

public void removeStringContext(StringContext sc)

Removes the specified StringContext.

Parameters:

sc - the StringContext to be removed

clearStringContexts

public void clearStringContexts()

Removes all StringContexts.

setStringContexts

public void setStringContexts(StringContext[] scs)

Replaces the StringContexts with the ones in the specified array.

Parameters:

scs - a StringContext[]

setStringContexts

public void setStringContexts(List scs)

replaces the StringContexts with the ones in the specified List.

Parameters:

scs - a List of StringContexts

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