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

java.lang.Object
  gov.nih.nlm.umls.meta.impl.PlaceholderAtom

All Implemented Interfaces:

Atom, ConceptElement, ContentViewElement, SourceElement, SuppressibleElement, Comparable

Direct Known Subclasses:

AtomImpl

public class PlaceholderAtom
extends Object
implements Atom

Implementation of the Atom interface.

Author:

Brian Carlsen, Deborah Shapiro

Nested Class Summary

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

Atom.AtomRankComparator, Atom.ByLanguageRestrictor

Nested classes/interfaces inherited from interface 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 AtomAttributes.
void	clearContexts() Remove all Contexts.
void	clearCoocurrences() Remove all Coocurrences.
void	clearDefinitions() Remove all Definitions.
void	clearLocators() Remove all Locators.
void	clearRelationships() Remove all Relationships.
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 AtomAttributes.
List	getAttributesAsList() Returns the AtomAttributes 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 Contexts.
List	getContextsAsList() Returns the Contexts as a List.
Coocurrence[]	getCoocurrences() Returns the Coocurrences.
List	getCoocurrencesAsList() Returns the Coocurrences as a List.
ContentView	getCvf() Shorthand for getContentView().
Definition[]	getDefinitions() Returns the Definitions.
List	getDefinitionsAsList() Returns the Definitions 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 Locators.
List	getLocatorsAsList() Returns the Locators as a List.
String	getLui() Shorthand for getTermIdentifier().
String	getName() Sets the name (STR).
Relationship[]	getRelationships() Returns the Relationships.
Relationship[]	getRelationships(Restrictor restrictor) Returns a subset of this Atom's Relationships.
List	getRelationshipsAsList() Returns the Relationships 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 AtomAttributes with the ones in the specified array.
void	setAttributes(List atts) Replace AtomAttributes 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 Contexts with the ones in the specified array.
void	setContexts(List cxts) Replace Contexts with the ones in the specified List.
void	setCoocurrences(Coocurrence[] cocs) Replace Coocurrences with the ones in the specified array.
void	setCoocurrences(List cocs) Replace Coocurrences with the ones in the specified List.
void	setCvf(ContentView cvf) Shorthand for setContentView(ContentView).
void	setDefinitions(Definition[] defs) Replace Definitions with the ones in the specified array.
void	setDefinitions(List defs) Replace Definitions 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 Locators with the ones in the specified List.
void	setLocators(Locator[] locs) Replace Locators 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 Relationships of the ones in the specified List.
void	setRelationships(Relationship[] rels) Replace Relationships 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

concept

protected Concept concept

tty

protected TermType tty

lat

protected Language lat

ts

protected TermStatus ts

lui

protected String lui

stt

protected StringType stt

sui

protected String sui

str

protected String str

saui

protected String saui

scui

protected String scui

sdui

protected String sdui

code

protected String code

aui

protected String aui

suppress

protected Suppressible suppress

ispref

protected String ispref

source

protected Source source

cvf

protected ContentView cvf

key_fields_flag

protected boolean key_fields_flag

key_fields

protected String key_fields

Constructor Detail

PlaceholderAtom

public PlaceholderAtom()

Instantiates an empty PlaceholderAtom.

PlaceholderAtom

public PlaceholderAtom(Atom atom)

Instantiates a PlaceholderAtom from the specified Atom.

Parameters:

atom - Atom to be copied

Method Detail

getConcept

public Concept getConcept()

Returns the Concept that holds this Atom.

Specified by:

getConcept in interface ConceptElement

Returns:

the Concept that holds this Atom

setConcept

public void setConcept(Concept concept)

Sets the Concept that holds this Atom.

Specified by:

setConcept in interface ConceptElement

Parameters:

concept - the Concept that holds this Atom

getTermType

public TermType getTermType()

Returns the TermType (TTY).

Specified by:

getTermType in interface Atom

Returns:

the TermType

getTty

public TermType getTty()

Shorthand for getTermType().

Specified by:

getTty in interface Atom

Returns:

the TermType

setTermType

public void setTermType(TermType tty)

Sets the TermType (TTY).

Specified by:

setTermType in interface Atom

Parameters:

tty - the TermType

setTty

public void setTty(TermType tty)

Shorthand for setTermType(TermType).

Specified by:

setTty in interface Atom

Parameters:

tty - the TermType

getLanguage

public Language getLanguage()

Returns the Language (LAT).

Specified by:

getLanguage in interface Atom

Returns:

the Language

getLat

public Language getLat()

Shorthand for getLanguage().

Specified by:

getLat in interface Atom

Returns:

Language

setLanguage

public void setLanguage(Language lat)

Sets the Language (LAT).

Specified by:

setLanguage in interface Atom

Parameters:

lat - the Language

setLat

public void setLat(Language lat)

Shorthand for setLanguage(Language).

Specified by:

setLat in interface Atom

Parameters:

lat - the Language

hasPreferredTermIdentifier

public boolean hasPreferredTermIdentifier()

Indicates whether or not this atom is part of the preferred lexical class of the Concept. In other words, does this Atom have the same LUI as the preferred Atom of the Concept.

Specified by:

hasPreferredTermIdentifier in interface Atom

Returns:

true if so, false otherwise

hasPreferredLui

public boolean hasPreferredLui()

Shorthand for hasPreferredTermIdentifier()

Specified by:

hasPreferredLui in interface Atom

Returns:

true if so, false otherwise

getTermStatus

public TermStatus getTermStatus()

Returns the TermStatus (TS).

Specified by:

getTermStatus in interface Atom

Returns:

the TermStatus

getTs

public TermStatus getTs()

Shorthand for getTermStatus().

Specified by:

getTs in interface Atom

Returns:

the TermStatus

setTermStatus

public void setTermStatus(TermStatus ts)

Sets the TermStatus (TS).

Specified by:

setTermStatus in interface Atom

Parameters:

ts - the TermStatus

setTs

public void setTs(TermStatus ts)

Shorthand for setTermStatus(TermStatus).

Specified by:

setTs in interface Atom

Parameters:

ts - the TermStatus

getLui

public String getLui()

Shorthand for getTermIdentifier().

Specified by:

getLui in interface Atom

Returns:

the LUI

setLui

public void setLui(String lui)

Shorthand for setTermIdentifier(String).

Specified by:

setLui in interface Atom

Parameters:

lui - the LUI

getTermIdentifier

public String getTermIdentifier()

Returns the term identifier (LUI).

Specified by:

getTermIdentifier in interface Atom

Returns:

the LUI

setTermIdentifier

public void setTermIdentifier(String lui)

Sets the term identifier (LUI).

Specified by:

setTermIdentifier in interface Atom

Parameters:

lui - the LUI

hasPreferredStringIdentifier

public boolean hasPreferredStringIdentifier()

Indicates whether or not this atom has the preferred string identifier of the lexical class it is part of. In other words, does this Atom have the same SUI as the preferred Atom of the lexical class.

Specified by:

hasPreferredStringIdentifier in interface Atom

Returns:

true if so, false otherwise

hasPreferredSui

public boolean hasPreferredSui()

Shorthand for hasPreferredStringIdentifier().

Specified by:

hasPreferredSui in interface Atom

Returns:

true if so, false otherwise

getStringType

public StringType getStringType()

Returns the StringType (STT).

Specified by:

getStringType in interface Atom

Returns:

the StringType

getStt

public StringType getStt()

Shorthand for getStringType().

Specified by:

getStt in interface Atom

Returns:

the StringType

setStringType

public void setStringType(StringType stt)

Sets the StringType (STT).

Specified by:

setStringType in interface Atom

Parameters:

stt - the STT

setStt

public void setStt(StringType stt)

Shorthand for setStringType(StringType).

Specified by:

setStt in interface Atom

Parameters:

stt - the STT

getSui

public String getSui()

Shorthand for getStringIdentifier().

Specified by:

getSui in interface Atom

Returns:

the SUI

setSui

public void setSui(String sui)

Shorthand for setStringIdentifier(String).

Specified by:

setSui in interface Atom

Parameters:

sui - the SUI

getStringIdentifier

public String getStringIdentifier()

Return the string identifier (SUI).

Specified by:

getStringIdentifier in interface Atom

Returns:

the SUI

setStringIdentifier

public void setStringIdentifier(String sui)

Sets the string identifier (SUI).

Specified by:

setStringIdentifier in interface Atom

Parameters:

sui - the SUI

getName

public String getName()

Sets the name (STR).

Specified by:

getName in interface Atom

Returns:

the name

getStr

public String getStr()

Shorthand for getName().

Specified by:

getStr in interface Atom

Returns:

the name

setName

public void setName(String str)

Sets the name (STR).

Specified by:

setName in interface Atom

Parameters:

str - the name

setStr

public void setStr(String str)

Shorthand for setName(String).

Specified by:

setStr in interface Atom

Parameters:

str - the name

getDefinitions

public Definition[] getDefinitions()

Returns the Definitions.

Specified by:

getDefinitions in interface Atom

Returns:

a Definition []

getDefinitionsAsList

public List getDefinitionsAsList()

Returns the Definitions as a List.

Specified by:

getDefinitionsAsList in interface Atom

Returns:

the Definitions as a List

addDefinition

public void addDefinition(Definition def)

Adds the specified Definition.

Specified by:

addDefinition in interface Atom

Parameters:

def - the Definition to be added

removeDefinition

public void removeDefinition(Definition def)

Remove the specified Definition.

Specified by:

removeDefinition in interface Atom

Parameters:

def - the Definition to be removed

clearDefinitions

public void clearDefinitions()

Remove all Definitions.

Specified by:

clearDefinitions in interface Atom

setDefinitions

public void setDefinitions(Definition[] defs)

Replace Definitions with the ones in the specified array.

Specified by:

setDefinitions in interface Atom

Parameters:

defs - a Definition []

setDefinitions

public void setDefinitions(List defs)

Replace Definitions with the ones in the specified List.

Specified by:

setDefinitions in interface Atom

Parameters:

defs - a List of Definitions

getLocators

public Locator[] getLocators()

Returns the Locators.

Specified by:

getLocators in interface Atom

Returns:

a Locator []

getLocatorsAsList

public List getLocatorsAsList()

Returns the Locators as a List.

Specified by:

getLocatorsAsList in interface Atom

Returns:

the Locators as a List

addLocator

public void addLocator(Locator loc)

Add the specified Locator.

Specified by:

addLocator in interface Atom

Parameters:

loc - the Locator to be added

removeLocator

public void removeLocator(Locator loc)

Removes the specified Locator.

Specified by:

removeLocator in interface Atom

Parameters:

loc - the Locator to be removed

clearLocators

public void clearLocators()

Remove all Locators.

Specified by:

clearLocators in interface Atom

setLocators

public void setLocators(Locator[] locs)

Replace Locators with the ones in the specified array.

Specified by:

setLocators in interface Atom

Parameters:

locs - a Locator []

setLocators

public void setLocators(List locs)

Replace Locators with the ones in the specified List.

Specified by:

setLocators in interface Atom

Parameters:

locs - a List of Locators

getRelationships

public Relationship[] getRelationships()

Returns the Relationships.

Specified by:

getRelationships in interface Atom

Returns:

a Relationship []

getRelationshipsAsList

public List getRelationshipsAsList()

Returns the Relationships as a List.

Specified by:

getRelationshipsAsList in interface Atom

Returns:

the Relationships as a List

addRelationship

public void addRelationship(Relationship rel)

Adds the specified Relationship.

Specified by:

addRelationship in interface Atom

Parameters:

rel - the Relationship to be added

removeRelationship

public void removeRelationship(Relationship rel)

Removes the specified Relationship.

Specified by:

removeRelationship in interface Atom

Parameters:

rel - the Relationship to be removed

clearRelationships

public void clearRelationships()

Remove all Relationships.

Specified by:

clearRelationships in interface Atom

setRelationships

public void setRelationships(Relationship[] rels)

Replace Relationships with the ones in the specified array.

Specified by:

setRelationships in interface Atom

Parameters:

rels - a Relationship []

setRelationships

public void setRelationships(List rels)

Replace Relationships of the ones in the specified List.

Specified by:

setRelationships in interface Atom

Parameters:

rels - a List of Relationships

getCoocurrences

public Coocurrence[] getCoocurrences()

Returns the Coocurrences.

Specified by:

getCoocurrences in interface Atom

Returns:

a Coocurrence []

getCoocurrencesAsList

public List getCoocurrencesAsList()

Returns the Coocurrences as a List.

Specified by:

getCoocurrencesAsList in interface Atom

Returns:

the Coocurrences as a List

addCoocurrence

public void addCoocurrence(Coocurrence coc)

Adds the specified Coocurrence.

Specified by:

addCoocurrence in interface Atom

Parameters:

coc - the Coocurrence to be added

removeCoocurrence

public void removeCoocurrence(Coocurrence coc)

Removes the specified Coocurrence.

Specified by:

removeCoocurrence in interface Atom

Parameters:

coc - the Coocurrence to be removed

clearCoocurrences

public void clearCoocurrences()

Remove all Coocurrences.

Specified by:

clearCoocurrences in interface Atom

setCoocurrences

public void setCoocurrences(Coocurrence[] cocs)

Replace Coocurrences with the ones in the specified array.

Specified by:

setCoocurrences in interface Atom

Parameters:

cocs - a Coocurrence []

setCoocurrences

public void setCoocurrences(List cocs)

Replace Coocurrences with the ones in the specified List.

Specified by:

setCoocurrences in interface Atom

Parameters:

cocs - a List of Coocurrences

getContexts

public Context[] getContexts()

Return the Contexts.

Specified by:

getContexts in interface Atom

Returns:

a Context []

getContextsAsList

public List getContextsAsList()

Returns the Contexts as a List.

Specified by:

getContextsAsList in interface Atom

Returns:

the Contexts as a List

addContext

public void addContext(Context cxt)

Adds the specified Context.

Specified by:

addContext in interface Atom

Parameters:

cxt - the Context to be added

removeContext

public void removeContext(Context cxt)

Removes the specified Context.

Specified by:

removeContext in interface Atom

Parameters:

cxt - the Context to be removed

clearContexts

public void clearContexts()

Remove all Contexts.

Specified by:

clearContexts in interface Atom

setContexts

public void setContexts(Context[] cxts)

Replace Contexts with the ones in the specified array.

Specified by:

setContexts in interface Atom

Parameters:

cxts - a Context []

setContexts

public void setContexts(List cxts)

Replace Contexts with the ones in the specified List.

Specified by:

setContexts in interface Atom

Parameters:

cxts - a List of Contexts

getAttributes

public AtomAttribute[] getAttributes()

Returns the AtomAttributes.

Specified by:

getAttributes in interface Atom

Returns:

a AtomAttribute []

getAttributesAsList

public List getAttributesAsList()

Returns the AtomAttributes as a List.

Specified by:

getAttributesAsList in interface Atom

Returns:

the AtomAttributes as a List

addAttribute

public void addAttribute(AtomAttribute att)

Adds the specified AtomAttribute.

Specified by:

addAttribute in interface Atom

Parameters:

att - the AtomAttribute to be added

removeAttribute

public void removeAttribute(AtomAttribute att)

Removes the specified AtomAttribute.

Specified by:

removeAttribute in interface Atom

Parameters:

att - the AtomAttribute to be removed

clearAttributes

public void clearAttributes()

Remove all AtomAttributes.

Specified by:

clearAttributes in interface Atom

setAttributes

public void setAttributes(AtomAttribute[] atts)

Replace AtomAttributes with the ones in the specified array.

Specified by:

setAttributes in interface Atom

Parameters:

atts - an AtomAttribute []

setAttributes

public void setAttributes(List atts)

Replace AtomAttributes with the ones in the specified List.

Specified by:

setAttributes in interface Atom

Parameters:

atts - a List of AtomAttributes

getKeyFields

public String getKeyFields()

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

Specified by:

getKeyFields in interface Atom

Returns:

a String composed from the cui, aui, sui, versioned source, tty, and code.

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

getSaui

public String getSaui()

Shorthand for getSourceAtomIdentifier().

Specified by:

getSaui in interface Atom

Returns:

the SAUI

getSourceAtomIdentifier

public String getSourceAtomIdentifier()

Returns the source asserted identifier (SAUI) for this Atom.

Specified by:

getSourceAtomIdentifier in interface Atom

Returns:

the SAUI

setSourceAtomIdentifier

public void setSourceAtomIdentifier(String saui)

Sets the source asserted identifier (SAUI) for this Atom.

Specified by:

setSourceAtomIdentifier in interface Atom

Parameters:

saui - the SAUI

setSaui

public void setSaui(String saui)

Shorthand for setSourceAtomIdentifier(String).

Specified by:

setSaui in interface Atom

Parameters:

saui - the SAUI

getSdui

public String getSdui()

Shorthand for getSourceDescriptor().

Specified by:

getSdui in interface Atom

Returns:

the SDUI

getSourceDescriptor

public String getSourceDescriptor()

Returns the source asserted descriptor (SDUI).

Specified by:

getSourceDescriptor in interface Atom

Returns:

the SDUI

setSourceDescriptor

public void setSourceDescriptor(String sdui)

Sets the source asserted descriptor (SDUI).

Specified by:

setSourceDescriptor in interface Atom

Parameters:

sdui - the SDUI

setSdui

public void setSdui(String sdui)

Shorthand for setSourceDescriptor(String).

Specified by:

setSdui in interface Atom

Parameters:

sdui - the SDUI

getScui

public String getScui()

Shorthand for getSourceConceptIdentifier().

Specified by:

getScui in interface Atom

Returns:

the SCUI

getSourceConceptIdentifier

public String getSourceConceptIdentifier()

Returns the source attributed concept identifier (SCUI).

Specified by:

getSourceConceptIdentifier in interface Atom

Returns:

the SCUI

setScui

public void setScui(String scui)

Shorthand for setSourceConceptIdentifier(String).

Specified by:

setScui in interface Atom

Parameters:

scui - the SCUI

setSourceConceptIdentifier

public void setSourceConceptIdentifier(String scui)

Sets the source attributed concept identifier (SCUI).

Specified by:

setSourceConceptIdentifier in interface Atom

Parameters:

scui - the SCUI

getCode

public String getCode()

Return the code (CODE).

Specified by:

getCode in interface Atom

Returns:

the code

setCode

public void setCode(String code)

Sets the code (CODE).

Specified by:

setCode in interface Atom

Parameters:

code - the code

getAui

public String getAui()

Shorthand for getAtomIdentifier().

Specified by:

getAui in interface Atom

Returns:

the AUI

setAui

public void setAui(String aui)

Shorthand for setAtomIdentifier(String).

Specified by:

setAui in interface Atom

Parameters:

aui - the AUI

getAtomIdentifier

public String getAtomIdentifier()

Returns the atom unique identifier (AUI) related to this Atom.

Specified by:

getAtomIdentifier in interface Atom

Returns:

the AUI

setAtomIdentifier

public void setAtomIdentifier(String aui)

Sets the atom unique identifier (AUI) related to this Atom.

Specified by:

setAtomIdentifier in interface Atom

Parameters:

aui - the AUI

getSource

public Source getSource()

Returns the source for this Atom.

Specified by:

getSource in interface SourceElement

Returns:

Source

setSource

public void setSource(Source source)

Sets the source for this Atom.

Specified by:

setSource in interface SourceElement

Parameters:

source - Source

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

getIspref

public String getIspref()

Returns the flag indicating whether or not this Atom is preferred (ISPREF).

Specified by:

getIspref in interface Atom

Returns:

the flag indicating whether or not this Atom is preferred

setIspref

public void setIspref(String ispref)

Sets the flag indicating whether or not this Atom is preferred (ISPREF).

Specified by:

setIspref in interface Atom

Parameters:

ispref - the flag indicating whether or not this Atom is preferred

hasPreferredAtomIdentifier

public boolean hasPreferredAtomIdentifier()

Indicates whether or not this Atom is the preferred atom identifier for its Concept and string identifier.

Specified by:

hasPreferredAtomIdentifier in interface Atom

Returns:

true if so, false otherwise

hasPreferredAui

public boolean hasPreferredAui()

Shorthand for hasPreferredAtomIdentifier().

Specified by:

hasPreferredAui in interface Atom

Returns:

true if so, false otherwise

getContentView

public ContentView getContentView()

Returns tbe ContentView definition for this Atom (CVF).

Specified by:

getContentView in interface ContentViewElement

Returns:

tbe ContentView definition

setContentView

public void setContentView(ContentView cvf)

Sets tbe ContentView definition for this Atom (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

getRelationships

public Relationship[] getRelationships(Restrictor restrictor)

Returns a subset of this Atom's Relationships. Restricts the return based on the given Restrictor.

Specified by:

getRelationships in interface Atom

Parameters:

restrictor - Restrictor

Returns:

Relationship[]

isObsolete

public boolean isObsolete()

Indicates whether or not this AtomImpl is obsolete.

Specified by:

isObsolete in interface SuppressibleElement

Returns:

true if obsolete, false if not obsolete