gov.nih.nlm.umls.meta.impl
Class DefinitionImpl

java.lang.Object
  extended bygov.nih.nlm.umls.meta.impl.DefinitionImpl
All Implemented Interfaces:
AtomElement, AttributeElement, Comparable, ConceptElement, ContentViewElement, Definition, SourceElement, SuppressibleElement

public class DefinitionImpl
extends Object
implements Definition

Default implementation of the Definition interface.

Author:
Brian Carlsen, Deborah Shapiro

Nested Class Summary
 
Nested classes inherited from class gov.nih.nlm.umls.meta.AtomElement
AtomElement.ByLanguageRestrictor, AtomElement.BySourceRestrictor
 
Nested classes inherited from class gov.nih.nlm.umls.meta.SourceElement
SourceElement.BySourceComparator, SourceElement.BySourceRestrictor
 
Constructor Summary
DefinitionImpl()
          Instantiates an empty Definition.
DefinitionImpl(Definition def)
          Instantiates a Definition from the specified Definition.
 
Method Summary
 int compareTo(Object o)
          Compares this Definition to another one.
 boolean equals(Object o)
          Returns true if the specified object is equal to this object.
 Atom getAtom()
          Returns the Atom related to this Definition.
 String getAttributeIdentifier()
          Returns the unique identifier (ATUI).
 String getAtui()
          Shorthand for getAttributeIdentifier().
 Concept getConcept()
          Returns the Concept that holds this Definition.
 ContentView getContentView()
          Returns tbe ContentView definition for this Definition (CVF).
 ContentView getCvf()
          Shorthand for getContentView().
 String getDef()
          Shorthand for getDefinition().
 String getDefinition()
          Returns the definition value (DEF).
 String getKeyFields()
          Returns a String key which can be used by equals, compareTo, and hashCode methods.
 String getSatui()
          Shorthand for getSourceAttributeIdentifier().
 Source getSource()
          Returns the source for this Definition.
 String getSourceAttributeIdentifier()
          Returns the source asserted attribute identifier (SATUI).
 Suppressible getSuppress()
          Returns the suppressibility value (SUPPRESS).
 int hashCode()
          Return a hash code based on key fields.
 boolean isObsolete()
          Indicates whether or not this DefinitionImpl is obsolete.
 boolean isSuppressible()
          Indicates whether or not this Atom is suppressible.
 void setAtom(Atom atom)
          Sets the Atom related to this Definition.
 void setAttributeIdentifier(String atui)
          Sets the unique identifier (ATUI).
 void setAtui(String atui)
          Shorthand for setAttributeIdentifier(String).
 void setConcept(Concept concept)
          Sets the Concept that holds this Definition.
 void setContentView(ContentView cvf)
          Sets tbe ContentView definition for this Definition (CVF).
 void setCvf(ContentView cvf)
          Shorthand for setContentView(ContentView).
 void setDef(String def)
          Shorthand for setDefinition(String).
 void setDefinition(String def)
          Sets the definition value (DEF).
 void setSatui(String satui)
          Shorthand for setSourceAttributeIdentifier(String).
 void setSource(Source source)
          Sets the source for this Definition.
 void setSourceAttributeIdentifier(String satui)
          Sets the source asserted attribute identifier (SATUI).
 void setSuppress(Suppressible suppress)
          Sets the suppressibility value (SUPPRESS).
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefinitionImpl

public DefinitionImpl()
Instantiates an empty Definition.


DefinitionImpl

public DefinitionImpl(Definition def)
Instantiates a Definition from the specified Definition.

Parameters:
def - Definition to be copied
Method Detail

getAtom

public Atom getAtom()
Returns the Atom related to this Definition.

Specified by:
getAtom in interface AtomElement
Returns:
the Atom related to this Definition

setAtom

public void setAtom(Atom atom)
Sets the Atom related to this Definition.

Specified by:
setAtom in interface AtomElement
Parameters:
atom - the Atom related to this Definition

getAttributeIdentifier

public String getAttributeIdentifier()
Returns the unique identifier (ATUI).

Specified by:
getAttributeIdentifier in interface AttributeElement
Returns:
the ATUI

getAtui

public String getAtui()
Shorthand for getAttributeIdentifier().

Specified by:
getAtui in interface AttributeElement
Returns:
the ATUI

setAttributeIdentifier

public void setAttributeIdentifier(String atui)
Sets the unique identifier (ATUI).

Specified by:
setAttributeIdentifier in interface AttributeElement
Parameters:
atui - the ATUI

setAtui

public void setAtui(String atui)
Shorthand for setAttributeIdentifier(String).

Specified by:
setAtui in interface AttributeElement
Parameters:
atui - the ATUI

getSourceAttributeIdentifier

public String getSourceAttributeIdentifier()
Returns the source asserted attribute identifier (SATUI).

Specified by:
getSourceAttributeIdentifier in interface AttributeElement
Returns:
the SATUI

getSatui

public String getSatui()
Shorthand for getSourceAttributeIdentifier().

Specified by:
getSatui in interface AttributeElement
Returns:
the SATUI

setSourceAttributeIdentifier

public void setSourceAttributeIdentifier(String satui)
Sets the source asserted attribute identifier (SATUI).

Specified by:
setSourceAttributeIdentifier in interface AttributeElement
Parameters:
satui - the SATUI

setSatui

public void setSatui(String satui)
Shorthand for setSourceAttributeIdentifier(String).

Specified by:
setSatui in interface AttributeElement
Parameters:
satui - the SATUI

getConcept

public Concept getConcept()
Returns the Concept that holds this Definition.

Specified by:
getConcept in interface ConceptElement
Returns:
the Concept that holds this Definition

setConcept

public void setConcept(Concept concept)
Sets the Concept that holds this Definition.

Specified by:
setConcept in interface ConceptElement
Parameters:
concept - the Concept that holds this Definition

getSource

public Source getSource()
Returns the source for this Definition.

Specified by:
getSource in interface SourceElement
Returns:
Source

setSource

public void setSource(Source source)
Sets the source for this Definition.

Specified by:
setSource in interface SourceElement
Parameters:
source - Source

getDefinition

public String getDefinition()
Returns the definition value (DEF).

Specified by:
getDefinition in interface Definition
Returns:
the definition value (DEF).

getDef

public String getDef()
Shorthand for getDefinition().

Specified by:
getDef in interface Definition
Returns:
the definition value (DEF).

setDefinition

public void setDefinition(String def)
Sets the definition value (DEF).

Specified by:
setDefinition in interface Definition
Parameters:
def - the definition value

setDef

public void setDef(String def)
Shorthand for setDefinition(String).

Specified by:
setDef in interface Definition
Parameters:
def - the definition value

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 Atom 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 DefinitionImpl is obsolete.

Specified by:
isObsolete in interface SuppressibleElement
Returns:
true if obsolete, false if not obsolete

getContentView

public ContentView getContentView()
Returns tbe ContentView definition for this Definition (CVF).

Specified by:
getContentView in interface ContentViewElement
Returns:
tbe ContentView definition

setContentView

public void setContentView(ContentView cvf)
Sets tbe ContentView definition for this Definition (CVF).

Specified by:
setContentView in interface ContentViewElement
Parameters:
cvf - the ContentView definition

getCvf

public ContentView getCvf()
Shorthand for getContentView().

Specified by:
getCvf in interface ContentViewElement
Returns:
tbe ContentView definition

setCvf

public void setCvf(ContentView cvf)
Shorthand for setContentView(ContentView).

Specified by:
setCvf in interface ContentViewElement
Parameters:
cvf - the ContentView definition

getKeyFields

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

Specified by:
getKeyFields in interface Definition
Returns:
a String composed from the cui, aui, atui, versioned source, satui, and def.

hashCode

public int hashCode()
Return a hash code based on key fields.

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 a Definition with matching key fields.

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 Definition 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


Copyright ©2005