org.jobimtext.api.db

Class DatabaseThesaurus

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.jobimtext.api.db.DatabaseResource

org.jobimtext.api.db.DatabaseThesaurus

All Implemented Interfaces:

org.apache.uima.resource.Resource, IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

public class DatabaseThesaurus
extends DatabaseResource
implements IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Field Summary

Fields inherited from class org.jobimtext.api.db.DatabaseResource

PARAM_DB_CONFIGURATION_FILE, PARAM_TUNNEL_CONFIGURATION_FILE

Fields inherited from interface org.apache.uima.resource.Resource

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors

Constructor and Description
DatabaseThesaurus()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	getContextsCount(java.lang.String values) Get the context count from the corpus
java.sql.ResultSet	getContextsTermScores(java.lang.String key) Get all term-context scores for a given context
java.sql.ResultSet	getContextsTermScores(java.lang.String key, double threshold) Get all term-context scores for a given context, using a score threshold
java.sql.ResultSet	getContextsTermScores(java.lang.String key, int numberOfEntries) Get the top n term-context scores for a given context
java.sql.ResultSet	getIsas(java.lang.String key) Get all senses for the input term, using the standard sense type
java.sql.ResultSet	getIsas(java.lang.String key, java.lang.String type) Get all senses for the input term, with a specified sense type
java.sql.ResultSet	getSenseCUIs(java.lang.String key) Get all senses for the input term, using the standard sense type
java.sql.ResultSet	getSenseCUIs(java.lang.String key, java.lang.String type) Get all senses for the input term, with a specified sense type
java.sql.ResultSet	getSenses(java.lang.String key) Get all senses for the input term, using the standard sense type
java.sql.ResultSet	getSenses(java.lang.String key, java.lang.String type) Get all senses for the input term, with a specified sense type
java.lang.String[]	getSensesTypes() Get all possible sense types available
java.sql.ResultSet	getSimilarContexts(java.lang.String values) Get a list of all similar contexts for a given context
java.sql.ResultSet	getSimilarContexts(java.lang.String values, double threshold) Get a list of all similar contexts for a given context, minimal similarity score is specified
java.sql.ResultSet	getSimilarContexts(java.lang.String values, int numberOfEntries) Get a list of all similar contexts for a given context, maximal number is specified
java.sql.ResultSet	getSimilarTerms(java.lang.String key) Get a list of all similar terms for a given term.
java.sql.ResultSet	getSimilarTerms(java.lang.String key, double threshold) Get a list of similar terms for a given term, minimal similarity score is specified
java.sql.ResultSet	getSimilarTerms(java.lang.String key, int numberOfEntries) Get a list of similar terms for a given term, maximal number is specified
java.lang.Double	getSimilarTermScore(java.lang.String t1, java.lang.String t2) Retrieve the similarity score between two terms.
java.lang.String	getStandardSense() Get the name of the standard sense inventory type
java.lang.Long	getTermContextsCount(java.lang.String key, java.lang.String values) Get the term-context count from the corpus
java.lang.Double	getTermContextsScore(java.lang.String key, java.lang.String val) Get the significance score of a term-context combination
java.sql.ResultSet	getTermContextsScores(java.lang.String key) Get all term-context scores for a given term
java.sql.ResultSet	getTermContextsScores(java.lang.String key, double threshold) Get all term-context scores for a given term, using a score threshold
java.sql.ResultSet	getTermContextsScores(java.lang.String key, int numberOfEntries) Get the top n term-context scores for a given term
java.lang.Long	getTermCount(java.lang.String key) Get the term count from the corpus
java.lang.String[]	isContextsContained(java.lang.String... key) Checks which contexts from the input list are contained in the resource
boolean	isContextsContained(java.lang.String key) Checks whether the context is contained in the resource
java.lang.String[]	isTermContained(java.lang.String... key) Checks whether a list of terms is contained in the resource
boolean	isTermContained(java.lang.String key) Checks whether the term is contained in the resource
java.lang.String[]	isXContained(java.lang.String sql, java.lang.String... key)

Methods inherited from class org.jobimtext.api.db.DatabaseResource

connect, destroy, getDatabaseConfiguration, getDatabaseConnection, getDbConf, getDbConfigurationFile, getTunnelConfigurationFile, initialize, setDatabaseConnection, setDbConf, setDbConfigurationFile, setTunnelConfigurationFile

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jobimtext.api.IThesaurus

connect, destroy

Constructor Detail

DatabaseThesaurus

public DatabaseThesaurus()

Method Detail

getSimilarTerms

public java.sql.ResultSet getSimilarTerms(java.lang.String key)

Description copied from interface: IThesaurus

Get a list of all similar terms for a given term.

Specified by:

getSimilarTerms in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

Returns:

list of similar terms with scores

getSimilarTerms

public java.sql.ResultSet getSimilarTerms(java.lang.String key,
                                 int numberOfEntries)

Description copied from interface: IThesaurus

Get a list of similar terms for a given term, maximal number is specified

Specified by:

getSimilarTerms in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

numberOfEntries - the maximal number of items to retrieve

Returns:

list of similar terms with scores

getSimilarTerms

public java.sql.ResultSet getSimilarTerms(java.lang.String key,
                                 double threshold)

Description copied from interface: IThesaurus

Get a list of similar terms for a given term, minimal similarity score is specified

Specified by:

getSimilarTerms in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

threshold - the minimal similarity score

Returns:

list of similar terms with scores

getSimilarContexts

public java.sql.ResultSet getSimilarContexts(java.lang.String values)

Description copied from interface: IThesaurus

Get a list of all similar contexts for a given context

Specified by:

getSimilarContexts in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

values - the input context

Returns:

list of similar contexts with scores

getSimilarContexts

public java.sql.ResultSet getSimilarContexts(java.lang.String values,
                                    int numberOfEntries)

Description copied from interface: IThesaurus

Get a list of all similar contexts for a given context, maximal number is specified

Specified by:

getSimilarContexts in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

values - the input context

numberOfEntries - the maximal number of items to retrieve

Returns:

list of similar contexts with scores

getSimilarContexts

public java.sql.ResultSet getSimilarContexts(java.lang.String values,
                                    double threshold)

Description copied from interface: IThesaurus

Get a list of all similar contexts for a given context, minimal similarity score is specified

Specified by:

getSimilarContexts in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

values - the input context

threshold - the minimal similarity score

Returns:

list of similar contexts with scores

getTermCount

public java.lang.Long getTermCount(java.lang.String key)

Description copied from interface: IThesaurus

Get the term count from the corpus

Specified by:

getTermCount in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

Returns:

the frequency count

getContextsCount

public java.lang.Long getContextsCount(java.lang.String values)

Description copied from interface: IThesaurus

Get the context count from the corpus

Specified by:

getContextsCount in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

values - the input context

Returns:

the frequency count

getTermContextsCount

public java.lang.Long getTermContextsCount(java.lang.String key,
                                  java.lang.String values)

Description copied from interface: IThesaurus

Get the term-context count from the corpus

Specified by:

getTermContextsCount in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

values - the input context

Returns:

the frequency count

getTermContextsScore

public java.lang.Double getTermContextsScore(java.lang.String key,
                                    java.lang.String val)

Description copied from interface: IThesaurus

Get the significance score of a term-context combination

Specified by:

getTermContextsScore in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

val - the input context

Returns:

the significance score

getTermContextsScores

public java.sql.ResultSet getTermContextsScores(java.lang.String key)

Description copied from interface: IThesaurus

Get all term-context scores for a given term

Specified by:

getTermContextsScores in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

Returns:

list of contexts, containing the significance scores and counts

getTermContextsScores

public java.sql.ResultSet getTermContextsScores(java.lang.String key,
                                       int numberOfEntries)

Description copied from interface: IThesaurus

Get the top n term-context scores for a given term

Specified by:

getTermContextsScores in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

numberOfEntries - the maximum number of entries to return

Returns:

list of contexts, containing the significance scores and counts

getTermContextsScores

public java.sql.ResultSet getTermContextsScores(java.lang.String key,
                                       double threshold)

Description copied from interface: IThesaurus

Get all term-context scores for a given term, using a score threshold

Specified by:

getTermContextsScores in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

threshold - the minimal significance score

Returns:

list of contexts, containing the significance scores and counts

getSimilarTermScore

public java.lang.Double getSimilarTermScore(java.lang.String t1,
                                   java.lang.String t2)

Description copied from interface: IThesaurus

Retrieve the similarity score between two terms. Note, that this score is not necessarily symmetric!

Specified by:

getSimilarTermScore in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

t1 - term1

t2 - term2

Returns:

the similarity score

getContextsTermScores

public java.sql.ResultSet getContextsTermScores(java.lang.String key)

Description copied from interface: IThesaurus

Get all term-context scores for a given context

Specified by:

getContextsTermScores in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input context

Returns:

list of terms, containing the significance scores and counts

getContextsTermScores

public java.sql.ResultSet getContextsTermScores(java.lang.String key,
                                       int numberOfEntries)

Description copied from interface: IThesaurus

Get the top n term-context scores for a given context

Specified by:

getContextsTermScores in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input context

numberOfEntries - the maximum number of entries to return

Returns:

list of terms, containing the significance scores and counts

getContextsTermScores

public java.sql.ResultSet getContextsTermScores(java.lang.String key,
                                       double threshold)

Description copied from interface: IThesaurus

Get all term-context scores for a given context, using a score threshold

Specified by:

getContextsTermScores in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input context

threshold - the minimal significance score

Returns:

list of contexts, containing the significance scores and counts

getSenses

public java.sql.ResultSet getSenses(java.lang.String key)

Description copied from interface: IThesaurus

Get all senses for the input term, using the standard sense type

Specified by:

getSenses in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

Returns:

a list of all senses for the input term

getIsas

public java.sql.ResultSet getIsas(java.lang.String key)

Description copied from interface: IThesaurus

Get all senses for the input term, using the standard sense type

Specified by:

getIsas in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

Returns:

a list of all senses for the input term

getSenseCUIs

public java.sql.ResultSet getSenseCUIs(java.lang.String key)

Description copied from interface: IThesaurus

Get all senses for the input term, using the standard sense type

Specified by:

getSenseCUIs in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

Returns:

a list of all senses for the input term

getSenses

public java.sql.ResultSet getSenses(java.lang.String key,
                           java.lang.String type)

Description copied from interface: IThesaurus

Get all senses for the input term, with a specified sense type

Specified by:

getSenses in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

type - the required sense type

Returns:

a list of all senses for the input term

getIsas

public java.sql.ResultSet getIsas(java.lang.String key,
                         java.lang.String type)

Description copied from interface: IThesaurus

Get all senses for the input term, with a specified sense type

Specified by:

getIsas in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

type - the required sense type

Returns:

a list of all senses for the input term

getSenseCUIs

public java.sql.ResultSet getSenseCUIs(java.lang.String key,
                              java.lang.String type)

Description copied from interface: IThesaurus

Get all senses for the input term, with a specified sense type

Specified by:

getSenseCUIs in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input term

type - the required sense type

Returns:

a list of all senses for the input term

isTermContained

public boolean isTermContained(java.lang.String key)

Description copied from interface: IThesaurus

Checks whether the term is contained in the resource

Specified by:

isTermContained in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - input term

Returns:

true, if the term is contained

isXContained

public java.lang.String[] isXContained(java.lang.String sql,
                              java.lang.String... key)

isTermContained

public java.lang.String[] isTermContained(java.lang.String... key)

Description copied from interface: IThesaurus

Checks whether a list of terms is contained in the resource

Specified by:

isTermContained in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - list of input terms that should be checked

Returns:

a list of the terms that are contained

getSensesTypes

public java.lang.String[] getSensesTypes()

Description copied from interface: IThesaurus

Get all possible sense types available

Specified by:

getSensesTypes in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Returns:

a list of the sense types names

getStandardSense

public java.lang.String getStandardSense()

Description copied from interface: IThesaurus

Get the name of the standard sense inventory type

Specified by:

getStandardSense in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Returns:

the standard sense type

isContextsContained

public boolean isContextsContained(java.lang.String key)

Description copied from interface: IThesaurus

Checks whether the context is contained in the resource

Specified by:

isContextsContained in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - the input context

Returns:

true, if the term is contained

isContextsContained

public java.lang.String[] isContextsContained(java.lang.String... key)

Description copied from interface: IThesaurus

Checks which contexts from the input list are contained in the resource

Specified by:

isContextsContained in interface IThesaurus<java.lang.String,java.lang.String,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet,java.sql.ResultSet>

Parameters:

key - list of contexts that are checked

Returns:

a list of the contexts that are contained