Package com.arangodb.entity.arangosearch

Class FieldLink

java.lang.Object
com.arangodb.entity.arangosearch.FieldLink
public final class FieldLink extends Object

  • Method Details

    • on

      public static FieldLink on(String name)
      Creates an instance of FieldLink on the given field name
      Parameters:
      name - Name of a field
      Returns:
      new instance of FieldLink

    • analyzers

      public FieldLink analyzers(String... analyzers)
      Parameters:
      analyzers - The list of analyzers to be used for indexing of string values (default: ["identity"]).
      Returns:
      link

    • includeAllFields

      public FieldLink 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 FieldLink 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 FieldLink 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 FieldLink fields(FieldLink... fields)
      Parameters:
      fields - A list of linked fields
      Returns:
      link

    • nested

      public FieldLink nested(FieldLink... nested)
      Parameters:
      nested - A list of nested fields
      Returns:
      link
      Since:
      ArangoDB 3.10

    • inBackground

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