|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nih.nlm.umls.meta.impl.PlaceholderAtom
Implementation of the Atom
interface.
Nested Class Summary |
Nested classes inherited from class gov.nih.nlm.umls.meta.Atom |
Atom.AtomRankComparator, Atom.ByLanguageRestrictor |
Nested classes inherited from class gov.nih.nlm.umls.meta.SourceElement |
SourceElement.BySourceComparator, SourceElement.BySourceRestrictor |
Field Summary | |
protected String |
aui
|
protected String |
code
|
protected Concept |
concept
|
protected ContentView |
cvf
|
protected String |
ispref
|
protected String |
key_fields
|
protected boolean |
key_fields_flag
|
protected Language |
lat
|
protected String |
lui
|
protected String |
saui
|
protected String |
scui
|
protected String |
sdui
|
protected Source |
source
|
protected String |
str
|
protected StringType |
stt
|
protected String |
sui
|
protected Suppressible |
suppress
|
protected TermStatus |
ts
|
protected TermType |
tty
|
Constructor Summary | |
PlaceholderAtom()
Instantiates an empty PlaceholderAtom . |
|
PlaceholderAtom(Atom atom)
Instantiates a PlaceholderAtom from the specified Atom . |
Method Summary | |
void |
addAttribute(AtomAttribute att)
Adds the specified AtomAttribute . |
void |
addContext(Context cxt)
Adds the specified Context . |
void |
addCoocurrence(Coocurrence coc)
Adds the specified Coocurrence . |
void |
addDefinition(Definition def)
Adds the specified Definition . |
void |
addLocator(Locator loc)
Add the specified Locator . |
void |
addRelationship(Relationship rel)
Adds the specified Relationship . |
void |
clearAttributes()
Remove all AtomAttribute s. |
void |
clearContexts()
Remove all Context s. |
void |
clearCoocurrences()
Remove all Coocurrence s. |
void |
clearDefinitions()
Remove all Definition s. |
void |
clearLocators()
Remove all Locator s. |
void |
clearRelationships()
Remove all Relationship s. |
int |
compareTo(Object o)
Compares this Atom to another one. |
boolean |
equals(Object o)
Returns true if the specified object is
equal to this object. |
String |
getAtomIdentifier()
Returns the atom unique identifier (AUI) related to this Atom . |
AtomAttribute[] |
getAttributes()
Returns the AtomAttribute s. |
List |
getAttributesAsList()
Returns the AtomAttribute s as a List . |
String |
getAui()
Shorthand for getAtomIdentifier() . |
String |
getCode()
Return the code (CODE). |
Concept |
getConcept()
Returns the Concept that holds this Atom . |
ContentView |
getContentView()
Returns tbe ContentView definition for this Atom (CVF). |
Context[] |
getContexts()
Return the Context s. |
List |
getContextsAsList()
Returns the Context s as a List . |
Coocurrence[] |
getCoocurrences()
Returns the Coocurrence s. |
List |
getCoocurrencesAsList()
Returns the Coocurrence s as a List . |
ContentView |
getCvf()
Shorthand for getContentView() . |
Definition[] |
getDefinitions()
Returns the Definition s. |
List |
getDefinitionsAsList()
Returns the Definition s as a List . |
String |
getIspref()
Returns the flag indicating whether or not this Atom is
preferred (ISPREF). |
String |
getKeyFields()
Returns a String key which can be used
by equals, compareTo, and hashCode methods. |
Language |
getLanguage()
Returns the Language (LAT). |
Language |
getLat()
Shorthand for getLanguage() . |
Locator[] |
getLocators()
Returns the Locator s. |
List |
getLocatorsAsList()
Returns the Locator s as a List . |
String |
getLui()
Shorthand for getTermIdentifier() . |
String |
getName()
Sets the name (STR). |
Relationship[] |
getRelationships()
Returns the Relationship s. |
Relationship[] |
getRelationships(Restrictor restrictor)
Returns a subset of this Atom 's Relationship s. |
List |
getRelationshipsAsList()
Returns the Relationship s as a List . |
String |
getSaui()
Shorthand for getSourceAtomIdentifier() . |
String |
getScui()
Shorthand for getSourceConceptIdentifier() . |
String |
getSdui()
Shorthand for getSourceDescriptor() . |
Source |
getSource()
Returns the source for this Atom . |
String |
getSourceAtomIdentifier()
Returns the source asserted identifier (SAUI) for this Atom . |
String |
getSourceConceptIdentifier()
Returns the source attributed concept identifier (SCUI). |
String |
getSourceDescriptor()
Returns the source asserted descriptor (SDUI). |
String |
getStr()
Shorthand for getName() . |
String |
getStringIdentifier()
Return the string identifier (SUI). |
StringType |
getStringType()
Returns the StringType (STT). |
StringType |
getStt()
Shorthand for getStringType() . |
String |
getSui()
Shorthand for getStringIdentifier() . |
Suppressible |
getSuppress()
Returns the suppressibility value (SUPPRESS). |
String |
getTermIdentifier()
Returns the term identifier (LUI). |
TermStatus |
getTermStatus()
Returns the TermStatus (TS). |
TermType |
getTermType()
Returns the TermType (TTY). |
TermStatus |
getTs()
Shorthand for getTermStatus() . |
TermType |
getTty()
Shorthand for getTermType() . |
int |
hashCode()
Return a hash code based on key fields. |
boolean |
hasPreferredAtomIdentifier()
Indicates whether or not this Atom is the preferred atom identifier
for its Concept and string identifier. |
boolean |
hasPreferredAui()
Shorthand for hasPreferredAtomIdentifier() . |
boolean |
hasPreferredLui()
Shorthand for hasPreferredTermIdentifier() |
boolean |
hasPreferredStringIdentifier()
Indicates whether or not this atom has the preferred string identifier of the lexical class it is part of. |
boolean |
hasPreferredSui()
Shorthand for hasPreferredStringIdentifier() . |
boolean |
hasPreferredTermIdentifier()
Indicates whether or not this atom is part of the preferred lexical class of the Concept . |
boolean |
isObsolete()
Indicates whether or not this AtomImpl is obsolete. |
boolean |
isSuppressible()
Indicates whether or not this Atom is suppressible. |
void |
removeAttribute(AtomAttribute att)
Removes the specified AtomAttribute . |
void |
removeContext(Context cxt)
Removes the specified Context . |
void |
removeCoocurrence(Coocurrence coc)
Removes the specified Coocurrence . |
void |
removeDefinition(Definition def)
Remove the specified Definition . |
void |
removeLocator(Locator loc)
Removes the specified Locator . |
void |
removeRelationship(Relationship rel)
Removes the specified Relationship . |
void |
setAtomIdentifier(String aui)
Sets the atom unique identifier (AUI) related to this Atom . |
void |
setAttributes(AtomAttribute[] atts)
Replace AtomAttribute s with the ones in the specified array. |
void |
setAttributes(List atts)
Replace AtomAttribute s with the ones in the specified List . |
void |
setAui(String aui)
Shorthand for setAtomIdentifier(String) . |
void |
setCode(String code)
Sets the code (CODE). |
void |
setConcept(Concept concept)
Sets the Concept that holds this Atom . |
void |
setContentView(ContentView cvf)
Sets tbe ContentView definition for this Atom (CVF). |
void |
setContexts(Context[] cxts)
Replace Context s with the ones in the specified array. |
void |
setContexts(List cxts)
Replace Context s with the ones in the specified List . |
void |
setCoocurrences(Coocurrence[] cocs)
Replace Coocurrence s with the ones in the specified array. |
void |
setCoocurrences(List cocs)
Replace Coocurrence s with the ones in the specified List . |
void |
setCvf(ContentView cvf)
Shorthand for setContentView(ContentView) . |
void |
setDefinitions(Definition[] defs)
Replace Definition s with the ones in the specified array. |
void |
setDefinitions(List defs)
Replace Definition s with the ones in the specified List . |
void |
setIspref(String ispref)
Sets the flag indicating whether or not this Atom is
preferred (ISPREF). |
void |
setLanguage(Language lat)
Sets the Language (LAT). |
void |
setLat(Language lat)
Shorthand for setLanguage(Language) . |
void |
setLocators(List locs)
Replace Locator s with the ones in the specified List . |
void |
setLocators(Locator[] locs)
Replace Locator s with the ones in the specified array. |
void |
setLui(String lui)
Shorthand for setTermIdentifier(String) . |
void |
setName(String str)
Sets the name (STR). |
void |
setRelationships(List rels)
Replace Relationship s of the ones in the specified List . |
void |
setRelationships(Relationship[] rels)
Replace Relationship s with the ones in the specified array. |
void |
setSaui(String saui)
Shorthand for setSourceAtomIdentifier(String) . |
void |
setScui(String scui)
Shorthand for setSourceConceptIdentifier(String) . |
void |
setSdui(String sdui)
Shorthand for setSourceDescriptor(String) . |
void |
setSource(Source source)
Sets the source for this Atom . |
void |
setSourceAtomIdentifier(String saui)
Sets the source asserted identifier (SAUI) for this Atom . |
void |
setSourceConceptIdentifier(String scui)
Sets the source attributed concept identifier (SCUI). |
void |
setSourceDescriptor(String sdui)
Sets the source asserted descriptor (SDUI). |
void |
setStr(String str)
Shorthand for setName(String) . |
void |
setStringIdentifier(String sui)
Sets the string identifier (SUI). |
void |
setStringType(StringType stt)
Sets the StringType (STT). |
void |
setStt(StringType stt)
Shorthand for setStringType(StringType) . |
void |
setSui(String sui)
Shorthand for setStringIdentifier(String) . |
void |
setSuppress(Suppressible suppress)
Sets the suppressibility value (SUPPRESS). |
void |
setTermIdentifier(String lui)
Sets the term identifier (LUI). |
void |
setTermStatus(TermStatus ts)
Sets the TermStatus (TS). |
void |
setTermType(TermType tty)
Sets the TermType (TTY). |
void |
setTs(TermStatus ts)
Shorthand for setTermStatus(TermStatus) . |
void |
setTty(TermType tty)
Shorthand for setTermType(TermType) . |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Concept concept
protected TermType tty
protected Language lat
protected TermStatus ts
protected String lui
protected StringType stt
protected String sui
protected String str
protected String saui
protected String scui
protected String sdui
protected String code
protected String aui
protected Suppressible suppress
protected String ispref
protected Source source
protected ContentView cvf
protected boolean key_fields_flag
protected String key_fields
Constructor Detail |
public PlaceholderAtom()
PlaceholderAtom
.
public PlaceholderAtom(Atom atom)
PlaceholderAtom
from the specified Atom
.
atom
- Atom
to be copiedMethod Detail |
public Concept getConcept()
Concept
that holds this Atom
.
getConcept
in interface ConceptElement
Concept
that holds this Atom
public void setConcept(Concept concept)
Concept
that holds this Atom
.
setConcept
in interface ConceptElement
concept
- the Concept
that holds this Atom
public TermType getTermType()
TermType
(TTY).
getTermType
in interface Atom
TermType
public TermType getTty()
getTermType()
.
getTty
in interface Atom
TermType
public void setTermType(TermType tty)
TermType
(TTY).
setTermType
in interface Atom
tty
- the TermType
public void setTty(TermType tty)
setTermType(TermType)
.
setTty
in interface Atom
tty
- the TermType
public Language getLanguage()
Language
(LAT).
getLanguage
in interface Atom
Language
public Language getLat()
getLanguage()
.
getLat
in interface Atom
Language
public void setLanguage(Language lat)
Language
(LAT).
setLanguage
in interface Atom
lat
- the Language
public void setLat(Language lat)
setLanguage(Language)
.
setLat
in interface Atom
lat
- the Language
public boolean hasPreferredTermIdentifier()
Concept
. In other words, does this Atom
have
the same LUI as the preferred Atom
of the Concept
.
hasPreferredTermIdentifier
in interface Atom
true
if so, false
otherwisepublic boolean hasPreferredLui()
hasPreferredTermIdentifier()
hasPreferredLui
in interface Atom
true
if so, false
otherwisepublic TermStatus getTermStatus()
TermStatus
(TS).
getTermStatus
in interface Atom
TermStatus
public TermStatus getTs()
getTermStatus()
.
getTs
in interface Atom
TermStatus
public void setTermStatus(TermStatus ts)
TermStatus
(TS).
setTermStatus
in interface Atom
ts
- the TermStatus
public void setTs(TermStatus ts)
setTermStatus(TermStatus)
.
setTs
in interface Atom
ts
- the TermStatus
public String getLui()
getTermIdentifier()
.
getLui
in interface Atom
public void setLui(String lui)
setTermIdentifier(String)
.
setLui
in interface Atom
lui
- the LUIpublic String getTermIdentifier()
getTermIdentifier
in interface Atom
public void setTermIdentifier(String lui)
setTermIdentifier
in interface Atom
lui
- the LUIpublic boolean hasPreferredStringIdentifier()
Atom
have
the same SUI as the preferred Atom
of the lexical class.
hasPreferredStringIdentifier
in interface Atom
true
if so, false
otherwisepublic boolean hasPreferredSui()
hasPreferredStringIdentifier()
.
hasPreferredSui
in interface Atom
true
if so, false
otherwisepublic StringType getStringType()
StringType
(STT).
getStringType
in interface Atom
StringType
public StringType getStt()
getStringType()
.
getStt
in interface Atom
StringType
public void setStringType(StringType stt)
StringType
(STT).
setStringType
in interface Atom
stt
- the STTpublic void setStt(StringType stt)
setStringType(StringType)
.
setStt
in interface Atom
stt
- the STTpublic String getSui()
getStringIdentifier()
.
getSui
in interface Atom
public void setSui(String sui)
setStringIdentifier(String)
.
setSui
in interface Atom
sui
- the SUIpublic String getStringIdentifier()
getStringIdentifier
in interface Atom
public void setStringIdentifier(String sui)
setStringIdentifier
in interface Atom
sui
- the SUIpublic String getName()
getName
in interface Atom
public String getStr()
getName()
.
getStr
in interface Atom
public void setName(String str)
setName
in interface Atom
str
- the namepublic void setStr(String str)
setName(String)
.
setStr
in interface Atom
str
- the namepublic Definition[] getDefinitions()
Definition
s.
getDefinitions
in interface Atom
Definition
[]
public List getDefinitionsAsList()
Definition
s as a List
.
getDefinitionsAsList
in interface Atom
Definition
s as a List
public void addDefinition(Definition def)
Definition
.
addDefinition
in interface Atom
def
- the Definition
to be addedpublic void removeDefinition(Definition def)
Definition
.
removeDefinition
in interface Atom
def
- the Definition
to be removedpublic void clearDefinitions()
Definition
s.
clearDefinitions
in interface Atom
public void setDefinitions(Definition[] defs)
Definition
s with the ones in the specified array.
setDefinitions
in interface Atom
defs
- a Definition
[]
public void setDefinitions(List defs)
Definition
s with the ones in the specified List
.
setDefinitions
in interface Atom
defs
- a List
of Definition
spublic Locator[] getLocators()
Locator
s.
getLocators
in interface Atom
Locator
[]
public List getLocatorsAsList()
Locator
s as a List
.
getLocatorsAsList
in interface Atom
Locator
s as a List
public void addLocator(Locator loc)
Locator
.
addLocator
in interface Atom
loc
- the Locator
to be addedpublic void removeLocator(Locator loc)
Locator
.
removeLocator
in interface Atom
loc
- the Locator
to be removedpublic void clearLocators()
Locator
s.
clearLocators
in interface Atom
public void setLocators(Locator[] locs)
Locator
s with the ones in the specified array.
setLocators
in interface Atom
locs
- a Locator
[]
public void setLocators(List locs)
Locator
s with the ones in the specified List
.
setLocators
in interface Atom
locs
- a List
of Locator
spublic Relationship[] getRelationships()
Relationship
s.
getRelationships
in interface Atom
Relationship
[]
public List getRelationshipsAsList()
Relationship
s as a List
.
getRelationshipsAsList
in interface Atom
Relationship
s as a List
public void addRelationship(Relationship rel)
Relationship
.
addRelationship
in interface Atom
rel
- the Relationship
to be addedpublic void removeRelationship(Relationship rel)
Relationship
.
removeRelationship
in interface Atom
rel
- the Relationship
to be removedpublic void clearRelationships()
Relationship
s.
clearRelationships
in interface Atom
public void setRelationships(Relationship[] rels)
Relationship
s with the ones in the specified array.
setRelationships
in interface Atom
rels
- a Relationship
[]
public void setRelationships(List rels)
Relationship
s of the ones in the specified List
.
setRelationships
in interface Atom
rels
- a List
of Relationship
spublic Coocurrence[] getCoocurrences()
Coocurrence
s.
getCoocurrences
in interface Atom
Coocurrence
[]
public List getCoocurrencesAsList()
Coocurrence
s as a List
.
getCoocurrencesAsList
in interface Atom
Coocurrence
s as a List
public void addCoocurrence(Coocurrence coc)
Coocurrence
.
addCoocurrence
in interface Atom
coc
- the Coocurrence
to be addedpublic void removeCoocurrence(Coocurrence coc)
Coocurrence
.
removeCoocurrence
in interface Atom
coc
- the Coocurrence
to be removedpublic void clearCoocurrences()
Coocurrence
s.
clearCoocurrences
in interface Atom
public void setCoocurrences(Coocurrence[] cocs)
Coocurrence
s with the ones in the specified array.
setCoocurrences
in interface Atom
cocs
- a Coocurrence
[]
public void setCoocurrences(List cocs)
Coocurrence
s with the ones in the specified List
.
setCoocurrences
in interface Atom
cocs
- a List
of Coocurrence
spublic Context[] getContexts()
Context
s.
getContexts
in interface Atom
Context
[]
public List getContextsAsList()
Context
s as a List
.
getContextsAsList
in interface Atom
Context
s as a List
public void addContext(Context cxt)
Context
.
addContext
in interface Atom
cxt
- the Context
to be addedpublic void removeContext(Context cxt)
Context
.
removeContext
in interface Atom
cxt
- the Context
to be removedpublic void clearContexts()
Context
s.
clearContexts
in interface Atom
public void setContexts(Context[] cxts)
Context
s with the ones in the specified array.
setContexts
in interface Atom
cxts
- a Context
[]
public void setContexts(List cxts)
Context
s with the ones in the specified List
.
setContexts
in interface Atom
cxts
- a List
of Context
spublic AtomAttribute[] getAttributes()
AtomAttribute
s.
getAttributes
in interface Atom
AtomAttribute
[]
public List getAttributesAsList()
AtomAttribute
s as a List
.
getAttributesAsList
in interface Atom
AtomAttribute
s as a List
public void addAttribute(AtomAttribute att)
AtomAttribute
.
addAttribute
in interface Atom
att
- the AtomAttribute
to be addedpublic void removeAttribute(AtomAttribute att)
AtomAttribute
.
removeAttribute
in interface Atom
att
- the AtomAttribute
to be removedpublic void clearAttributes()
AtomAttribute
s.
clearAttributes
in interface Atom
public void setAttributes(AtomAttribute[] atts)
AtomAttribute
s with the ones in the specified array.
setAttributes
in interface Atom
atts
- an AtomAttribute
[]
public void setAttributes(List atts)
AtomAttribute
s with the ones in the specified List
.
setAttributes
in interface Atom
atts
- a List
of AtomAttribute
spublic String getKeyFields()
String
key which can be used
by equals, compareTo, and hashCode methods.
getKeyFields
in interface Atom
String
composed from the cui, aui, sui,
versioned source, tty, and code.public int hashCode()
public boolean equals(Object o)
true
if the specified object is
equal to this object. The specified object must be an
Atom
with matching key fields.
o
- an Object
to compare against
true
if Object o is equal
false
otherwisepublic int compareTo(Object o)
Atom
to another one. Results
are indeterminate if the specified parameter is not of the
same class.
compareTo
in interface Comparable
o
- the Object
to compare to
int
representing the relative ordering
of this and the compare-to objectpublic String getSaui()
getSourceAtomIdentifier()
.
getSaui
in interface Atom
public String getSourceAtomIdentifier()
Atom
.
getSourceAtomIdentifier
in interface Atom
public void setSourceAtomIdentifier(String saui)
Atom
.
setSourceAtomIdentifier
in interface Atom
saui
- the SAUIpublic void setSaui(String saui)
setSourceAtomIdentifier(String)
.
setSaui
in interface Atom
saui
- the SAUIpublic String getSdui()
getSourceDescriptor()
.
getSdui
in interface Atom
public String getSourceDescriptor()
getSourceDescriptor
in interface Atom
public void setSourceDescriptor(String sdui)
setSourceDescriptor
in interface Atom
sdui
- the SDUIpublic void setSdui(String sdui)
setSourceDescriptor(String)
.
setSdui
in interface Atom
sdui
- the SDUIpublic String getScui()
getSourceConceptIdentifier()
.
getScui
in interface Atom
public String getSourceConceptIdentifier()
getSourceConceptIdentifier
in interface Atom
public void setScui(String scui)
setSourceConceptIdentifier(String)
.
setScui
in interface Atom
scui
- the SCUIpublic void setSourceConceptIdentifier(String scui)
setSourceConceptIdentifier
in interface Atom
scui
- the SCUIpublic String getCode()
getCode
in interface Atom
public void setCode(String code)
setCode
in interface Atom
code
- the codepublic String getAui()
getAtomIdentifier()
.
getAui
in interface Atom
public void setAui(String aui)
setAtomIdentifier(String)
.
setAui
in interface Atom
aui
- the AUIpublic String getAtomIdentifier()
Atom
.
getAtomIdentifier
in interface Atom
public void setAtomIdentifier(String aui)
Atom
.
setAtomIdentifier
in interface Atom
aui
- the AUIpublic Source getSource()
Atom
.
getSource
in interface SourceElement
Source
public void setSource(Source source)
Atom
.
setSource
in interface SourceElement
source
- Source
public Suppressible getSuppress()
getSuppress
in interface SuppressibleElement
Suppressible
valuepublic boolean isSuppressible()
Atom
is suppressible.
isSuppressible
in interface SuppressibleElement
true
if suppressible,
false
if not suppressiblepublic void setSuppress(Suppressible suppress)
setSuppress
in interface SuppressibleElement
suppress
- the Suppressible
valuepublic String getIspref()
Atom
is
preferred (ISPREF).
getIspref
in interface Atom
Atom
is
preferredpublic void setIspref(String ispref)
Atom
is
preferred (ISPREF).
setIspref
in interface Atom
ispref
- the flag indicating whether or not this Atom
is
preferredpublic boolean hasPreferredAtomIdentifier()
Atom
is the preferred atom identifier
for its Concept
and string identifier.
hasPreferredAtomIdentifier
in interface Atom
true
if so, false
otherwisepublic boolean hasPreferredAui()
hasPreferredAtomIdentifier()
.
hasPreferredAui
in interface Atom
true
if so, false
otherwisepublic ContentView getContentView()
ContentView
definition for this Atom
(CVF).
getContentView
in interface ContentViewElement
ContentView
definitionpublic void setContentView(ContentView cvf)
ContentView
definition for this Atom
(CVF).
setContentView
in interface ContentViewElement
cvf
- the ContentView
definitionpublic ContentView getCvf()
getContentView()
.
getCvf
in interface ContentViewElement
ContentView
definitionpublic void setCvf(ContentView cvf)
setContentView(ContentView)
.
setCvf
in interface ContentViewElement
cvf
- the ContentView
definitionpublic Relationship[] getRelationships(Restrictor restrictor)
Atom
's Relationship
s.
Restricts the return based on the given Restrictor
.
getRelationships
in interface Atom
restrictor
- Restrictor
public boolean isObsolete()
AtomImpl
is obsolete.
isObsolete
in interface SuppressibleElement
true
if obsolete,
false
if not obsolete
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |