gov.nih.nlm.umls.meta
Interface Attribute

All Superinterfaces:

AttributeElement, Comparable, ConceptElement, ContentViewElement, SourceElement, SourceIdentifierElement, SuppressibleElement

All Known Subinterfaces:

AtomAttribute, RelationshipAttribute

All Known Implementing Classes:

AtomAttributeImpl, AttributeImpl, RelationshipAttributeImpl

public interface Attribute
extends AttributeElement, Comparable, ConceptElement, ContentViewElement, SourceIdentifierElement, SourceElement, SuppressibleElement

Represents information about an attribute attached to an Atom, a Concept, or a Relationship. This interface is the superclass for RelationshipAttribute and AtomAttribute. Implementations of this interface should not be constructed. Rather, implementations of RelationshipAttribute or AtomAttribute should be constructed.

Following is a UML Class diagram showing the neighborhood around Attribute

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

Author:

Brian Carlsen, Deborah Shapiro

Nested Class Summary

Nested classes/interfaces inherited from interface gov.nih.nlm.umls.meta.SourceElement

SourceElement.BySourceComparator, SourceElement.BySourceRestrictor

Method Summary

AttributeName	getAtn() Returns the AttributeName (ATN).
AttributeName	getAttributeName() Returns the AttributeName (ATN).
String	getAttributeValue() Returns the attribute value.
String	getAtv() Returns the attribute value (ATV).
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
void	setAtn(AttributeName atn) Sets the AttributeName (ATN).
void	setAttributeName(AttributeName atn) Sets the AttributeName (ATN).
void	setAttributeValue(String atv) Sets the attribute value (ATV).
void	setAtv(String atv) Sets the attribute value.

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

getAttributeIdentifier, getAtui, getSatui, getSourceAttributeIdentifier, setAttributeIdentifier, setAtui, setSatui, setSourceAttributeIdentifier

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

getSourceIdentifierType, setSourceIdentifierType

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

getSource, setSource

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

getSuppress, isObsolete, isSuppressible, setSuppress

Method Detail

getAttributeName

AttributeName getAttributeName()

Returns the AttributeName (ATN).

Returns:

the AttributeName

getAtn

AttributeName getAtn()

Returns the AttributeName (ATN). This is shorthand for getAttributeName().

Returns:

the AttributeName

setAttributeName

void setAttributeName(AttributeName atn)

Sets the AttributeName (ATN).

Parameters:

atn - the AttributeName

setAtn

void setAtn(AttributeName atn)

Sets the AttributeName (ATN). This is shorthand for setAttributeName(AttributeName).

Parameters:

atn - the AttributeName

getAttributeValue

String getAttributeValue()

Returns the attribute value.

Returns:

the attribute value

getAtv

String getAtv()

Returns the attribute value (ATV). This is shorthand for getAttributeValue().

Returns:

the attribute value

setAttributeValue

void setAttributeValue(String atv)

Sets the attribute value (ATV).

Parameters:

atv - the attribute value

setAtv

void setAtv(String atv)

Sets the attribute value. This is shorthand for setAttributeValue(String).

Parameters:

atv - the attribute value

getKeyFields

String getKeyFields()

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

Returns:

a String composed from key Atom fields