1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.query.profile.types;
import com.yahoo.processing.request.CompoundName;
import com.yahoo.search.query.profile.QueryProfile;
import java.util.List;
/**
* A field description of a query profile type. Immutable.
* Field descriptions can be sorted by name.
*
* @author bratseth
*/
public class FieldDescription implements Comparable<FieldDescription> {
private final CompoundName name;
private final FieldType type;
private final List<String> aliases;
/** If true, this value must be provided either in the query profile or in the search request */
private final boolean mandatory;
/** If true, assignments to this value from outside will be ignored */
private final boolean overridable;
public FieldDescription(String name, FieldType type) {
this(name,type,false);
}
public FieldDescription(String name, String type) {
this(name,FieldType.fromString(type, null));
}
public FieldDescription(String name, FieldType type, boolean mandatory) {
this(name, type, mandatory, true);
}
public FieldDescription(String name, String type, String aliases) {
this(name, type, aliases, false, true);
}
public FieldDescription(String name, FieldType type, String aliases) {
this(name, type, aliases, false, true);
}
/**
* Creates a field description
*
* @param name the name of the field
* @param typeString the type of the field represented as a string - see {@link com.yahoo.search.query.profile.types.FieldType}
* @param aliases a space-separated list of alias names of this field name. Aliases are not following dotted
* (meaning they are global, not that they cannot contain dots) and are case insensitive. Null is permissible
* if there are no aliases
* @param mandatory whether it is mandatory to provide a value for this field. default: false
* @param overridable whether this can be overridden when first set in a profile. Default: true
*/
public FieldDescription(String name, String typeString, String aliases, boolean mandatory, boolean overridable) {
this(name,FieldType.fromString(typeString, null), aliases, mandatory, overridable);
}
public FieldDescription(String name, FieldType type, boolean mandatory, boolean overridable) {
this(name, type, null, mandatory, overridable);
}
public FieldDescription(String name, FieldType type, String aliases, boolean mandatory, boolean overridable) {
this(CompoundName.from(name), type, aliases, mandatory, overridable);
}
/**
* Creates a field description from a list where the aliases are represented as a comma-separated string
*/
public FieldDescription(CompoundName name, FieldType type, String aliases, boolean mandatory, boolean overridable) {
this(name, type, toList(aliases), mandatory, overridable);
}
/**
* Creates a field description
*
* @param name the name of the field, empty means it describes the value held by the query profile itself
* @param type the type of the field represented as a string - see {@link com.yahoo.search.query.profile.types.FieldType}
* @param aliases a list of aliases, never null. Aliases are not following dotted
* (meaning they are global, not that they cannot contain dots) and are case insensitive.
* @param mandatory whether it is mandatory to provide a value for this field. default: false
* @param overridable whether this can be overridden when first set in a profile. Default: true
*/
public FieldDescription(CompoundName name, FieldType type, List<String> aliases, boolean mandatory, boolean overridable) {
for (String nameComponent : name.asList())
QueryProfile.validateName(nameComponent);
this.name = name;
this.type = type;
// Forbidden until we can figure out the right semantics
if (name.isCompound() && ! aliases.isEmpty())
throw new IllegalArgumentException("Aliases are not allowed with compound names");
this.aliases = List.copyOf(aliases);
this.mandatory = mandatory;
this.overridable = overridable;
}
private static List<String> toList(String string) {
if (string == null || string.isEmpty()) return List.of();
return List.of(string.split(" "));
}
/** Returns the full name of this as a string */
public String getName() { return name.toString(); }
/** Returns the full name of this as a compound name */
public CompoundName getCompoundName() { return name; }
public FieldType getType() { return type; }
/** Returns a unmodifiable list of the aliases of this. An empty list (never null) if there are none. */
public List<String> getAliases() { return aliases; }
/** Returns whether this field must be provided in the query profile or the search definition. Default: false */
public boolean isMandatory() { return mandatory; }
/** Returns false if overrides to values for this field from the outside should be ignored. Default: true */
public boolean isOverridable() { return overridable; }
@Override
public int compareTo(FieldDescription other) {
return name.toString().compareTo(other.name.toString());
}
/** Returns a copy of this with the name set to the argument name */
public FieldDescription withName(CompoundName name) {
return new FieldDescription(name, type, aliases, mandatory, overridable);
}
/** Returns a copy of this with the type set to the argument type */
public FieldDescription withType(FieldType type) {
return new FieldDescription(name, type, aliases, mandatory, overridable);
}
@Override
public String toString() {
return "field '" + name + "' type " + type.stringValue() + "" +
(mandatory?" (mandatory)":"") + (!overridable?" (not overridable)":"");
}
}
|
