Flow (Lvg API, 2020 Version)

java.lang.Object
- gov.nih.nlm.nls.lvg.Lib.BitMaskBase
- - gov.nih.nlm.nls.lvg.Lib.Flow

```
public class Flow
extends BitMaskBase
```
This class provides methods of combining Lvg output records by specifying different rules. It is utilized under Lvg Output filter options.
History:

Version:

V-2020

Author:

NLM NLS Development Team

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACRONYMS` generate acronyms flow component bit for flow
`static int`	`ANTINORM` antiNorm flow component bit for flow
`static int`	`BASE_SPELLING_VARIANTS` generate base spelling variants flow component bit for flow
`static int`	`CANONICALIZE` canonicalize flow component bit for flow
`static int`	`CITATION` citation term flow component bit for flow
`static int`	`CONVERT_OUTPUT` convert output flow component bit for flow
`static int`	`DERIVATION` generate derivation flow component bit for flow
`static int`	`DERIVATION_BY_CATEGORY` generate derivation by category flow component bit for flow
`static int`	`EXPANSIONS` generate expansions flow component bit for flow
`static int`	`FILTER` filter flow component bit for flow
`static int`	`FILTER_ACRONYM` filter out acronym flow component bit for flow
`static int`	`FILTER_PROPER_NOUN` filter out proper nouns flow component bit for flow
`static int`	`FRUITFUL_ENHANCED` enhanced fruitful variants flow component bit for flow
`static int`	`FRUITFUL_VARIANTS` fruitful variants flow component bit for flow
`static int`	`FRUITFUL_VARIANTS_DB` fruitful variants by database flow component bit for flow
`static int`	`FRUITFUL_VARIANTS_LEX` fruitful variants known to Lexicon flow component bit for flow
`static int`	`GENERATE_SPELLING_VARIANTS` generate spelling variants flow component bit for flow
`static int`	`GET_UNICODE_NAME` get symbol name flow component bit for flow
`static int`	`GET_UNICODE_SYNONYM` get synonyms of symbol name flow component bit for flow
`static int`	`INFLECTION` inflection flow component bit for flow
`static int`	`INFLECTION_BY_CAT_INFL` derivation by category and inlfection flow component bit for flow
`static int`	`INFLECTION_SIMPLE` inflection simple flow component bit for flow
`static int`	`LOWER_CASE` lower case flow component bit for flow
`static int`	`LUI_NORMALIZE` lui nomalize flow component bit for flow
`static int`	`MAP_SYMBOL_TO_ASCII` punctuation Symbol mapping flow component bit for flow
`static int`	`MAP_UNICODE_TO_ASCII` unicdoe mapping flow component bit for flow
`static int`	`METAPHONE` metaphone flow component bit for flow
`static int`	`NO_OPERATION` no operatin flow component bit for flow
`static int`	`NOMINALIZATION` nominalization flow component bit for flow
`static int`	`NONE` None bit for flow
`static int`	`NORM_UNICODE` normalize characters in a string flow component bit for flow
`static int`	`NORM_UNICODE_WITH_SYNONYM` normalize characters with symbol synonyms flow component bit for flow
`static int`	`NORM_UNINFLECT_WORDS` normalize uninflected words flow component bit for flow
`static int`	`NORMALIZE` normalize flow component bit for flow
`static int`	`RECURSIVE_DERIVATIONS` generate derivations recursively flow component bit for flow
`static int`	`RECURSIVE_SYNONYMS` generate synonyms recursively flow component bit for flow
`static int`	`REMOVE_GENITIVE` remove genitive flow component bit for flow
`static int`	`REMOVE_S` removeS flow component bit for flow
`static int`	`REPLACE_PUNCTUATION_WITH_SPACE` replace punctuation with space flow component bit for flow
`static int`	`RETRIEVE_CAT_INFL` retrieve Category and inflection flow component bit for flow
`static int`	`RETRIEVE_CAT_INFL_BEGIN` retrieve category and inflection for term begin with a given pattern flow component bit for flow
`static int`	`RETRIEVE_CAT_INFL_DB` retrieve category and inflectin from LVG flow component bit for flow
`static int`	`RETRIEVE_EUI` retrieve EUI flow component bit for flow
`static int`	`SIMPLE_INFLECTIONS` simple inflection flow component bit for flow
`static int`	`SORT_BY_WORD_ORDER` sort by word order flow component bit for flow
`static int`	`SPLIT_LIGATURES` splite ligature flow component bit for flow
`static int`	`STRIP_AMBIGUITY_TAGS` strip ambiguity tags flow component bit for flow
`static int`	`STRIP_DIACRITICS` strip diacritics flow component bit for flow
`static int`	`STRIP_MAP_UNICODE` Unicode strip or mapping flow component bit for flow
`static int`	`STRIP_NEC_NOS` strip NEC and NOS flow component bit for flow
`static int`	`STRIP_PUNCTUATION` strip punctuation flow component bit for flow
`static int`	`STRIP_PUNCTUATION_ENHANCED` strip punctuation, enhanced, flow component bit for flow
`static int`	`STRIP_STOP_WORDS` strip stop word flow component bit for flow
`static int`	`SYNONYMS` generate synonyms flow component bit for flow
`static int`	`SYNTACTIC_UNINVERT` syntactic uninvert flow component bit for flow
`static int`	`TOKENIZE` tokenize flow component bit for flow
`static int`	`TOKENIZE_KEEP_ALL` tokenize, keep all flow component bit for flow
`static int`	`TOKENIZE_NO_HYPHENS` tokenize without hyphens flow component bit for flow
`static int`	`UNICODE_CORE_NORM` Unicode coreNorm flow component bit for flow
`static int`	`UNINFLECT_TERM` uninflect term flow component bit for flow
`static int`	`UNINFLECT_WORDS` uninflect words flow component bit for flow
`static int`	`UNINVERT` uninvert flow component bit for flow
`static int`	`WORD_SIZE` word size filter flow component bit for flow

Fields inherited from class gov.nih.nlm.nls.lvg.Lib.BitMaskBase
MASK, MAX_BIT

Constructor Summary

Constructors
Constructor and Description

Flow()
Create a Flow object

Flow(int intValue)
Create a Flow object, using an integer value

Constructors
Constructor and Description
`Flow()` Create a Flow object
`Flow(int intValue)` Create a Flow object, using an integer value

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static long`	`Enumerate(java.lang.String valueStr)` Get the long value for one single name (no combine names of bits).
`static java.lang.String`	`GetBitName(int bitValue)` Get the name (first in the name list) of a specified bit (single).
`static java.lang.String`	`GetBitName(int bitValue, int index)` Get the name at index order of a specified bit (single).
`static void`	`main(java.lang.String[] args)` Test driver for this Flow class
`static java.lang.String`	`ToName(long value)` Convert a long gender value to a combined string (abbreviation).
`static long`	`ToValue(java.lang.String valueStr)` Convert a combined value string to a long gender value.

Methods inherited from class gov.nih.nlm.nls.lvg.Lib.BitMaskBase
Contains, Contains, Enumerate, GetBitFlag, GetBitIndex, GetBitName, GetBitValue, GetName, GetValue, SetBitFlag, SetValue, ToName, ToValue, ToValues

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NONE
```
public static final int NONE
```
    None bit for flow
    
    See Also:
    
    Constant Field Values
  - INFLECTION
```
public static final int INFLECTION
```
    inflection flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - STRIP_STOP_WORDS
```
public static final int STRIP_STOP_WORDS
```
    strip stop word flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - REMOVE_GENITIVE
```
public static final int REMOVE_GENITIVE
```
    remove genitive flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - REPLACE_PUNCTUATION_WITH_SPACE
```
public static final int REPLACE_PUNCTUATION_WITH_SPACE
```
    replace punctuation with space flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - STRIP_PUNCTUATION
```
public static final int STRIP_PUNCTUATION
```
    strip punctuation flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - STRIP_PUNCTUATION_ENHANCED
```
public static final int STRIP_PUNCTUATION_ENHANCED
```
    strip punctuation, enhanced, flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - SORT_BY_WORD_ORDER
```
public static final int SORT_BY_WORD_ORDER
```
    sort by word order flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - UNINFLECT_WORDS
```
public static final int UNINFLECT_WORDS
```
    uninflect words flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - NORMALIZE
```
public static final int NORMALIZE
```
    normalize flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - CANONICALIZE
```
public static final int CANONICALIZE
```
    canonicalize flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - LUI_NORMALIZE
```
public static final int LUI_NORMALIZE
```
    lui nomalize flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - STRIP_NEC_NOS
```
public static final int STRIP_NEC_NOS
```
    strip NEC and NOS flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - UNINFLECT_TERM
```
public static final int UNINFLECT_TERM
```
    uninflect term flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - GENERATE_SPELLING_VARIANTS
```
public static final int GENERATE_SPELLING_VARIANTS
```
    generate spelling variants flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - NO_OPERATION
```
public static final int NO_OPERATION
```
    no operatin flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - ACRONYMS
```
public static final int ACRONYMS
```
    generate acronyms flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - EXPANSIONS
```
public static final int EXPANSIONS
```
    generate expansions flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - DERIVATION
```
public static final int DERIVATION
```
    generate derivation flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - DERIVATION_BY_CATEGORY
```
public static final int DERIVATION_BY_CATEGORY
```
    generate derivation by category flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - INFLECTION_BY_CAT_INFL
```
public static final int INFLECTION_BY_CAT_INFL
```
    derivation by category and inlfection flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - TOKENIZE
```
public static final int TOKENIZE
```
    tokenize flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - TOKENIZE_NO_HYPHENS
```
public static final int TOKENIZE_NO_HYPHENS
```
    tokenize without hyphens flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - BASE_SPELLING_VARIANTS
```
public static final int BASE_SPELLING_VARIANTS
```
    generate base spelling variants flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - RETRIEVE_EUI
```
public static final int RETRIEVE_EUI
```
    retrieve EUI flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - RETRIEVE_CAT_INFL
```
public static final int RETRIEVE_CAT_INFL
```
    retrieve Category and inflection flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - RETRIEVE_CAT_INFL_DB
```
public static final int RETRIEVE_CAT_INFL_DB
```
    retrieve category and inflectin from LVG flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - RETRIEVE_CAT_INFL_BEGIN
```
public static final int RETRIEVE_CAT_INFL_BEGIN
```
    retrieve category and inflection for term begin with a given pattern flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - SYNONYMS
```
public static final int SYNONYMS
```
    generate synonyms flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - FILTER
```
public static final int FILTER
```
    filter flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - FILTER_PROPER_NOUN
```
public static final int FILTER_PROPER_NOUN
```
    filter out proper nouns flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - FILTER_ACRONYM
```
public static final int FILTER_ACRONYM
```
    filter out acronym flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - STRIP_AMBIGUITY_TAGS
```
public static final int STRIP_AMBIGUITY_TAGS
```
    strip ambiguity tags flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - UNINVERT
```
public static final int UNINVERT
```
    uninvert flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - CONVERT_OUTPUT
```
public static final int CONVERT_OUTPUT
```
    convert output flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - RECURSIVE_SYNONYMS
```
public static final int RECURSIVE_SYNONYMS
```
    generate synonyms recursively flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - RECURSIVE_DERIVATIONS
```
public static final int RECURSIVE_DERIVATIONS
```
    generate derivations recursively flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - LOWER_CASE
```
public static final int LOWER_CASE
```
    lower case flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - CITATION
```
public static final int CITATION
```
    citation term flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - NORM_UNINFLECT_WORDS
```
public static final int NORM_UNINFLECT_WORDS
```
    normalize uninflected words flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - STRIP_DIACRITICS
```
public static final int STRIP_DIACRITICS
```
    strip diacritics flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - METAPHONE
```
public static final int METAPHONE
```
    metaphone flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - FRUITFUL_VARIANTS
```
public static final int FRUITFUL_VARIANTS
```
    fruitful variants flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - TOKENIZE_KEEP_ALL
```
public static final int TOKENIZE_KEEP_ALL
```
    tokenize, keep all flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - SYNTACTIC_UNINVERT
```
public static final int SYNTACTIC_UNINVERT
```
    syntactic uninvert flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - FRUITFUL_VARIANTS_LEX
```
public static final int FRUITFUL_VARIANTS_LEX
```
    fruitful variants known to Lexicon flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - FRUITFUL_VARIANTS_DB
```
public static final int FRUITFUL_VARIANTS_DB
```
    fruitful variants by database flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - ANTINORM
```
public static final int ANTINORM
```
    antiNorm flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - WORD_SIZE
```
public static final int WORD_SIZE
```
    word size filter flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - FRUITFUL_ENHANCED
```
public static final int FRUITFUL_ENHANCED
```
    enhanced fruitful variants flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - SIMPLE_INFLECTIONS
```
public static final int SIMPLE_INFLECTIONS
```
    simple inflection flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - INFLECTION_SIMPLE
```
public static final int INFLECTION_SIMPLE
```
    inflection simple flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - SPLIT_LIGATURES
```
public static final int SPLIT_LIGATURES
```
    splite ligature flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - GET_UNICODE_NAME
```
public static final int GET_UNICODE_NAME
```
    get symbol name flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - GET_UNICODE_SYNONYM
```
public static final int GET_UNICODE_SYNONYM
```
    get synonyms of symbol name flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - NORM_UNICODE
```
public static final int NORM_UNICODE
```
    normalize characters in a string flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - NORM_UNICODE_WITH_SYNONYM
```
public static final int NORM_UNICODE_WITH_SYNONYM
```
    normalize characters with symbol synonyms flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - NOMINALIZATION
```
public static final int NOMINALIZATION
```
    nominalization flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - REMOVE_S
```
public static final int REMOVE_S
```
    removeS flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - MAP_SYMBOL_TO_ASCII
```
public static final int MAP_SYMBOL_TO_ASCII
```
    punctuation Symbol mapping flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - MAP_UNICODE_TO_ASCII
```
public static final int MAP_UNICODE_TO_ASCII
```
    unicdoe mapping flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - UNICODE_CORE_NORM
```
public static final int UNICODE_CORE_NORM
```
    Unicode coreNorm flow component bit for flow
    
    See Also:
    
    Constant Field Values
  - STRIP_MAP_UNICODE
```
public static final int STRIP_MAP_UNICODE
```
    Unicode strip or mapping flow component bit for flow
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Flow
```
public Flow()
```
    Create a Flow object
  - Flow
```
public Flow(int intValue)
```
    Create a Flow object, using an integer value
    
    Parameters:
    
    intValue - number for finding it's combined name
- Method Detail
  - ToValue
```
public static long ToValue(java.lang.String valueStr)
```
    Convert a combined value string to a long gender value.
    
    Parameters:
    
    valueStr - combined name in String format
    
    Returns:
    
    a long value of the specified name
  - ToName
```
public static java.lang.String ToName(long value)
```
    Convert a long gender value to a combined string (abbreviation).
    
    Parameters:
    
    value - number for finding it's combined name
    
    Returns:
    
    name in a String format
  - GetBitName
```
public static java.lang.String GetBitName(int bitValue)
```
    Get the name (first in the name list) of a specified bit (single). The first one in LVG is the abbreviation name.
    
    Parameters:
    
    bitValue - bit nubmer for finding it's name
    
    Returns:
    
    name of the bit specified
  - GetBitName
```
public static java.lang.String GetBitName(int bitValue,
                                          int index)
```
    Get the name at index order of a specified bit (single).
    
    Parameters:
    
    bitValue - bit nubmer for finding it's name
    
    index - the order index of the name in BIT_STR[]
    
    Returns:
    
    name at index order of the bit specified
  - Enumerate
```
public static long Enumerate(java.lang.String valueStr)
```
    Get the long value for one single name (no combine names of bits).
    
    Parameters:
    
    valueStr - name of a bit for finding it's long value
    
    Returns:
    
    a long value of the specified name
  - main
```
public static void main(java.lang.String[] args)
```
    Test driver for this Flow class
    
    Parameters:
    
    args - arguments

Class Flow

Field Summary

Fields inherited from class gov.nih.nlm.nls.lvg.Lib.BitMaskBase

Constructor Summary

Method Summary

Methods inherited from class gov.nih.nlm.nls.lvg.Lib.BitMaskBase

Methods inherited from class java.lang.Object

Field Detail

NONE

INFLECTION

STRIP_STOP_WORDS

REMOVE_GENITIVE

REPLACE_PUNCTUATION_WITH_SPACE

STRIP_PUNCTUATION

STRIP_PUNCTUATION_ENHANCED

SORT_BY_WORD_ORDER

UNINFLECT_WORDS

NORMALIZE

CANONICALIZE

LUI_NORMALIZE

STRIP_NEC_NOS

UNINFLECT_TERM

GENERATE_SPELLING_VARIANTS

NO_OPERATION

ACRONYMS

EXPANSIONS

DERIVATION

DERIVATION_BY_CATEGORY

INFLECTION_BY_CAT_INFL

TOKENIZE

TOKENIZE_NO_HYPHENS

BASE_SPELLING_VARIANTS

RETRIEVE_EUI

RETRIEVE_CAT_INFL

RETRIEVE_CAT_INFL_DB

RETRIEVE_CAT_INFL_BEGIN

SYNONYMS

FILTER

FILTER_PROPER_NOUN

FILTER_ACRONYM

STRIP_AMBIGUITY_TAGS

UNINVERT

CONVERT_OUTPUT

RECURSIVE_SYNONYMS

RECURSIVE_DERIVATIONS

LOWER_CASE

CITATION

NORM_UNINFLECT_WORDS

STRIP_DIACRITICS

METAPHONE

FRUITFUL_VARIANTS

TOKENIZE_KEEP_ALL

SYNTACTIC_UNINVERT

FRUITFUL_VARIANTS_LEX

FRUITFUL_VARIANTS_DB

ANTINORM

WORD_SIZE

FRUITFUL_ENHANCED

SIMPLE_INFLECTIONS

INFLECTION_SIMPLE

SPLIT_LIGATURES

GET_UNICODE_NAME

GET_UNICODE_SYNONYM

NORM_UNICODE

NORM_UNICODE_WITH_SYNONYM

NOMINALIZATION

REMOVE_S

MAP_SYMBOL_TO_ASCII

MAP_UNICODE_TO_ASCII

UNICODE_CORE_NORM

STRIP_MAP_UNICODE

Constructor Detail

Flow

Flow

Method Detail

ToValue

ToName

GetBitName

GetBitName

Enumerate