Index (TIBCO Patterns Grouping Library Documentation)

A B C D E G I J K M N O P R S T V
All Classes All Packages

A

add_threshold - Variable in class com.tibco.patterns.grouping.GroupingOptions: The lower score bound for a record to extend a group.

B

backmapInternalKey(int) - Method in interface com.tibco.patterns.grouping.IStringKeyMapping: Looks up the original external key.
backmapInternalKey(int) - Method in class com.tibco.patterns.grouping.StringIntegerKeyMapping: Looks up the original external key.
backmapInternalKey(int) - Method in class com.tibco.patterns.grouping.StringKeyMapping: Looks up the original external key.

C

com.tibco.patterns.grouping - package com.tibco.patterns.grouping
compareTo(InputPair) - Method in class com.tibco.patterns.grouping.InputPair: Compares the scores of the two pairs.
createGroups(Iterable<InputPair>, IGroupOutput) - Method in class com.tibco.patterns.grouping.Grouping
CsvGroupOutput - Class in com.tibco.patterns.grouping: Writes grouping output to a set of three files, one each for pairs, records, and groups.
CsvGroupOutput(CsvPairInput, String, String, String) - Constructor for class com.tibco.patterns.grouping.CsvGroupOutput: Builds a CsvGroupOutput object that infers key mapping from the CsvPairInput object provided.
CsvGroupOutput(IStringKeyMapping, IStringKeyMapping, String, String, String) - Constructor for class com.tibco.patterns.grouping.CsvGroupOutput: Builds a CsvGroupOutput object with the specified key mapping.
CsvGroupOutput(String, String, String) - Constructor for class com.tibco.patterns.grouping.CsvGroupOutput: Builds a CsvGroupOutput object that assumes there is no key mapping.
CsvInputOptions - Class in com.tibco.patterns.grouping
CsvInputOptions(int, int, int) - Constructor for class com.tibco.patterns.grouping.CsvInputOptions: Constructs a CsvInputOptions object with the minimum required options.
CsvInputOptions(int, int, int, int) - Constructor for class com.tibco.patterns.grouping.CsvInputOptions: Constructs a CsvInputOptions object with just column index options.
CsvInputOptions(CsvInputOptions) - Constructor for class com.tibco.patterns.grouping.CsvInputOptions: Copy constructor
CsvKeyHandling - Enum in com.tibco.patterns.grouping: Choices for handling of pair and record keys in a csv input file.
CsvPairInput - Class in com.tibco.patterns.grouping: Generates a sequence of pairs from a csv file.
CsvPairInput(String, CsvInputOptions) - Constructor for class com.tibco.patterns.grouping.CsvPairInput: Creates a CsvPairInput object using the input options provided.

D

delimiter - Variable in class com.tibco.patterns.grouping.CsvGroupOutput
done() - Method in class com.tibco.patterns.grouping.CsvGroupOutput: Implements IGroupOutput.done().
done() - Method in interface com.tibco.patterns.grouping.IGroupOutput: Called when grouping is done.

E

extended - Variable in class com.tibco.patterns.grouping.CsvGroupOutput

G

getKey() - Method in class com.tibco.patterns.grouping.GroupedRecord
getLinkedRecordKey() - Method in class com.tibco.patterns.grouping.GroupedRecord
getOriginalPair() - Method in class com.tibco.patterns.grouping.GroupedPair
getScore() - Method in class com.tibco.patterns.grouping.GroupedRecord
getSubgroup() - Method in class com.tibco.patterns.grouping.GroupedRecord
GroupedPair - Class in com.tibco.patterns.grouping: Wraps an input pair with relevant grouping information.
Used only during group output.
GroupedPair(InputPair, int, int) - Constructor for class com.tibco.patterns.grouping.GroupedPair
GroupedRecord - Class in com.tibco.patterns.grouping: Bundles the information relevant to the grouping of a particular record.
GroupedRecord(int, int, Integer, Float) - Constructor for class com.tibco.patterns.grouping.GroupedRecord
Grouping - Class in com.tibco.patterns.grouping: Implements the grouping algorithms.
Grouping() - Constructor for class com.tibco.patterns.grouping.Grouping: Creates a Grouping object with default options.
Grouping(GroupingOptions) - Constructor for class com.tibco.patterns.grouping.Grouping: Creates a Grouping object with the specified options.
GroupingException - Exception in com.tibco.patterns.grouping: General exception thrown by the grouping engine.
GroupingOptions - Class in com.tibco.patterns.grouping: Holds the options applicable to a grouping.
To ensure all records are grouped, set add_threshold to 0.0 and max_group_size to a large number.
GroupingOptions() - Constructor for class com.tibco.patterns.grouping.GroupingOptions: Creates grouping options with default values.
GroupingOptions(GroupingOptions) - Constructor for class com.tibco.patterns.grouping.GroupingOptions: Copies group options.
GroupingStatistics - Class in com.tibco.patterns.grouping
GroupingStatistics() - Constructor for class com.tibco.patterns.grouping.GroupingStatistics
GroupMaxSize - com.tibco.patterns.grouping.SkipReason: Pair skipped because the group was already at the maximum size.
groups_output - Variable in class com.tibco.patterns.grouping.GroupingStatistics: The number of groups output.

I

IGroupingProgress - Interface in com.tibco.patterns.grouping: Implement this interface to control progress messages are handled.
IGroupOutput - Interface in com.tibco.patterns.grouping: Implemented by the application to define how groups are stored.
InputPair - Class in com.tibco.patterns.grouping: Base class for pairs streamed into the grouping engine.
InputPair() - Constructor for class com.tibco.patterns.grouping.InputPair: Creates a blank input pair.
InputPair(int, int, float) - Constructor for class com.tibco.patterns.grouping.InputPair: Creates an input pair with the specified values.
isSelfMatch() - Method in class com.tibco.patterns.grouping.InputPair: Checks if the pair is a self-match (the record keys are identical).
IStringKeyMapping - Interface in com.tibco.patterns.grouping: Implement this interface when the incoming keys are strings.
iterator() - Method in class com.tibco.patterns.grouping.CsvPairInput: Implements interface Iterable.

J

join_threshold - Variable in class com.tibco.patterns.grouping.GroupingOptions: The lower score bound for merging two groups.

K

key - Variable in class com.tibco.patterns.grouping.KeyedInputPair: Unique key for this pair
KeyedInputPair - Class in com.tibco.patterns.grouping: An extension of InputPair that provides an integer pair key.
KeyedInputPair() - Constructor for class com.tibco.patterns.grouping.KeyedInputPair

M

mapExternalKey(String) - Method in interface com.tibco.patterns.grouping.IStringKeyMapping: If the external key has been encountered previously, the previously generated internal key is returned.
mapExternalKey(String) - Method in class com.tibco.patterns.grouping.StringIntegerKeyMapping: If the external key has been encountered previously, the previously generated internal key is returned.
mapExternalKey(String) - Method in class com.tibco.patterns.grouping.StringKeyMapping: If the external key has been encountered previously, the previously generated internal key is returned.
MapInteger - com.tibco.patterns.grouping.CsvKeyHandling: Keys are integers but must be mapped.
MapString - com.tibco.patterns.grouping.CsvKeyHandling: Keys are strings and must be mapped.
max_group_size - Variable in class com.tibco.patterns.grouping.GroupingOptions: The maximum size of a group.
max_record_links - Variable in class com.tibco.patterns.grouping.GroupingOptions: Records with more than this number of links will not be grouped.

N

new_group_threshold - Variable in class com.tibco.patterns.grouping.GroupingOptions: The lower score bound for creating a new group.
NoMapInteger - com.tibco.patterns.grouping.CsvKeyHandling: Keys are integer and should be used directly and not mapped.
None - com.tibco.patterns.grouping.CsvKeyHandling: Used when the key is not present.

O

otherKey(int) - Method in class com.tibco.patterns.grouping.InputPair: Given one key of the pair, retrieves the other key of the pair.
outputGroup(int, int, float, Iterable<GroupedRecord>, Iterable<GroupedPair>) - Method in class com.tibco.patterns.grouping.CsvGroupOutput: Implements IGroupOutput.outputGroup.
outputGroup(int, int, float, Iterable<GroupedRecord>, Iterable<GroupedPair>) - Method in interface com.tibco.patterns.grouping.IGroupOutput: Outputs the data for a group.

P

pair_key_handling - Variable in class com.tibco.patterns.grouping.CsvInputOptions: Determines handling of pair keys from the file.
pair_key_index - Variable in class com.tibco.patterns.grouping.CsvInputOptions: The column in the csv file which contains the pair keys.
pairs_output - Variable in class com.tibco.patterns.grouping.GroupingStatistics: The number of pairs output.
pairs_processed - Variable in class com.tibco.patterns.grouping.GroupingStatistics: The number of pairs processed.
PairSkipped(InputPair, SkipReason) - Method in interface com.tibco.patterns.grouping.IGroupingProgress: Called when a pair is skipped.
PairsProcessed(int, int, int) - Method in interface com.tibco.patterns.grouping.IGroupingProgress: Called every time the grouping finishes processing a specific number of pairs.
peak_groups_in_memory - Variable in class com.tibco.patterns.grouping.GroupingStatistics: The maximum number of groups ever held in memory for the grouping.
peak_pairs_in_memory - Variable in class com.tibco.patterns.grouping.GroupingStatistics: The maximum number of pairs ever held in memory for the grouping.
PercentCompleted(float, int, int) - Method in interface com.tibco.patterns.grouping.IGroupingProgress: Called every time the grouping passes a percentage milestone.

R

record_key_1 - Variable in class com.tibco.patterns.grouping.InputPair
record_key_1_index - Variable in class com.tibco.patterns.grouping.CsvInputOptions: The column in the csv file which contains the first record key.
record_key_2 - Variable in class com.tibco.patterns.grouping.InputPair
record_key_2_index - Variable in class com.tibco.patterns.grouping.CsvInputOptions: The column in the csv file which contains the second record key.
record_key_handling - Variable in class com.tibco.patterns.grouping.CsvInputOptions: Determines handling of record keys from the file.
records_output - Variable in class com.tibco.patterns.grouping.GroupingStatistics: The number of records output.
releaseForwardKeymappings() - Method in class com.tibco.patterns.grouping.CsvPairInput
releaseForwardMap() - Method in interface com.tibco.patterns.grouping.IStringKeyMapping: Releases memory storage related to generating internal keys.
After calling releaseForwardMap(), calls to mapExternalKey() will throw an exception.
releaseForwardMap() - Method in class com.tibco.patterns.grouping.StringIntegerKeyMapping: Releases memory storage related to generating internal keys.
After calling releaseForwardMap(), calls to mapExternalKey() will throw an exception.
releaseForwardMap() - Method in class com.tibco.patterns.grouping.StringKeyMapping: Releases memory storage related to generating internal keys.
After calling releaseForwardMap(), calls to mapExternalKey() will throw an exception.

S

score - Variable in class com.tibco.patterns.grouping.InputPair
score_index - Variable in class com.tibco.patterns.grouping.CsvInputOptions: The column in the csv file which contains the pair score.
ScoreBelowAddThreshhold - com.tibco.patterns.grouping.SkipReason: Pair skipped because it linked an ungrouped record to an existing group, but the pair score was below the add_threshold.
ScoreBelowMergeThreshold - com.tibco.patterns.grouping.SkipReason: Pair skipped because it linked two existing groups, but the pair score was below the merge_threshold.
ScoreBelowNewGroupThreshold - com.tibco.patterns.grouping.SkipReason: Pair skipped because it would have started a new group, but the pair score was below the new_group_threshold.
setProgress(IGroupingProgress, Float, Integer, boolean) - Method in class com.tibco.patterns.grouping.Grouping: Determine which messages to output during grouping.
skip_lines - Variable in class com.tibco.patterns.grouping.CsvInputOptions: Number of lines to skip at the start of the csv file.
skip_self_matches - Variable in class com.tibco.patterns.grouping.CsvInputOptions: Indicates whether to skip self-match pairs (pairs where the two record keys are identical).
skip_self_matches - Variable in class com.tibco.patterns.grouping.CsvPairInput: Indicates whether to skip self-match pairs (pairs where the two record keys are identical).
SkipReason - Enum in com.tibco.patterns.grouping: Lists the reasons a pair might be skipped.
startFail() - Method in class com.tibco.patterns.grouping.CsvGroupOutput: Implements IGroupOutput.startFail by writing "UNCLOSED GROUPS:" to each of the output files.
StringIntegerKeyMapping - Class in com.tibco.patterns.grouping: Maintains a mapping of internal to external record keys.
StringIntegerKeyMapping() - Constructor for class com.tibco.patterns.grouping.StringIntegerKeyMapping
StringKeyMapping - Class in com.tibco.patterns.grouping: Maintains a mapping of internal to external record keys.
StringKeyMapping() - Constructor for class com.tibco.patterns.grouping.StringKeyMapping

T

TooManyLinks - com.tibco.patterns.grouping.SkipReason: Pair skipped because one of the records had too many links.
toString() - Method in class com.tibco.patterns.grouping.GroupedPair
toString() - Method in class com.tibco.patterns.grouping.InputPair: Creates a string description of the pair.
toString() - Method in class com.tibco.patterns.grouping.KeyedInputPair: Beware overriding this, as it is used in building exception descriptions.

V

valueOf(String) - Static method in enum com.tibco.patterns.grouping.CsvKeyHandling: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tibco.patterns.grouping.SkipReason: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.tibco.patterns.grouping.CsvKeyHandling: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tibco.patterns.grouping.SkipReason: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G I J K M N O P R S T V
All Classes All Packages