com.arangodb.entity

Class InvertedIndexField

java.lang.Object

com.arangodb.entity.InvertedIndexField

All Implemented Interfaces:

Entity

public class InvertedIndexField
extends Object
implements Entity

Since:

ArangoDB 3.10

Author:

Michele Rastelli

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
InvertedIndexField()

Method Summary

Modifier and Type	Method and Description
InvertedIndexField	analyzer(String analyzer)
InvertedIndexField	cache(Boolean cache)
boolean	equals(Object o)
InvertedIndexField	features(AnalyzerFeature... features)
String	getAnalyzer()
Boolean	getCache()
Set<AnalyzerFeature>	getFeatures()
Boolean	getIncludeAllFields()
String	getName()
Collection<InvertedIndexField>	getNested()
Boolean	getSearchField()
Boolean	getTrackListPositions()
int	hashCode()
InvertedIndexField	includeAllFields(Boolean includeAllFields)
InvertedIndexField	name(String name)
InvertedIndexField	nested(InvertedIndexField... nested)
InvertedIndexField	searchField(Boolean searchField)
InvertedIndexField	trackListPositions(Boolean trackListPositions)

Methods inherited from class java.lang.Object

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

Constructor Detail

InvertedIndexField

public InvertedIndexField()

Method Detail

getName

public String getName()

name

public InvertedIndexField name(String name)

Parameters:

name - An attribute path. The . character denotes sub-attributes.

Returns:

this

getAnalyzer

public String getAnalyzer()

analyzer

public InvertedIndexField analyzer(String analyzer)

Parameters:

analyzer - The name of an Analyzer to use for this field. Default: the value defined by the top-level analyzer option, or if not set, the default identity Analyzer.

Returns:

this

getIncludeAllFields

public Boolean getIncludeAllFields()

includeAllFields

public InvertedIndexField includeAllFields(Boolean includeAllFields)

Parameters:

includeAllFields - This option only applies if you use the inverted index in a search-alias Views. If set to true, then all sub-attributes of this field are indexed, excluding any sub-attributes that are configured separately by other elements in the fields array (and their sub-attributes). The analyzer and features properties apply to the sub-attributes. If set to false, then sub-attributes are ignored. The default value is defined by the top-level includeAllFields option, or false if not set.

Returns:

this

getSearchField

public Boolean getSearchField()

searchField

public InvertedIndexField searchField(Boolean searchField)

Parameters:

searchField - This option only applies if you use the inverted index in a search-alias Views. You can set the option to true to get the same behavior as with arangosearch Views regarding the indexing of array values for this field. If enabled, both, array and primitive values (strings, numbers, etc.) are accepted. Every element of an array is indexed according to the trackListPositions option. If set to false, it depends on the attribute path. If it explicitly expand an array ([*]), then the elements are indexed separately. Otherwise, the array is indexed as a whole, but only geopoint and aql Analyzers accept array inputs. You cannot use an array expansion if searchField is enabled. Default: the value defined by the top-level searchField option, or false if not set.

Returns:

this

getTrackListPositions

public Boolean getTrackListPositions()

trackListPositions

public InvertedIndexField trackListPositions(Boolean trackListPositions)

Parameters:

trackListPositions - This option only applies if you use the inverted index in a search-alias Views. If set to true, then track the value position in arrays for array values. For example, when querying a document like { attr: [ "valueX", "valueY", "valueZ" ] }, you need to specify the array element, e.g. doc.attr[1] == "valueY". If set to false, all values in an array are treated as equal alternatives. You don’t specify an array element in queries, e.g. doc.attr == "valueY", and all elements are searched for a match. Default: the value defined by the top-level trackListPositions option, or false if not set.

Returns:

this

getCache

public Boolean getCache()

cache

public InvertedIndexField cache(Boolean cache)

Parameters:

cache - Enable this option to always cache the field normalization values in memory for this specific field. This can improve the performance of scoring and ranking queries. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory. (Enterprise Edition only)

Returns:

this

Since:

ArangoDB 3.10.2

getFeatures

public Set<AnalyzerFeature> getFeatures()

features

public InvertedIndexField features(AnalyzerFeature... features)

Parameters:

features - A list of Analyzer features to use for this field. They define what features are enabled for the analyzer.

Returns:

this

getNested

public Collection<InvertedIndexField> getNested()

nested

public InvertedIndexField nested(InvertedIndexField... nested)

Parameters:

nested - Index the specified sub-objects that are stored in an array. Other than with the fields property, the values get indexed in a way that lets you query for co-occurring values. For example, you can search the sub-objects and all the conditions need to be met by a single sub-object instead of across all of them. This property is available in the Enterprise Edition only.

Returns:

this

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object