com.google.gerrit.index

Class FieldDef<I,T>

java.lang.Object

com.google.gerrit.index.FieldDef<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 final class FieldDef<I,T>
extends java.lang.Object

Definition of a field stored in the secondary index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldDef.Builder<T>
static interface	FieldDef.Getter<I,T>

Method Summary

Modifier and Type	Method and Description
static FieldDef.Builder<java.lang.String>	exact(java.lang.String name)
static FieldDef.Builder<java.lang.String>	fullText(java.lang.String name)
T	get(I input) Get the field contents from the input object.
java.lang.String	getName()
FieldType<?>	getType()
static FieldDef.Builder<java.lang.Integer>	integer(java.lang.String name)
static FieldDef.Builder<java.lang.Integer>	intRange(java.lang.String name)
boolean	isRepeatable()
boolean	isStored()
static FieldDef.Builder<java.lang.String>	prefix(java.lang.String name)
static FieldDef.Builder<byte[]>	storedOnly(java.lang.String name)
static FieldDef.Builder<java.sql.Timestamp>	timestamp(java.lang.String name)

Methods inherited from class java.lang.Object

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

Method Detail

exact

public static FieldDef.Builder<java.lang.String> exact(java.lang.String name)

fullText

public static FieldDef.Builder<java.lang.String> fullText(java.lang.String name)

intRange

public static FieldDef.Builder<java.lang.Integer> intRange(java.lang.String name)

integer

public static FieldDef.Builder<java.lang.Integer> integer(java.lang.String name)

prefix

public static FieldDef.Builder<java.lang.String> prefix(java.lang.String name)

storedOnly

public static FieldDef.Builder<byte[]> storedOnly(java.lang.String name)

timestamp

public static FieldDef.Builder<java.sql.Timestamp> timestamp(java.lang.String name)

getName

public java.lang.String getName()

Returns:

name of the field.

getType

public FieldType<?> getType()

Returns:

type of the field; for repeatable fields, the inner type, not the iterable type.

isStored

public boolean isStored()

Returns:

whether the field should be stored in the index.

get

public T get(I input)
      throws com.google.gwtorm.server.OrmException

Get the field contents from the input object.

Parameters:

input - input object.

Returns:

the field value(s) to index.

Throws:

com.google.gwtorm.server.OrmException

isRepeatable

public boolean isRepeatable()

Returns:

whether the field is repeatable.