gov.nih.nlm.umls.meta
Class SourceTermType

java.lang.Object
  gov.nih.nlm.umls.meta.SourceTermType

All Implemented Interfaces:

SuppressibleElement, Comparable

public class SourceTermType
extends Object
implements SuppressibleElement, Comparable

Represents a tuple consisting of a Source and a TermType.

Author:

Brian Carlsen, Deborah Shapiro

Constructor Summary

SourceTermType()
Instantiate an empty SourceTermType.

Method Summary

int	compareTo(Object o) Compares this SourceTermType to another one.
boolean	equals(Object o) Returns true if the specified object is equal to this object.
Source	getSource() Returns the Source.
Suppressible	getSuppress() Returns the suppressibility value (SUPPRESS).
TermType	getTermType() Returns tbe TermType.
int	hashCode() Return a hash code based on key fields.
boolean	isObsolete() Indicates whether or not this SourceTermType is obsolete.
boolean	isSuppressible() Indicates whether or not this SourceTermType is suppressible.
void	setSource(Source source) Sets the Source.
void	setSuppress(Suppressible suppress) Sets the suppressibility value (SUPPRESS).
void	setTermType(TermType tty) Sets tbe TermType.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourceTermType

public SourceTermType()

Instantiate an empty SourceTermType.

Method Detail

getSource

public Source getSource()

Returns the Source.

Returns:

the Source

setSource

public void setSource(Source source)

Sets the Source.

Parameters:

source - the Source

getTermType

public TermType getTermType()

Returns tbe TermType.

Returns:

tbe TermType

setTermType

public void setTermType(TermType tty)

Sets tbe TermType.

Parameters:

tty - tbe TermType

getSuppress

public Suppressible getSuppress()

Returns the suppressibility value (SUPPRESS).

Specified by:

getSuppress in interface SuppressibleElement

Returns:

the Suppressible value

isSuppressible

public boolean isSuppressible()

Indicates whether or not this SourceTermType is suppressible.

Specified by:

isSuppressible in interface SuppressibleElement

Returns:

true if suppressible, false if not suppressible

setSuppress

public void setSuppress(Suppressible suppress)

Sets the suppressibility value (SUPPRESS).

Specified by:

setSuppress in interface SuppressibleElement

Parameters:

suppress - the Suppressible value

isObsolete

public boolean isObsolete()

Indicates whether or not this SourceTermType is obsolete.

Specified by:

isObsolete in interface SuppressibleElement

Returns:

true if obsolete, false if not obsolete

hashCode

public int hashCode()

Return a hash code based on key fields.

Overrides:

hashCode in class Object

Returns:

a hash code based on key fields

equals

public boolean equals(Object o)

Returns true if the specified object is equal to this object. The specified object must be an SourceTermType with matching key fields.

Overrides:

equals in class Object

Parameters:

o - an Object to compare against

Returns:

boolean true if Object o is equal false otherwise

compareTo

public int compareTo(Object o)

Compares this SourceTermType to another one. Results are indeterminate if the specified parameter is not of the same class.

Specified by:

compareTo in interface Comparable

Parameters:

o - the Object to compare to

Returns:

int representing the relative ordering of this and the compare-to object