The .csv file that defines classification synonyms contains the following kinds of entries, each of which must appear on a separate line:
Definition of synonyms. Each line specifies a source property and one or more classification synonyms. The values must be separated by commas. Examples:
Cerulean, blue
tawny, red, orange, brown
Operators. Operators specify how the synonyms are processed. Each operator is the first value in the line and is prefixed with the hash mark character (#). Only the first value after the operator is processed. Values of operators are case-insensitive; for example, false, FALSE, and False are all valid and equivalent. Example:
#inverted, false
Comments. Comments begin with the hash mark character (#) followed by a word that is not an operator. Example:
# This .csv file defines classification synonyms and lists operators.
The following table lists the operators that can be used in .csv files that define classification synonyms:
Operator |
Description |
---|---|
|
(required) Specifies a property name
defined under the
For example:
specifies that this .csv file can define synonyms for values
of the properties
If no
There is no default. |
# |
(optional) If TRUE, the original values of source properties are not included in the indexed data. If FALSE, the original values are included. For example, suppose that the .csv specifies the following synonym:
If
The default is FALSE. |
# |
(optional) If True, source property values for which no classification synonyms are defined in a .csv file are included in the indexed data. If FALSE, original source property values with no classification synonyms are not included in the indexed data. The default is FALSE. |
# |
(optional) If TRUE, values are not case-sensitive; for example, "blue" and "Blue" are treated as the same value. If FALSE, values are case-sensitive; for example, "blue" and "Blue" are treated as different values. The default value is FALSE. |
# |
(optional) If FALSE, the first (leftmost) value on a line is a source property value and the others are classification synonyms. If TRUE, the last (rightmost) is value on a line is a source property value and the others are classification synonyms. For example, suppose that a .csv file contains the following lines: #inverted true Amethyst, purple
"Amethyst" is now treated as a classification synonym, in spite of appearing at the leftmost end of the line. Thus, the following entry appears in the refinements: Amethyst(n)
where n is the number of records tagged to "Amethyst". However, if the .csv file contains
purple(n)
The default is FALSE. |
#valueIfMulti |
(optional) Specifies an additional classification synonym for all source properties that have two or more classification synonyms. The additional classification synonym can be general in meaning, to supplement the more specific values of the other classification synonyms. For example, suppose that the following classification synonyms are defined for the source properties "Black Watch Plaid" and "Tartan":
Black Watch Plaid, black, plaid Tartan, red, green, white
The following operator defines "Multi-Colored" as an additional classification synonym for all source properties that have two or more classification synonyms:
#valueIfMulti,Multi-Colored
Thus, the classification synonyms of Black Watch Plaid appear as the following refinements (where n is the number of records matching the refinement):
black(n) plaid(n) Multi-Colored(n)
and the classification synonyms of Tartan appear as the following refinements:
red(n) green(n) white(n) Multi-Colored(n)
If the #valueIfMulti operator is omitted, only the following refinements appear:
black(n) plaid(n) red(n) green(n) white(n)
There is no default value. |