com.arangodb.entity.arangosearch

Class CollectionLink

java.lang.Object

com.arangodb.entity.arangosearch.CollectionLink

public class CollectionLink
extends Object

Author:

Mark Vollmary

Method Summary

Modifier and Type	Method and Description
CollectionLink	analyzers(String... analyzers)
CollectionLink	cache(Boolean cache)
CollectionLink	fields(FieldLink... fields)
Collection<String>	getAnalyzers()
Boolean	getCache()
Collection<FieldLink>	getFields()
Boolean	getInBackground()
Boolean	getIncludeAllFields()
String	getName()
Collection<FieldLink>	getNested()
StoreValuesType	getStoreValues()
Boolean	getTrackListPositions()
CollectionLink	inBackground(Boolean inBackground)
CollectionLink	includeAllFields(Boolean includeAllFields)
CollectionLink	nested(FieldLink... nested)
static CollectionLink	on(String name) Creates an instance of CollectionLink on the given collection name
CollectionLink	storeValues(StoreValuesType storeValues)
CollectionLink	trackListPositions(Boolean trackListPositions)

Methods inherited from class java.lang.Object

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

Method Detail

on

public static CollectionLink on(String name)

Creates an instance of CollectionLink on the given collection name

Parameters:

name - Name of a collection

Returns:

new instance of CollectionLink

analyzers

public CollectionLink analyzers(String... analyzers)

Parameters:

analyzers - The list of analyzers to be used for indexing of string values (default: ["identity"]).

Returns:

link

includeAllFields

public CollectionLink includeAllFields(Boolean includeAllFields)

Parameters:

includeAllFields - The flag determines whether or not to index all fields on a particular level of depth (default: false).

Returns:

link

trackListPositions

public CollectionLink trackListPositions(Boolean trackListPositions)

Parameters:

trackListPositions - The flag determines whether or not values in a lists should be treated separate (default: false).

Returns:

link

storeValues

public CollectionLink storeValues(StoreValuesType storeValues)

Parameters:

storeValues - How should the view track the attribute values, this setting allows for additional value retrieval optimizations (default "none").

Returns:

link

fields

public CollectionLink fields(FieldLink... fields)

Parameters:

fields - A list of linked fields

Returns:

link

nested

public CollectionLink nested(FieldLink... nested)

Parameters:

nested - A list of nested fields

Returns:

link

Since:

ArangoDB 3.10

inBackground

public CollectionLink inBackground(Boolean inBackground)

Parameters:

inBackground - If set to true, then no exclusive lock is used on the source collection during View index creation, so that it remains basically available. inBackground is an option that can be set when adding links. It does not get persisted as it is not a View property, but only a one-off option. (default: false)

Returns:

link

cache

public CollectionLink cache(Boolean cache)

Parameters:

cache - If you enable this option, then field normalization values are always cached in memory. 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.

Returns:

link

Since:

ArangoDB 3.9.5, Enterprise Edition only

getName

public String getName()

getAnalyzers

public Collection<String> getAnalyzers()

getIncludeAllFields

public Boolean getIncludeAllFields()

getTrackListPositions

public Boolean getTrackListPositions()

getStoreValues

public StoreValuesType getStoreValues()

getFields

public Collection<FieldLink> getFields()

getNested

public Collection<FieldLink> getNested()

getInBackground

public Boolean getInBackground()

getCache

public Boolean getCache()