gov.nih.nlm.umls.meta
Interface MapObject

All Superinterfaces:

Comparable, SourceElement

All Known Implementing Classes:

MapObjectImpl

public interface MapObject
extends SourceElement, Comparable

Represents information about the "to" or "from" end of a mapping. For example, a SNOMEDCT->ICD9CM mapping might have a MapObject representing a SNOMEDCT concept identifier and a MapObject representing a list of ICD9CM codes.

Following is a UML Class diagram showing the neighborhood around MapObject

This is used in conjunction with Mapping to represent all of the data in a row of the MRMAP file.

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

String	getExpr() Returns the expression (FROMEXPR or TOEXPR).
String	getExpression() Returns the expression (FROMEXPR or TOEXPR).
String	getId() Returns the unique identifier (FROMID or TOID).
String	getIdentifier() Returns the unique identifier (FROMID or TOID).
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
String	getRes() Returns the restriction (FROMRES or TORES).
String	getRestriction() Returns the restriction (FROMRES or TORES).
String	getRule() Returns the machine processable rule for when mapping is valid (FROMRULE or TORULE).
String	getSid() Returns the source asserted unique identifier (FROMSID or TOSID).
String	getSourceIdentifier() Returns the source asserted unique identifier (FROMSID or TOSID).
SourceIdentifierType	getType() Returns the type SourceIdentifierType (FROMTYPE or TOTYPE).
void	setExpr(String expr) Sets the expression (FROMEXPR or TOEXPR).
void	setExpression(String expr) Sets the expression (FROMEXPR or TOEXPR).
void	setId(String id) Sets the unique identifier (FROMID or TOID).
void	setIdentifier(String id) Sets the unique identifier (FROMID or TOID).
void	setRes(String res) Sets the restriction (FROMRES or TORES).
void	setRestriction(String res) Sets the restriction (FROMRES or TORES).
void	setRule(String rule) Sets the machine processable rule for when mapping is valid (FROMRULE or TORULE).
void	setSid(String sid) Sets the source asserted unique identifier (FROMSID or TOSID).
void	setSourceIdentifier(String sid) Sets the source asserted unique identifier (FROMSID or TOSID).
void	setType(SourceIdentifierType type) Sets the type (FROMTYPE or TOTYPE).

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

getSource, setSource

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getSourceIdentifier

String getSourceIdentifier()

Returns the source asserted unique identifier (FROMSID or TOSID).

Returns:

the source asserted unique identifier

setSourceIdentifier

void setSourceIdentifier(String sid)

Sets the source asserted unique identifier (FROMSID or TOSID).

Parameters:

sid - source asserted unique identifier

getSid

String getSid()

Returns the source asserted unique identifier (FROMSID or TOSID). This method is shorthand for getSourceIdentifier().

Returns:

the source asserted unique identifier

setSid

void setSid(String sid)

Sets the source asserted unique identifier (FROMSID or TOSID). This method is shorthand for setSourceIdentifier(String).

Parameters:

sid - source asserted unique identifier

getIdentifier

String getIdentifier()

Returns the unique identifier (FROMID or TOID).

Returns:

the unique identifier

setIdentifier

void setIdentifier(String id)

Sets the unique identifier (FROMID or TOID).

Parameters:

id - unique identifier

getId

String getId()

Returns the unique identifier (FROMID or TOID). This method is shorthand for getIdentifier().

Returns:

the unique identifier

setId

void setId(String id)

Sets the unique identifier (FROMID or TOID). This method is shorthand for setIdentifier(String).

Parameters:

id - unique identifier

getExpression

String getExpression()

Returns the expression (FROMEXPR or TOEXPR).

Returns:

the expression

setExpression

void setExpression(String expr)

Sets the expression (FROMEXPR or TOEXPR).

Parameters:

expr - expression

getExpr

String getExpr()

Returns the expression (FROMEXPR or TOEXPR). This method is shorthand for getExpression().

Returns:

the expression

setExpr

void setExpr(String expr)

Sets the expression (FROMEXPR or TOEXPR). This method is shorthand for setExpression(String).

Parameters:

expr - expression

getType

SourceIdentifierType getType()

Returns the type SourceIdentifierType (FROMTYPE or TOTYPE).

Returns:

the type

setType

void setType(SourceIdentifierType type)

Sets the type (FROMTYPE or TOTYPE).

Parameters:

type - SourceIdentifierType

getRule

String getRule()

Returns the machine processable rule for when mapping is valid (FROMRULE or TORULE).

Returns:

the rule

setRule

void setRule(String rule)

Sets the machine processable rule for when mapping is valid (FROMRULE or TORULE).

Parameters:

rule - the rule

getRestriction

String getRestriction()

Returns the restriction (FROMRES or TORES).

Returns:

the restriction

setRestriction

void setRestriction(String res)

Sets the restriction (FROMRES or TORES).

Parameters:

res - restriction

getRes

String getRes()

Returns the restriction (FROMRES or TORES). This method is shorthand for getRestriction().

Returns:

the restriction

setRes

void setRes(String res)

Sets the restriction (FROMRES or TORES). This method is shorthand for setRestriction(String).

Parameters:

res - restriction

getKeyFields

String getKeyFields()

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

Returns:

a String composed from key Mapping fields