module__TabularProjector
#org.bibliome.alvisnlp.modules.trie.TabularProjector
Projects a simple dictionary on sections.
org.bibliome.alvisnlp.modules.trie.TabularProjector reads a list of entries from dictFile and searches for these entries in sections. The format of the dictionary is one entry per line. Each line is split into columns separated by tab characters, or whichever character defined by separator. The column specified by keyIndex will be the entry to be searched and the other columns are data associated to the entry.
The parameters skipBlank, skipEmpty, strictColumnNumber, trimColumns, separator, multipleEntryBehaviour control the loading of the dictionary file.
The parameters allowJoined, allUpperCaseInsensitive, caseInsensitive, ignoreDiacritics, joinDash, matchStartCaseInsensitive, skipConsecutiveWhitespaces, skipWhitespace and wordStartCaseInsensitive control the matching between the section and the entry keys.
The subject parameter specifies which text of the section should be matched. There are two options:
- the entries are matched on the contents of the section, subject can also control if matches boundaries coincide with word delimiters;
- the entries are matched on the feature value of annotations of a given layer separated by a whitespace, in this way entries can be searched against word lemmas for instance.
org.bibliome.alvisnlp.modules.trie.TabularProjector creates an annotation for each matched entry and adds these annotations to the layer named targetLayerName. The created annotations will have features whose keys correspond to entryFeatureNames and values to the data associated to the matched entry (columns in the dictionary file). For instance if entryFeatureNames is [a,b,c], then each annotation will have three features named a, b and c with the respective values of the entry's second, third and fourth columns. A feature name left blank in entryFeatureNames will not create a feature. Thus, in order not to keep the entry in the a feature, entryFeatureNames should be [,b,c]. In addition, the created annotations will have the feature keys and values defined in constantAnnotationFeatures.
If specified, then org.bibliome.alvisnlp.modules.trie.TabularProjector assumes that trieSource contains a compiled version of the dictionary. dictFile is not read. If specified, org.bibliome.alvisnlp.modules.trie.TabularProjector writes a compiled version of the dictionary in trieSink. The use of compiled dictionaries may accelerate the processing for large dictionaries.
Optional
Type: SourceStream
Source of the dictionary.
Optional
Type: String
Name of the layer that contains the match annotations.
Optional
Type: String[]]
Target features in match annotations. The values are the columns in the matched entry line.
Optional
Type: Mapping
Constant features to add to each annotation created by this module
Optional
Type: OutputFile
If set, org.bibliome.alvisnlp.modules.trie.TabularProjector writes the compiled dictionary to the specified file.
Optional
Type: InputFile
If set, read the compiled dictionary from the specified files. Compiled dictionaries are generally faster for large dictionaries.
Default value: false
Type: Boolean
Either the match allows case substitution on all characters in words that are all upper case.
Default value: false
Type: Boolean
Either the match allows arbitrary suppression of whitespace characters in the subject. For instance, the contents aminoacid matches the entry amino acid.
Default value: false
Type: Boolean
Either the match allows case substitutions on all characters.
Default value: true
Type: Expression
Only process document that satisfy this filter.
Default value: false
Type: Boolean
Either the match allows dicacritics substitutions on all characters. For instance the contents acide amine matches the entry acide aminé.
Default value: false
Type: Boolean
Either to treat dash characters (-) as whitespace characters if allowJoined is true. For instance, the contents aminoacid matches the entry amino-acid.
Default value: 0
Type: Integer[]]
Specifies the key column index (starting at 0).
Default value: false
Type: Boolean
Either the match allows case substitution on the first character of the entry key.
Default value: all
Type: MultipleEntryBehaviour
Specifies the behavious of org.bibliome.alvisnlp.modules.trie.TabularProjector if dictFile contains several entries with the same key.
Default value: true
Type: Expression
Process only sections that satisfy this filter.
Default value:
Type: Character
Specifies the character that separates columns in dictFile.
Default value: false
Type: Boolean
In dictFile, skip lines that contain only whitespace characters.
Default value: false
Type: Boolean
Either the match allows insertion of consecutive whitespace characters in the subject. For instance, the contents amino acid matches the entry amino acid.
Default value: false
Type: Boolean
In dictFile, skip empty lines.
Default value: false
Type: Boolean
Either the match allows arbitrary insertion of whitespace characters in the subject. For instance, the contents amino acid matches the entry aminoacid.
Default value: true
Type: Boolean
Either to check that every line in dictFile has the same number of columns as the number of features specified in entryFeatureNames.
Default value: WORD
Type: Subject
Specifies the contents to match.
Default value: false
Type: Boolean
Either to trim column values in dictFile from leading and trailing whitespace characters.
Default value: false
Type: Boolean
Either the match allows case substitution on the first character of words.