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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.document;
import com.yahoo.collections.BobHash;
import com.yahoo.document.fieldset.DocIdOnly;
import com.yahoo.document.fieldset.FieldSet;
import com.yahoo.document.fieldset.NoFields;
import com.yahoo.vespa.objects.FieldBase;
/**
* A name and type. Fields are contained in document types to describe their fields,
* but is also used to represent name/type pairs which are not part of document types.
*
* @author Thomas Gundersen
* @author bratseth
*/
public class Field extends FieldBase implements FieldSet, Comparable<Field> {
protected DataType dataType;
protected int fieldId;
private boolean forcedId;
/**
* Creates a new field.
*
* @param name The name of the field
* @param id Serialized ID
* @param dataType The datatype of the field
*/
public Field(String name, int id, DataType dataType) {
super(name);
this.fieldId = id;
this.dataType = dataType;
this.forcedId = true;
validateId(id, null);
}
public Field(String name) {
this(name, DataType.NONE);
}
/**
* Creates a new field.
*
* @param name The name of the field
* @param dataType The datatype of the field
* @param owner the owning document (used to check for id collisions)
*/
public Field(String name, DataType dataType, DocumentType owner) {
this(name, 0, dataType);
this.fieldId = calculateIdV7(owner);
this.forcedId = false;
}
/**
* Constructor for normal fields
*
* @param name The name of the field
* @param dataType The datatype of the field
*/
public Field(String name, DataType dataType) {
this(name, dataType, null);
}
/**
* Creates a field with a new name and the other properties
* (excluding the id and owner) copied from another field
*/
// TODO: Decide on one copy/clone idiom and do it for this and all it is calling
public Field(String name, Field field) {
this(name, field.dataType, null);
}
public int compareTo(Field o) {
return fieldId - o.fieldId;
}
/**
* The field id must be unique within a document type, and also
* within a (unknown at this time) hierarchy of document types.
* In addition it should be as resilient to doctype content changes
* and inheritance hierarchy changes as possible.
* All of this is enforced for names, so id's should follow names.
* Therefore we hash on name.
*/
protected int calculateIdV7(DocumentType owner) {
String combined = getName() + dataType.getId();
int newId = BobHash.hash(combined); // Using a portfriendly hash
if (newId < 0) newId = -newId; // Highest bit is reserved to tell 7-bit id's from 31-bit ones
validateId(newId, owner);
return newId;
}
/**
* Sets the id of this field. Don't do this unless you know what you are doing
*
* @param newId the id - if this is less than 100 it will cause document to serialize
* using just one byte for this field id. 100-127 are reserved values
* @param owner the owning document, this is checked for collisions and notified
* of the id change. It can not be null
*/
public void setId(int newId, DocumentType owner) {
if (owner == null) {
throw new NullPointerException("Can not assign an id of " + this + " without knowing the owner");
}
validateId(newId, owner);
owner.removeField(getName());
this.fieldId = newId;
this.forcedId = true;
owner.addField(this);
}
private void validateId(int newId, DocumentType owner) {
if (newId >= 100 && newId <= 127) {
throw new IllegalArgumentException("Attempt to set the id of " + this + " to " + newId +
" failed, values from 100 to 127 " + "are reserved for internal use");
}
if ((newId & 0x80000000) != 0) // Highest bit must not be set
{
throw new IllegalArgumentException("Attempt to set the id of " + this + " to " + newId +
" failed, negative id values " + " are illegal");
}
if (owner == null) return;
{
Field existing = owner.getField(newId);
if (existing != null && !existing.getName().equals(getName())) {
throw new IllegalArgumentException("Couldn't set id of " + this + " to " + newId + ", " + existing +
" already has this id in " + owner);
}
}
}
/** Returns the datatype of the field */
public final DataType getDataType() {
return dataType;
}
/**
* Set the data type of the field. This will cause recalculation of fieldid for version 7+.
*
* @param type The new type of the field.
* @deprecated do not use
*/
@Deprecated // TODO: Refactor SD processing to avoid needing this
public void setDataType(DataType type) {
dataType = type;
fieldId = calculateIdV7(null);
forcedId = false;
}
public final int getId() {
return fieldId;
}
/**
*
* @return true if the field has a forced id
*/
public final boolean hasForcedId() {
return forcedId;
}
/** Two fields are equal if they have the same name and the same data type */
@Override
public boolean equals(Object o) {
return this == o || o instanceof Field && super.equals(o) && dataType.equals(((Field) o).dataType);
}
@Override
public int hashCode() {
return getId();
}
@Override
public String toString() {
return super.toString() + "(" + dataType + ")";
}
@Override
public boolean contains(FieldSet o) {
if (o instanceof NoFields || o instanceof DocIdOnly) {
return true;
}
if (o instanceof Field) {
return equals(o);
}
return false;
}
@Override
public FieldSet clone() throws CloneNotSupportedException {
return (Field)super.clone();
}
}
|
