gov.nih.nlm.nls.nlp.textfeatures
Class UMLS_StringPointer

java.lang.Object
  gov.nih.nlm.nls.nlp.textfeatures.UMLS_StringPointer

All Implemented Interfaces:

java.io.Serializable

public class UMLS_StringPointer
extends java.lang.Object
implements java.io.Serializable

UMLS_StringPointer Tue Sep 10 11:47:12 EDT 2002, divita Initial Version

See Also:

Serialized Form

Field Summary

(package private) static long

serialVersionUID serialization version unique identifier for this class.

Constructor Summary

UMLS_StringPointer()
This is a constructor for UMLS_StringPointer This constructor has no parameters

UMLS_StringPointer(java.lang.String pUMLS_StringName, java.lang.String pNormalizedString, java.lang.String pSUI, int pSUIHash, int[] pCUIS, int pScore)
This is a constructor for UMLS_StringPointer

Method Summary

void	addSources(UMLSSourceInfo[] pSources) Method addSources adds sources to this String.
static java.lang.String	convertSui(int pSuiHash) Method convertSui
static UMLS_StringPointer	fromBytes(byte[] pBytes) Method fromBytes
int[]	getCuis() Method getCuis
java.lang.String	getName() Method getName
java.lang.String	getNormalizedString() Method getNormalizedString returns the name, lowercased, for the purposes of easier matching.
int	getScore() Method getScore
UMLSSourceInfo[]	getSources() Method getSources retrieves sources to this String.
java.lang.String	getSUI() Method getSUI
int	getSUIHash() Method getSUIHash
java.util.Vector	getTokens() Method getTokens retrieves the set of nlp.tokenized tokens of this container of this.name
java.lang.String	getUMLSString() Method getUMLSString retrieves the UMLS String name.
void	setCuis(int[] pCuis) Method setCuis
void	setScore(int pScore) Method setScore
void	setTokens(java.util.Vector pTokens) Method setTokens associates a set of nlp.tokenized tokens to this container of this.name
byte[]	toBytes() Method toBytes
java.lang.String	toPipedString() Method toPipedString
java.lang.String	toString() Method toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

serialization version unique identifier for this class.

See Also:

Constant Field Values

Constructor Detail

UMLS_StringPointer

public UMLS_StringPointer()

This is a constructor for UMLS_StringPointer This constructor has no parameters

UMLS_StringPointer

public UMLS_StringPointer(java.lang.String pUMLS_StringName,
                          java.lang.String pNormalizedString,
                          java.lang.String pSUI,
                          int pSUIHash,
                          int[] pCUIS,
                          int pScore)

This is a constructor for UMLS_StringPointer

Parameters:

pUMLS_StringName -

pSUI -

pSUIHash -

pCUIS -

pScore -

Method Detail

getSUI

public java.lang.String getSUI()

Method getSUI

Returns:

String

getName

public java.lang.String getName()

Method getName

Returns:

String

getUMLSString

public java.lang.String getUMLSString()

Method getUMLSString retrieves the UMLS String name. This is the same as the getName() method.

Returns:

String

getScore

public int getScore()

Method getScore

Returns:

int

setScore

public void setScore(int pScore)

Method setScore

Parameters:

pScore -

setCuis

public void setCuis(int[] pCuis)

Method setCuis

Parameters:

pCuis -

addSources

public void addSources(UMLSSourceInfo[] pSources)

Method addSources adds sources to this String. If this string is ambiguous, say, the term "Tear", S0001805. This is associated with three concepts - Individual vocabularies only contributed to one concept - so, the source of this string has to be looked at in the context of what concept it represents - thus, the introduction of the Atom C0035955 -- Reed Code and SNOMEDCT C0039409 -- MeSH, and UWDA C0043246 -- Metathesaurus and Snomed95 It would be a mistake to, in the context of C0039409, say the source of S001805 was SNOMEDCT. So, the retrieval of sources need to be done within the context of the concept. Sources are seen in the context of the concepts, so on one pass, two sources for that concept might come in, on a second pass with a second cui, the next two, and so on.

Parameters:

pSources -

getSources

public UMLSSourceInfo[] getSources()

Method getSources retrieves sources to this String. It should be noted that this method does not return sources that have been blocked based on the --excludeSources or --restrictToSources options.

toString

public java.lang.String toString()

Method toString

Overrides:

toString in class java.lang.Object

Returns:

String

toPipedString

public java.lang.String toPipedString()

Method toPipedString

Returns:

String

toBytes

public byte[] toBytes()
               throws java.lang.Exception

Method toBytes

Returns:

byte[]

Throws:

java.lang.Exception

fromBytes

public static UMLS_StringPointer fromBytes(byte[] pBytes)
                                    throws java.lang.Exception

Method fromBytes

Parameters:

pBytes -

Returns:

UMLS_StringPointer

Throws:

java.lang.Exception

getNormalizedString

public java.lang.String getNormalizedString()

Method getNormalizedString returns the name, lowercased, for the purposes of easier matching.

Returns:

String

getSUIHash

public int getSUIHash()

Method getSUIHash

Returns:

int

getCuis

public int[] getCuis()

Method getCuis

Returns:

int[]

convertSui

public static java.lang.String convertSui(int pSuiHash)

Method convertSui

Parameters:

pSuiHash -

Returns:

String

setTokens

public void setTokens(java.util.Vector pTokens)

Method setTokens associates a set of nlp.tokenized tokens to this container of this.name

Parameters:

pTokens -

getTokens

public java.util.Vector getTokens()

Method getTokens retrieves the set of nlp.tokenized tokens of this container of this.name

Returns:

ArrayList