gov.nih.nlm.nls.lvg.Flows

Class ToDerivation

java.lang.Object

gov.nih.nlm.nls.lvg.Flows.Transformation

gov.nih.nlm.nls.lvg.Flows.ToDerivation

All Implemented Interfaces:

java.lang.Cloneable

public class ToDerivation
extends Transformation
implements java.lang.Cloneable

This class provides features of generating derivational variants. Derivational variants are terms which are somehow related to the original term but do not share the same meaning. Often, the derivational variant changes syntactic category from the original term. Derivational variants are pre-computed and are put in Derivation table in Lvg database (facts). Derivations can also be generated by derivation rules through Lvg trie.

History:

Version:

V-2025

Author:

NLM NLS Development Team

See Also:

Design Document

Field Summary

Fields inherited from class gov.nih.nlm.nls.lvg.Flows.Transformation

NO_MUTATE_INFO, UPDATE

Constructor Summary

Constructors

Constructor and Description
ToDerivation()

Method Summary

Modifier and Type	Method and Description
protected static java.util.Vector<LexItem>	GetDerivations(LexItem in, java.sql.Connection conn, RamTrie trie, int restrictFlag, int derivationType, int derivationNegation, java.lang.String infoStr, boolean detailsFlag, boolean mutateFlag) Get the derivational variants using both facts (database) and rules (trie).
static void	main(java.lang.String[] args) A unit test driver for this flow component.
static java.util.Vector<LexItem>	Mutate(LexItem in, java.sql.Connection conn, RamTrie trie, int restrictFlag, boolean detailsFlag, boolean mutateFlag) Performs the mutation of this flow component.
static java.util.Vector<LexItem>	Mutate(LexItem in, java.sql.Connection conn, RamTrie trie, int restrictFlag, int derivationType, int derivationNegation, boolean detailsFlag, boolean mutateFlag) Performs the mutation of this flow component.

Methods inherited from class gov.nih.nlm.nls.lvg.Flows.Transformation

GetTestStr, PrintResult, PrintResults, UpdateLexItem, UpdateLexItem, UpdateLexItem

Methods inherited from class java.lang.Object

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

Constructor Detail

ToDerivation

public ToDerivation()

Method Detail

Mutate

public static java.util.Vector<LexItem> Mutate(LexItem in,
                                               java.sql.Connection conn,
                                               RamTrie trie,
                                               int restrictFlag,
                                               int derivationType,
                                               int derivationNegation,
                                               boolean detailsFlag,
                                               boolean mutateFlag)

Performs the mutation of this flow component.

Parameters:

in - a LexItem as the input for this flow component

conn - LVG database connection

trie - LVG persistent trie

restrictFlag - a numberical flag to restrict out into LVG_ONLY LVG_OR_ALL, or ALL (defined in LvgFlowSpecificOption).

derivationType - a numberical flag to restrict derivation type D_TYPE_ZERO, D_TYPE_PREFIX, D_TYPE_SUFFIX, D_TYPE_ZERO_PREFIX, D_TYPE_ZERO_SUFFIX, D_TYPE_PREFIX_SUFFIX, D_TYPE_ALL (defined in LvgFlowSpecificOption);

derivationNegation - a numberical flag to restrict derivation negation D_NEGATION_OTHERWISE, D_NEGATION_NEGATIVE, D_NEGATION_BOTH

detailsFlag - a boolean flag for processing details information

mutateFlag - a boolean flag for processing mutate information

Returns:

the results from this flow component - a collection (Vector) of LexItems

See Also:

DbBase, LvgFlowSpecificOption

Mutate

public static java.util.Vector<LexItem> Mutate(LexItem in,
                                               java.sql.Connection conn,
                                               RamTrie trie,
                                               int restrictFlag,
                                               boolean detailsFlag,
                                               boolean mutateFlag)

Performs the mutation of this flow component. Use D_TYPE_ALL for for derivation type and D_NEGATION_OTHERWISE for derivation negation flag.

Parameters:

in - a LexItem as the input for this flow component

conn - LVG database connection

trie - LVG persistent trie

restrictFlag - a numberical flag to restrict out into LVG_ONLY LVG_OR_ALL, or ALL (defined in LvgFlowSpecificOption).

detailsFlag - a boolean flag for processing details information

mutateFlag - a boolean flag for processing mutate information

Returns:

A Vector of LexItem - results from this flow component

See Also:

DbBase, LvgFlowSpecificOption

main

public static void main(java.lang.String[] args)

A unit test driver for this flow component.

Parameters:

args - arguments

GetDerivations

protected static java.util.Vector<LexItem> GetDerivations(LexItem in,
                                                          java.sql.Connection conn,
                                                          RamTrie trie,
                                                          int restrictFlag,
                                                          int derivationType,
                                                          int derivationNegation,
                                                          java.lang.String infoStr,
                                                          boolean detailsFlag,
                                                          boolean mutateFlag)

Get the derivational variants using both facts (database) and rules (trie). The implementation algorithm is:

• Facts:
  1. Performs a case insensitive search on the input term and term1 in the derivation table.
  2. Performs a case insensitive search on the input term and term2 in the derivation table.
  3. Assigns term and category for both source and target.
• Rules:
  1. Uses persistent trie to apply rules (and check exceptions) on the input term.
  2. Assigns term and category for both source and target.
• Display results according to the restriction filter.
• Sort the output by the frequency of categories.

Parameters:

in - a LexItem as the input for this flow component

conn - LVG database connection

trie - LVG persistent trie

restrictFlag - a numberical flag to restrict out into LVG_ONLY LVG_OR_ALL, or ALL (defined in LvgFlowSpecificOption).

derivationType - P|S|Z for prefixD, suffixD, and zeroD

derivationNegation - N|O for negative and otherwise

infoStr - the header of detail information, usually is the full name of the current flow

detailsFlag - a boolean flag for processing details information

mutateFlag - a boolean flag for processing mutate information

Returns:

A Vector of LexItem - results from this flow component

See Also:

DbBase, LvgFlowSpecificOption