gov.nih.nlm.nls.tc.Api
Class StriApi

java.lang.Object
  gov.nih.nlm.nls.tc.Api.JdiApi
      gov.nih.nlm.nls.tc.Api.StriApi

public class StriApi
extends JdiApi

This class provides Semantic Type Realtime Indexing API. It takes a term or ID|term as input

History:

Version:

V-2011

Author:

NLM Lexical Systems Group

Field Summary

Fields inherited from class gov.nih.nlm.nls.tc.Api.JdiApi

conf_, configFile_, conn_, inputFilter_, jds_, legalWords_, shs_, verbose_, wordExtractionFilter_

Constructor Summary

StriApi(Configuration conf)
Creates an StriApi object and initiate related data, using a specified configuration object.

StriApi(Configuration conf, JournalDescriptors jds, Subheadings shs)
Creates an StriApi object and initiate related data, using a specified configuration object, journal descritor object, and subHeadings object.

StriApi(Configuration conf, JournalDescriptors jds, Subheadings shs, SemanticTypes sts)
Creates an StriApi object and initiate related data, using a specified configuration object, journal descritor object, subHeadings object, and semantic types object.

StriApi(java.sql.Connection conn)
Creates an StriApi object and initiate related data, using a specified database connection object.

StriApi(java.sql.Connection conn, JournalDescriptors jds, Subheadings shs)
Creates an StriApi object and initiate related data, using a specified db connection object, journal descritor object, and subHeadings object.

StriApi(java.util.Hashtable<java.lang.String,java.lang.String> properties)
Creates an StriApi object and initiate related data, using a specified properties to be overwritten in configuration.

StriApi(java.lang.String configFile)
Creates an StriApi object and initiate related data, using a specified configuration file.

Method Summary

java.lang.String	GetDetailScoreStrByMesh(java.lang.String inMeshStr, InputFilterOption inputFilterOption, OutputFilterOption outputFilterOption) Get ST detail scores in String for MeSHs.
java.lang.String	GetDetailScoreStrByText(java.lang.String inTextStr, InputFilterOption inputFilterOption, OutputFilterOption outputFilterOption) Get ST detail scores in String for words.
SemanticTypes	GetSemanticTypes() Get the Semantic Types object.
java.util.Vector<Count1f>	GetStriScoresByMesh(java.lang.String inMeshStr) Get ST scores by MeSHs.
java.util.Vector<Count2f>	GetStriScoresByText(java.lang.String inTextStr, InputFilterOption inputFilterOption) Get ST scores by text.
java.util.Vector<Count2f>	GetStriScoresByText(java.lang.String inTextStr, InputFilterOption inputFilterOption, boolean verbose) Get ST scores by text.

Methods inherited from class gov.nih.nlm.nls.tc.Api.JdiApi

Close, GetDetailScoreStrByTextMesh, GetInputFilter, GetJdiScoresByMesh, GetJdiScoresByMesh, GetJdiScoresByText, GetJdiScoresByText, GetJdiScoresByTextMesh, GetJdiScoresByTextMesh, GetJournalDescriptors

Methods inherited from class java.lang.Object

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

Constructor Detail

StriApi

public StriApi(Configuration conf)

Creates an StriApi object and initiate related data, using a specified configuration object.

Close( ) method must be called to close Db connection after using a StriApi object.

Parameters:

conf - Configuration object

StriApi

public StriApi(java.lang.String configFile)

Creates an StriApi object and initiate related data, using a specified configuration file.

Close( ) method must be called to close Db connection after using a StiApi object.

Parameters:

configFile - the absolute path of the configuration file

StriApi

public StriApi(java.sql.Connection conn)

Creates an StriApi object and initiate related data, using a specified database connection object.

Close( ) method must be called to close Db connection after using a StiApi object.

Parameters:

conn - Db connection object

StriApi

public StriApi(java.util.Hashtable<java.lang.String,java.lang.String> properties)

Creates an StriApi object and initiate related data, using a specified properties to be overwritten in configuration.

Close( ) method must be called to close Db connection after using a StiApi object.

Parameters:

properties - properties to be overwrite in configuration

StriApi

public StriApi(Configuration conf,
               JournalDescriptors jds,
               Subheadings shs)

Creates an StriApi object and initiate related data, using a specified configuration object, journal descritor object, and subHeadings object.

Close( ) method must be called to close Db connection after using a StriApi object.

Parameters:

conf - configuration object

jds - Journal descriptor object

shs - MeSH subHeading object

StriApi

public StriApi(Configuration conf,
               JournalDescriptors jds,
               Subheadings shs,
               SemanticTypes sts)

Creates an StriApi object and initiate related data, using a specified configuration object, journal descritor object, subHeadings object, and semantic types object.

Close( ) method must be called to close Db connection after using a StriApi object.

Parameters:

conf - configuration object

jds - Journal descriptor object

shs - MeSH subHeading object

sts - Semantic types object

StriApi

public StriApi(java.sql.Connection conn,
               JournalDescriptors jds,
               Subheadings shs)

Creates an StriApi object and initiate related data, using a specified db connection object, journal descritor object, and subHeadings object.

Close( ) method must be called to close Db connection after using a StriApi object.

Parameters:

conn - db connection object

jds - Journal descriptor object

shs - MeSH subHeading object

Method Detail

GetStriScoresByMesh

public java.util.Vector<Count1f> GetStriScoresByMesh(java.lang.String inMeshStr)

Get ST scores by MeSHs.

Parameters:

inMeshStr - input starred MeSH (separated by "|")

Returns:

ST scores, a Vector of Count1f objects

GetStriScoresByText

public java.util.Vector<Count2f> GetStriScoresByText(java.lang.String inTextStr,
                                                     InputFilterOption inputFilterOption)

Get ST scores by text.

Parameters:

inTextStr - input text (phrase, TI, AB)

inputFilterOption - the inputFilter option java object

Returns:

ST scores, a Vector of Count2f objects

GetStriScoresByText

public java.util.Vector<Count2f> GetStriScoresByText(java.lang.String inTextStr,
                                                     InputFilterOption inputFilterOption,
                                                     boolean verbose)

Get ST scores by text.

Parameters:

inTextStr - input text (phrase, TI, AB)

inputFilterOption - the inputFilter option java object

verbose - boolean flag for verbose message

Returns:

ST scores, a Vector of Count2f objects

GetDetailScoreStrByMesh

public java.lang.String GetDetailScoreStrByMesh(java.lang.String inMeshStr,
                                                InputFilterOption inputFilterOption,
                                                OutputFilterOption outputFilterOption)

Get ST detail scores in String for MeSHs.

Overrides:

GetDetailScoreStrByMesh in class JdiApi

Parameters:

inMeshStr - input MeSHs (MH or SH)

inputFilterOption - the inputFilter option java object

outputFilterOption - the output filter option java object

Returns:

ST detail score in String

GetDetailScoreStrByText

public java.lang.String GetDetailScoreStrByText(java.lang.String inTextStr,
                                                InputFilterOption inputFilterOption,
                                                OutputFilterOption outputFilterOption)

Get ST detail scores in String for words.

Overrides:

GetDetailScoreStrByText in class JdiApi

Parameters:

inTextStr - input text (phrase, TI, AB)

inputFilterOption - the inputFilter option java object

outputFilterOption - the output filter option java object

Returns:

ST detail score in String

GetSemanticTypes

public SemanticTypes GetSemanticTypes()

Get the Semantic Types object.

Returns:

Semantic Types java object