Package org.nuxeo.elasticsearch.config

Class ESHintQueryBuilderDescriptor

java.lang.Object

org.nuxeo.elasticsearch.config.ESHintQueryBuilderDescriptor

All Implemented Interfaces:

Descriptor

public class ESHintQueryBuilderDescriptor
extends Object
implements Descriptor

This descriptor allows to add a Elasticsearch Hint.

Since:

11.1

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<? extends ESHintQueryBuilder>	klass
protected String	name
boolean	remove

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
ESHintQueryBuilderDescriptor()

Method Summary

Modifier and Type	Method	Description
boolean	doesRemove()	During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.
String	getId()	The descriptor id, descriptors with same id are merged.
Class<? extends ESHintQueryBuilder>	getKlass()
String	getName()
ESHintQueryBuilderDescriptor	merge(Descriptor descriptor)	Returns a descriptor representing other merged into this
ESHintQueryBuilder	newInstance()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

klass

protected Class<? extends ESHintQueryBuilder> klass

remove

public boolean remove

Constructor Detail

ESHintQueryBuilderDescriptor

public ESHintQueryBuilderDescriptor()

Method Detail

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

merge

public ESHintQueryBuilderDescriptor merge(Descriptor descriptor)

Description copied from interface: Descriptor

Returns a descriptor representing other merged into this

Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor

doesRemove

public boolean doesRemove()

Description copied from interface: Descriptor

During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.

If the last descriptor of same id doesRemove() return true, the descriptor for this id will be null.

Specified by:

doesRemove in interface Descriptor

getName

public String getName()

getKlass

public Class<? extends ESHintQueryBuilder> getKlass()

newInstance

public ESHintQueryBuilder newInstance()