gov.nih.nlm.umls.meta
Interface StringAttribute

All Superinterfaces:

Comparable

All Known Implementing Classes:

StringAttributeImpl

public interface StringAttribute

extends Comparable

Represents information about attributes shared at the level of a string identifier.

Following is a UML Class diagram showing the neighborhood around StringAttribute

Author:

Brian Carlsen, Deborah Shapiro

See Also:

TermAttribute

Method Summary

void	addAttributeContext(AttributeContext ac) Adds the specified AttributeContext.
void	clearAttributeContexts() Removes all AttributeContexts.
AttributeContext[]	getAttributeContexts() Returns all AttributeContexts.
List	getAttributeContextsAsList() Returns all AttributeContexts as a List.
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
StringInfo	getStringInfo() Returns the StringInfo.
TermAttribute	getTermAttribute() Returns the TermAttribute that holds this StringAttribute.
void	removeAttributeContext(AttributeContext ac) Removes the specified AttributeContext.
void	setAttributeContexts(AttributeContext[] acs) Replaces the AttributeContexts with the ones in the specified array.
void	setAttributeContexts(List acs) Replaces the AttributeContexts with the ones in the specified List.
void	setStringInfo(StringInfo si) Sets the StringInfo.
void	setTermAttribute(TermAttribute ta) Sets the TermAttribute that holds this StringAttribute.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getTermAttribute

public TermAttribute getTermAttribute()

Returns the TermAttribute that holds this StringAttribute.

Returns:

the TermAttribute that holds this StringAttribute

setTermAttribute

public void setTermAttribute(TermAttribute ta)

Sets the TermAttribute that holds this StringAttribute.

Parameters:

ta - the TermAttribute that holds this StringAttribute

getStringInfo

public StringInfo getStringInfo()

Returns the StringInfo.

Returns:

the StringInfo

setStringInfo

public void setStringInfo(StringInfo si)

Sets the StringInfo.

Parameters:

si - the StringInfo

getAttributeContexts

public AttributeContext[] getAttributeContexts()

Returns all AttributeContexts.

Returns:

a array of AttributeContexts

getAttributeContextsAsList

public List getAttributeContextsAsList()

Returns all AttributeContexts as a List.

Returns:

a List of AttributeContexts

addAttributeContext

public void addAttributeContext(AttributeContext ac)

Adds the specified AttributeContext.

Parameters:

ac - the AttributeContext to be added

removeAttributeContext

public void removeAttributeContext(AttributeContext ac)

Removes the specified AttributeContext.

Parameters:

ac - the AttributeContext to be removed

clearAttributeContexts

public void clearAttributeContexts()

Removes all AttributeContexts.

setAttributeContexts

public void setAttributeContexts(AttributeContext[] acs)

Replaces the AttributeContexts with the ones in the specified array.

Parameters:

acs - a AttributeContext[]

setAttributeContexts

public void setAttributeContexts(List acs)

Replaces the AttributeContexts with the ones in the specified List.

Parameters:

acs - a List of AttributeContexts

getKeyFields

public String getKeyFields()

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

Returns:

a String composed from key StringAttribute fields