Package com.google.gerrit.index

Class IndexedField.SearchSpec

java.lang.Object

com.google.gerrit.index.IndexedField.SearchSpec

All Implemented Interfaces:

SchemaFieldDefs.SchemaField<I,T>

Enclosing class:

IndexedField<I,T>

public class IndexedField.SearchSpec
extends Object
implements SchemaFieldDefs.SchemaField<I,T>

Defines how IndexedField can be searched and how the index tokens are generated.

Multiple IndexedField.SearchSpec can be defined on single IndexedField.

Depending on the implementation, indexes can choose to store IndexedField and IndexedField.SearchSpec separately. The searches are issues to IndexedField.SearchSpec.

Constructor Summary

Constructors

Constructor	Description
SearchSpec(String name, SearchOption searchOption)

Method Summary

Modifier and Type	Method	Description
T	get(I obj)	Get the field contents from the input object.
IndexedField<I,T>	getField()	Returns IndexedField on which this spec was created.
String	getName()	Returns the name of the field.
SearchOption	getSearchOption()	Returns SearchOption enabled on this field.
FieldType<?>	getType()	Returns type of the field; for repeatable fields, the inner type, not the iterable type.
boolean	isRepeatable()	Returns whether the field is repeatable.
boolean	isStored()	Returns whether the field should be stored in the index.
boolean	setIfPossible(I object, StoredValue doc)	Set the field contents back to an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchSpec

public SearchSpec(String name,
                  SearchOption searchOption)

Method Detail

isStored

public boolean isStored()

Description copied from interface: SchemaFieldDefs.SchemaField

Returns whether the field should be stored in the index.

Specified by:

isStored in interface SchemaFieldDefs.SchemaField<I,T>

isRepeatable

public boolean isRepeatable()

Description copied from interface: SchemaFieldDefs.SchemaField

Returns whether the field is repeatable.

Specified by:

isRepeatable in interface SchemaFieldDefs.SchemaField<I,T>

get

public T get(I obj)

Description copied from interface: SchemaFieldDefs.SchemaField

Get the field contents from the input object.

Specified by:

get in interface SchemaFieldDefs.SchemaField<I,T>

Parameters:

obj - input object.

Returns:

the field value(s) to index.

getName

public String getName()

Description copied from interface: SchemaFieldDefs.SchemaField

Returns the name of the field.

Specified by:

getName in interface SchemaFieldDefs.SchemaField<I,T>

getType

public FieldType<?> getType()

Description copied from interface: SchemaFieldDefs.SchemaField

Returns type of the field; for repeatable fields, the inner type, not the iterable type. TODO(mariasavtchuk): remove after migrating to the new field formats

Specified by:

getType in interface SchemaFieldDefs.SchemaField<I,T>

setIfPossible

public boolean setIfPossible(I object,
                             StoredValue doc)

Description copied from interface: SchemaFieldDefs.SchemaField

Set the field contents back to an object. Used to reconstruct fields from indexed values. No-op if the field can't be reconstructed.

Specified by:

setIfPossible in interface SchemaFieldDefs.SchemaField<I,T>

Parameters:

object - input object.

doc - indexed document

Returns:

true if the field was set, false otherwise

getSearchOption

public SearchOption getSearchOption()

Returns SearchOption enabled on this field.

Returns:

SearchOption

getField

public IndexedField<I,T> getField()

Returns IndexedField on which this spec was created.

Returns:

original IndexedField of this spec.