Package com.google.gerrit.index

Class IndexedField<I,T>

java.lang.Object

com.google.gerrit.index.IndexedField<I,T>

Type Parameters:

I - input type from which documents are created and search results are returned.

T - type that should be extracted from the input object when converting to an index document.

public abstract class IndexedField<I,T>
extends Object

Definition of a field stored in the secondary index.

Each IndexedField, stored in index, may have multiple IndexedField<I,T>.SearchSpec which defines how it can be searched and how the index tokens are generated.

Index implementations may choose to store IndexedField and IndexedField<I,T>.SearchSpec (search tokens) separately, however IndexedQuery always issues the queries to IndexedField<I,T>.SearchSpec.

This allows index implementations to store IndexedField once, while enabling multiple tokenization strategies on the same IndexedField with IndexedField<I,T>.SearchSpec

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexedField.Builder<I,T>	A builder for IndexedField.
class	IndexedField.SearchSpec	Defines how IndexedField can be searched and how the index tokens are generated.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.google.common.reflect.TypeToken<byte[]>	BYTE_ARRAY_TYPE
static final com.google.common.reflect.TypeToken<Integer>	INTEGER_TYPE
static final com.google.common.reflect.TypeToken<Iterable<byte[]>>	ITERABLE_BYTE_ARRAY_TYPE
static final com.google.common.reflect.TypeToken<Iterable<Integer>>	ITERABLE_INTEGER_TYPE
static final com.google.common.reflect.TypeToken<Iterable<Long>>	ITERABLE_LONG_TYPE
static final com.google.common.reflect.TypeToken<Iterable<String>>	ITERABLE_STRING_TYPE
static final com.google.common.reflect.TypeToken<Long>	LONG_TYPE
static final com.google.common.reflect.TypeToken<String>	STRING_TYPE
static final com.google.common.reflect.TypeToken<Timestamp>	TIMESTAMP_TYPE

Constructor Summary

Constructors

Constructor	Description
IndexedField()

Method Summary

Modifier and Type	Method	Description
IndexedField<I,T>.SearchSpec	addSearchSpec(String name, SearchOption searchOption)	Adds IndexedField<I,T>.SearchSpec to this IndexedField
static <I, T> IndexedField.Builder<I,T>	builder(String name, com.google.common.reflect.TypeToken<T> fieldType)
static <I> IndexedField.Builder<I,byte[]>	byteArrayBuilder(String name)
abstract Optional<String>	description()	Optional description of the field data.
IndexedField<I,T>.SearchSpec	exact(String name)
abstract Optional<SchemaFieldDefs.Setter<I,T>>	fieldSetter()	See SchemaFieldDefs.Setter
abstract com.google.common.reflect.TypeToken<T>	fieldType()	The TypeToken describing the contents of the field.
IndexedField<I,T>.SearchSpec	fullText(String name)
T	get(I input)	Get the field contents from the input object.
com.google.common.collect.ImmutableMap<String,IndexedField<I,T>.SearchSpec>	getSearchSpecs()	Returns all IndexedField<I,T>.SearchSpec, enabled on this field.
abstract SchemaFieldDefs.Getter<I,T>	getter()	See SchemaFieldDefs.Getter
IndexedField<I,T>.SearchSpec	integer(String name)
static <I> IndexedField.Builder<I,Integer>	integerBuilder(String name)
IndexedField<I,T>.SearchSpec	integerRange(String name)
boolean	isProtoIterableType()	Returns true if the fieldType() is a list of proto messages.
boolean	isProtoType()	Returns true if the fieldType() is a proto message.
static <I> IndexedField.Builder<I,Iterable<byte[]>>	iterableByteArrayBuilder(String name)
static <I> IndexedField.Builder<I,Iterable<Integer>>	iterableIntegerBuilder(String name)
static <I> IndexedField.Builder<I,Iterable<String>>	iterableStringBuilder(String name)
static <I> IndexedField.Builder<I,Long>	longBuilder(String name)
IndexedField<I,T>.SearchSpec	longSearch(String name)
abstract String	name()	The name to store this field under.
IndexedField<I,T>.SearchSpec	prefix(String name)
abstract Optional<ProtoConverter<? extends com.google.protobuf.MessageLite,?>>	protoConverter()	If the fieldType() is proto, the converter to use on byte/proto conversions.
IndexedField<I,T>.SearchSpec	range(String name)
abstract boolean	repeatable()	True if this field is repeatable.
abstract boolean	required()	True if this field is mandatory.
boolean	setIfPossible(I object, StoredValue doc)
abstract Optional<Integer>	size()	Optional size constrain on the field.
abstract boolean	stored()	Allow reading the actual data from the index.
IndexedField<I,T>.SearchSpec	storedOnly(String name)
static <I> IndexedField.Builder<I,String>	stringBuilder(String name)
IndexedField<I,T>.SearchSpec	timestamp(String name)
static <I> IndexedField.Builder<I,Timestamp>	timestampBuilder(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INTEGER_TYPE

public static final com.google.common.reflect.TypeToken<Integer> INTEGER_TYPE

ITERABLE_INTEGER_TYPE

public static final com.google.common.reflect.TypeToken<Iterable<Integer>> ITERABLE_INTEGER_TYPE

LONG_TYPE

public static final com.google.common.reflect.TypeToken<Long> LONG_TYPE

ITERABLE_LONG_TYPE

public static final com.google.common.reflect.TypeToken<Iterable<Long>> ITERABLE_LONG_TYPE

STRING_TYPE

public static final com.google.common.reflect.TypeToken<String> STRING_TYPE

ITERABLE_STRING_TYPE

public static final com.google.common.reflect.TypeToken<Iterable<String>> ITERABLE_STRING_TYPE

BYTE_ARRAY_TYPE

public static final com.google.common.reflect.TypeToken<byte[]> BYTE_ARRAY_TYPE

ITERABLE_BYTE_ARRAY_TYPE

public static final com.google.common.reflect.TypeToken<Iterable<byte[]>> ITERABLE_BYTE_ARRAY_TYPE

TIMESTAMP_TYPE

public static final com.google.common.reflect.TypeToken<Timestamp> TIMESTAMP_TYPE

Constructor Details

IndexedField

public IndexedField()

Method Details

builder

public static <I,
T> IndexedField.Builder<I,T> builder(String name,
 com.google.common.reflect.TypeToken<T> fieldType)

iterableStringBuilder

public static <I>
IndexedField.Builder<I,Iterable<String>> iterableStringBuilder(String name)

stringBuilder

public static <I> IndexedField.Builder<I,String> stringBuilder(String name)

integerBuilder

public static <I> IndexedField.Builder<I,Integer> integerBuilder(String name)

longBuilder

public static <I> IndexedField.Builder<I,Long> longBuilder(String name)

iterableIntegerBuilder

public static <I>
IndexedField.Builder<I,Iterable<Integer>> iterableIntegerBuilder(String name)

timestampBuilder

public static <I> IndexedField.Builder<I,Timestamp> timestampBuilder(String name)

byteArrayBuilder

public static <I> IndexedField.Builder<I,byte[]> byteArrayBuilder(String name)

iterableByteArrayBuilder

public static <I>
IndexedField.Builder<I,Iterable<byte[]>> iterableByteArrayBuilder(String name)

addSearchSpec

public IndexedField<I,T>.SearchSpec addSearchSpec(String name,
 SearchOption searchOption)

Adds IndexedField<I,T>.SearchSpec to this IndexedField

Parameters:

name - the name to use for in the search.

searchOption - the tokenization option, enabled by the new IndexedField<I,T>.SearchSpec

Returns:

the added IndexedField<I,T>.SearchSpec.

exact

public IndexedField<I,T>.SearchSpec exact(String name)

fullText

public IndexedField<I,T>.SearchSpec fullText(String name)

range

public IndexedField<I,T>.SearchSpec range(String name)

integerRange

public IndexedField<I,T>.SearchSpec integerRange(String name)

integer

public IndexedField<I,T>.SearchSpec integer(String name)

longSearch

public IndexedField<I,T>.SearchSpec longSearch(String name)

prefix

public IndexedField<I,T>.SearchSpec prefix(String name)

storedOnly

public IndexedField<I,T>.SearchSpec storedOnly(String name)

timestamp

public IndexedField<I,T>.SearchSpec timestamp(String name)

name

public abstract String name()

The name to store this field under.

The name should use the UpperCamelCase format, see IndexedField.Builder.checkName(java.lang.String).

description

public abstract Optional<String> description()

Optional description of the field data.

required

public abstract boolean required()

True if this field is mandatory. Default is false.

This property is not enforced by the common indexing logic. It is up to the index implementations to enforce that the field is required.

stored

public abstract boolean stored()

Allow reading the actual data from the index. Default is false.

repeatable

public abstract boolean repeatable()

True if this field is repeatable.

size

public abstract Optional<Integer> size()

Optional size constrain on the field. The size is not constrained if this property is Optional.empty()

This property is not enforced by the common indexing logic. It is up to the index implementations to enforce the size.

If the field is repeatable(), the constraint applies to each element separately.

getter

public abstract SchemaFieldDefs.Getter<I,T> getter()

See SchemaFieldDefs.Getter

fieldSetter

public abstract Optional<SchemaFieldDefs.Setter<I,T>> fieldSetter()

See SchemaFieldDefs.Setter

fieldType

public abstract com.google.common.reflect.TypeToken<T> fieldType()

The TypeToken describing the contents of the field. See static constants for the common supported types.

Returns:

TypeToken of this field.

protoConverter

public abstract Optional<ProtoConverter<? extends com.google.protobuf.MessageLite,?>> protoConverter()

If the fieldType() is proto, the converter to use on byte/proto conversions.

getSearchSpecs

public com.google.common.collect.ImmutableMap<String,IndexedField<I,T>.SearchSpec> getSearchSpecs()

Returns all IndexedField<I,T>.SearchSpec, enabled on this field.

Note: weather or not a search is supported by the index depends on Schema version.

get

public T get(I input)

Get the field contents from the input object.

Parameters:

input - input object.

Returns:

the field value(s) to index.

setIfPossible

public boolean setIfPossible(I object,
 StoredValue doc)

isProtoType

public boolean isProtoType()

Returns true if the fieldType() is a proto message.

isProtoIterableType

public boolean isProtoIterableType()

Returns true if the fieldType() is a list of proto messages.