/
FieldValue.java
307 lines (280 loc) · 11.6 KB
/
FieldValue.java
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/*
* Copyright 2015 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.bigquery;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import com.google.api.client.util.Data;
import com.google.api.core.BetaApi;
import com.google.common.base.MoreObjects;
import com.google.common.io.BaseEncoding;
import java.io.Serializable;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
* Google BigQuery Table Field Value class. Objects of this class represent values of a BigQuery
* Table Field. A list of values forms a table row. Tables rows can be gotten as the result of a
* query or when listing table data.
*/
public class FieldValue implements Serializable {
private static final int MICROSECONDS = 1000000;
private static final long serialVersionUID = 469098630191710061L;
private final Attribute attribute;
private final Object value;
/** The field value's attribute, giving information on the field's content type. */
public enum Attribute {
/**
* A primitive field value. A {@code FieldValue} is primitive when the corresponding field has
* type {@link LegacySQLTypeName#BYTES}, {@link LegacySQLTypeName#BOOLEAN}, {@link
* LegacySQLTypeName#STRING}, {@link LegacySQLTypeName#FLOAT}, {@link
* LegacySQLTypeName#INTEGER}, {@link LegacySQLTypeName#NUMERIC}, {@link
* LegacySQLTypeName#TIMESTAMP}, {@link LegacySQLTypeName#GEOGRAPHY} or the value is set to
* {@code null}.
*/
PRIMITIVE,
/** A {@code FieldValue} for a field with {@link Field.Mode#REPEATED} mode. */
REPEATED,
/** A {@code FieldValue} for a field of type {@link LegacySQLTypeName#RECORD}. */
RECORD
}
private FieldValue(Attribute attribute, Object value) {
this.attribute = checkNotNull(attribute);
this.value = value;
}
/**
* Returns the attribute of this Field Value.
*
* @return {@link Attribute#PRIMITIVE} if the field is a primitive type ({@link
* LegacySQLTypeName#BYTES}, {@link LegacySQLTypeName#BOOLEAN}, {@link
* LegacySQLTypeName#STRING}, {@link LegacySQLTypeName#FLOAT}, {@link
* LegacySQLTypeName#INTEGER}, {@link LegacySQLTypeName#NUMERIC}, {@link
* LegacySQLTypeName#TIMESTAMP}, {@link LegacySQLTypeName#GEOGRAPHY}) or is {@code null}.
* <p>Returns {@link Attribute#REPEATED} if the corresponding field has ({@link
* Field.Mode#REPEATED}) mode. Returns {@link Attribute#RECORD} if the corresponding field is
* a {@link LegacySQLTypeName#RECORD} type.
*/
public Attribute getAttribute() {
return attribute;
}
/** Returns {@code true} if this field's value is {@code null}, {@code false} otherwise. */
public boolean isNull() {
return value == null;
}
/**
* Returns this field's value as an {@link Object}. If {@link #isNull()} is {@code true} this
* method returns {@code null}.
*/
public Object getValue() {
return value;
}
/**
* Returns this field's value as a {@link String}. This method should only be used if the
* corresponding field has primitive type ({@link LegacySQLTypeName#BYTES}, {@link
* LegacySQLTypeName#BOOLEAN}, {@link LegacySQLTypeName#STRING}, {@link LegacySQLTypeName#FLOAT},
* {@link LegacySQLTypeName#INTEGER}, {@link LegacySQLTypeName#NUMERIC} {@link
* LegacySQLTypeName#TIMESTAMP}).
*
* @throws ClassCastException if the field is not a primitive type
* @throws NullPointerException if {@link #isNull()} returns {@code true}
*/
@SuppressWarnings("unchecked")
public String getStringValue() {
checkNotNull(value);
return (String) value;
}
/**
* Returns this field's value as a byte array. This method should only be used if the
* corresponding field has primitive type ({@link LegacySQLTypeName#BYTES}.
*
* @throws ClassCastException if the field is not a primitive type
* @throws NullPointerException if {@link #isNull()} returns {@code true}
* @throws IllegalStateException if the field value is not encoded in base64
*/
public byte[] getBytesValue() {
try {
return BaseEncoding.base64().decode(getStringValue());
} catch (IllegalArgumentException ex) {
throw new IllegalStateException(ex);
}
}
/**
* Returns this field's value as a {@code long}. This method should only be used if the
* corresponding field has {@link LegacySQLTypeName#INTEGER} type.
*
* @throws ClassCastException if the field is not a primitive type
* @throws NumberFormatException if the field's value could not be converted to {@link Integer}
* @throws NullPointerException if {@link #isNull()} returns {@code true}
*/
@SuppressWarnings("unchecked")
public long getLongValue() {
return Long.parseLong(getStringValue());
}
/**
* Returns this field's value as a {@link Double}. This method should only be used if the
* corresponding field has {@link LegacySQLTypeName#FLOAT} type.
*
* @throws ClassCastException if the field is not a primitive type
* @throws NumberFormatException if the field's value could not be converted to {@link Double}
* @throws NullPointerException if {@link #isNull()} returns {@code true}
*/
@SuppressWarnings("unchecked")
public double getDoubleValue() {
return Double.parseDouble(getStringValue());
}
/**
* Returns this field's value as a {@link Boolean}. This method should only be used if the
* corresponding field has {@link LegacySQLTypeName#BOOLEAN} type.
*
* @throws ClassCastException if the field is not a primitive type
* @throws IllegalStateException if the field's value could not be converted to {@link Boolean}
* @throws NullPointerException if {@link #isNull()} returns {@code true}
*/
@SuppressWarnings("unchecked")
public boolean getBooleanValue() {
String stringValue = getStringValue();
checkState(
stringValue.equalsIgnoreCase("true") || stringValue.equalsIgnoreCase("false"),
"Field value is not of boolean type");
return Boolean.parseBoolean(stringValue);
}
/**
* Returns this field's value as a {@code long}, representing a timestamp in microseconds since
* epoch (UNIX time). This method should only be used if the corresponding field has {@link
* LegacySQLTypeName#TIMESTAMP} type.
*
* @throws ClassCastException if the field is not a primitive type
* @throws NumberFormatException if the field's value could not be converted to {@link Long}
* @throws NullPointerException if {@link #isNull()} returns {@code true}
*/
@SuppressWarnings("unchecked")
public long getTimestampValue() {
// timestamps are encoded in the format 1408452095.22 where the integer part is seconds since
// epoch (e.g. 1408452095.22 == 2014-08-19 07:41:35.220 -05:00)
BigDecimal secondsWithMicro = new BigDecimal(getStringValue());
BigDecimal scaled = secondsWithMicro.scaleByPowerOfTen(6).setScale(0, RoundingMode.HALF_UP);
return scaled.longValue();
}
/**
* Returns this field's value as a {@link java.math.BigDecimal}. This method should only be used
* if the corresponding field has {@link LegacySQLTypeName#NUMERIC} type.
*
* @throws ClassCastException if the field is not a primitive type
* @throws NumberFormatException if the field's value could not be converted to {@link
* java.math.BigDecimal}
* @throws NullPointerException if {@link #isNull()} returns {@code true}
*/
@SuppressWarnings("unchecked")
public BigDecimal getNumericValue() {
return new BigDecimal(getStringValue());
}
/**
* Returns this field's value as a list of {@link FieldValue}. This method should only be used if
* the corresponding field has {@link Field.Mode#REPEATED} mode (i.e. {@link #getAttribute()} is
* {@link Attribute#REPEATED}).
*
* @throws ClassCastException if the field has not {@link Field.Mode#REPEATED} mode
* @throws NullPointerException if {@link #isNull()} returns {@code true}
*/
@SuppressWarnings("unchecked")
public List<FieldValue> getRepeatedValue() {
checkNotNull(value);
return (List<FieldValue>) value;
}
/**
* Returns this field's value as a {@link FieldValueList} instance. This method should only be
* used if the corresponding field has {@link LegacySQLTypeName#RECORD} type (i.e. {@link
* #getAttribute()} is {@link Attribute#RECORD}).
*
* @throws ClassCastException if the field is not a {@link LegacySQLTypeName#RECORD} type
* @throws NullPointerException if {@link #isNull()} returns {@code true}
*/
public FieldValueList getRecordValue() {
checkNotNull(value);
return (FieldValueList) value;
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("attribute", attribute)
.add("value", value)
.toString();
}
@Override
public final int hashCode() {
return Objects.hash(attribute, value);
}
@Override
public final boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj == null || !obj.getClass().equals(FieldValue.class)) {
return false;
}
FieldValue other = (FieldValue) obj;
return attribute == other.attribute && Objects.equals(value, other.value);
}
/**
* Creates an instance of {@code FieldValue}, useful for testing.
*
* <p>If the {@code attribute} is {@link Attribute#PRIMITIVE}, the {@code value} should be the
* string representation of the underlying value, eg {@code "123"} for number {@code 123}.
*
* <p>If the {@code attribute} is {@link Attribute#REPEATED} or {@link Attribute#RECORD}, the
* {@code value} should be {@code List} of {@link FieldValue}s or {@link FieldValueList},
* respectively.
*
* <p>This method is unstable. See <a
* href="https://github.com/googleapis/google-cloud-java/pull/2891">this discussion</a> for more
* context.
*/
@BetaApi
public static FieldValue of(Attribute attribute, Object value) {
return new FieldValue(attribute, value);
}
static FieldValue fromPb(Object cellPb) {
return fromPb(cellPb, null);
}
@SuppressWarnings("unchecked")
static FieldValue fromPb(Object cellPb, Field recordSchema) {
if (Data.isNull(cellPb)) {
return FieldValue.of(Attribute.PRIMITIVE, null);
}
if (cellPb instanceof String) {
return FieldValue.of(Attribute.PRIMITIVE, cellPb);
}
if (cellPb instanceof List) {
return FieldValue.of(Attribute.REPEATED, FieldValueList.fromPb((List<Object>) cellPb, null));
}
if (cellPb instanceof Map) {
Map<String, Object> cellMapPb = (Map<String, Object>) cellPb;
if (cellMapPb.containsKey("f")) {
FieldList subFieldsSchema = recordSchema != null ? recordSchema.getSubFields() : null;
return FieldValue.of(
Attribute.RECORD,
FieldValueList.fromPb((List<Object>) cellMapPb.get("f"), subFieldsSchema));
}
// This should never be the case when we are processing a first level table field (i.e. a
// row's field, not a record sub-field)
if (cellMapPb.containsKey("v")) {
return FieldValue.fromPb(cellMapPb.get("v"), recordSchema);
}
}
throw new IllegalArgumentException("Unexpected table cell format");
}
}