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	fields(FieldLink... fields)
Collection<String>	getAnalyzers()
Collection<FieldLink>	getFields()
Boolean	getIncludeAllFields()
String	getName()
StoreValuesType	getStoreValues()
Boolean	getTrackListPositions()
CollectionLink	includeAllFields(Boolean includeAllFields)
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

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()