com.google.gerrit.index.FieldDef Maven / Gradle / Ivy
// Copyright (C) 2013 The Android Open Source Project
//
// 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.gerrit.index;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkState;
import static java.util.Objects.requireNonNull;
import com.google.common.base.CharMatcher;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.exceptions.StorageException;
import com.google.gerrit.index.SchemaFieldDefs.Getter;
import com.google.gerrit.index.SchemaFieldDefs.SchemaField;
import com.google.gerrit.index.SchemaFieldDefs.Setter;
import java.io.IOException;
import java.sql.Timestamp;
import java.util.Optional;
/**
* Definition of a field stored in the secondary index.
*
* {@link FieldDef}-s must not be changed once introduced to the codebase. Instead, a new
* FieldDef must be added and the old one removed from the schema (in two upgrade steps, see {@code
* com.google.gerrit.index.IndexUpgradeValidator}).
*
*
Note that {@link FieldDef} does not override {@link Object#equals(Object)}. It relies on
* instances being singletons so that the default (i.e. reference) comparison works.
*
* @param input type from which documents are created and search results are returned.
* @param type that should be extracted from the input object when converting to an index
* document.
*/
public final class FieldDef implements SchemaField {
public static FieldDef.Builder exact(String name) {
return new FieldDef.Builder<>(FieldType.EXACT, name);
}
public static FieldDef.Builder fullText(String name) {
return new FieldDef.Builder<>(FieldType.FULL_TEXT, name);
}
public static FieldDef.Builder intRange(String name) {
return new FieldDef.Builder<>(FieldType.INTEGER_RANGE, name).stored();
}
public static FieldDef.Builder integer(String name) {
return new FieldDef.Builder<>(FieldType.INTEGER, name);
}
public static FieldDef.Builder prefix(String name) {
return new FieldDef.Builder<>(FieldType.PREFIX, name);
}
public static FieldDef.Builder storedOnly(String name) {
return new FieldDef.Builder<>(FieldType.STORED_ONLY, name).stored();
}
public static FieldDef.Builder timestamp(String name) {
return new FieldDef.Builder<>(FieldType.TIMESTAMP, name);
}
public static class Builder {
private final FieldType type;
private final String name;
private boolean stored;
public Builder(FieldType type, String name) {
this.type = requireNonNull(type);
this.name = requireNonNull(name);
}
public Builder stored() {
this.stored = true;
return this;
}
public FieldDef build(Getter getter) {
return new FieldDef<>(name, type, stored, false, getter, null);
}
public FieldDef build(Getter getter, Setter setter) {
return new FieldDef<>(name, type, stored, false, getter, setter);
}
public FieldDef> buildRepeatable(Getter> getter) {
return new FieldDef<>(name, type, stored, true, getter, null);
}
public FieldDef> buildRepeatable(
Getter> getter, Setter> setter) {
return new FieldDef<>(name, type, stored, true, getter, setter);
}
}
private final String name;
private final FieldType type;
/** Allow reading the actual data from the index. */
private final boolean stored;
private final boolean repeatable;
private final Getter getter;
private final Optional> setter;
private FieldDef(
String name,
FieldType type,
boolean stored,
boolean repeatable,
Getter getter,
@Nullable Setter setter) {
checkArgument(
!(repeatable && type == FieldType.INTEGER_RANGE),
"Range queries against repeated fields are unsupported");
this.name = checkName(name);
this.type = requireNonNull(type);
this.stored = stored;
this.repeatable = repeatable;
this.getter = requireNonNull(getter);
this.setter = Optional.ofNullable(setter);
}
private static String checkName(String name) {
CharMatcher m = CharMatcher.anyOf("abcdefghijklmnopqrstuvwxyz0123456789_");
checkArgument(name != null && m.matchesAllOf(name), "illegal field name: %s", name);
return name;
}
/** Returns name of the field. */
@Override
public String getName() {
return name;
}
/** Returns type of the field; for repeatable fields, the inner type, not the iterable type. */
@Override
public FieldType getType() {
return type;
}
/** Returns whether the field should be stored in the index. */
@Override
public boolean isStored() {
return stored;
}
/**
* Get the field contents from the input object.
*
* @param input input object.
* @return the field value(s) to index.
*/
@Override
@Nullable
public T get(I input) {
try {
return getter.get(input);
} catch (IOException e) {
throw new StorageException(e);
}
}
/**
* Set the field contents back to an object. Used to reconstruct fields from indexed values. No-op
* if the field can't be reconstructed.
*
* @param object input object.
* @param doc indexed document
* @return {@code true} if the field was set, {@code false} otherwise
*/
@SuppressWarnings("unchecked")
@Override
public boolean setIfPossible(I object, StoredValue doc) {
if (!setter.isPresent()) {
return false;
}
if (FieldType.STRING_TYPES.stream().anyMatch(t -> t.getName().equals(getType().getName()))) {
setter.get().set(object, (T) (isRepeatable() ? doc.asStrings() : doc.asString()));
return true;
} else if (FieldType.INTEGER_TYPES.stream()
.anyMatch(t -> t.getName().equals(getType().getName()))) {
setter.get().set(object, (T) (isRepeatable() ? doc.asIntegers() : doc.asInteger()));
return true;
} else if (FieldType.LONG.getName().equals(getType().getName())) {
setter.get().set(object, (T) (isRepeatable() ? doc.asLongs() : doc.asLong()));
return true;
} else if (FieldType.STORED_ONLY.getName().equals(getType().getName())) {
setter.get().set(object, (T) (isRepeatable() ? doc.asByteArrays() : doc.asByteArray()));
return true;
} else if (FieldType.TIMESTAMP.getName().equals(getType().getName())) {
checkState(!isRepeatable(), "can't repeat timestamp values");
setter.get().set(object, (T) doc.asTimestamp());
return true;
}
return false;
}
/** Returns whether the field is repeatable. */
@Override
public boolean isRepeatable() {
return repeatable;
}
}