Package com.arangodb.entity.arangosearch.analyzer

Class AQLAnalyzerProperties

java.lang.Object

com.arangodb.entity.arangosearch.analyzer.AQLAnalyzerProperties

public final class AQLAnalyzerProperties
extends Object

Author:

Michele Rastelli

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AQLAnalyzerProperties.ReturnType

Constructor Summary

Constructors

Constructor	Description
AQLAnalyzerProperties()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Integer	getBatchSize()
Boolean	getCollapsePositions()
Boolean	getKeepNull()
Long	getMemoryLimit()
String	getQueryString()
AQLAnalyzerProperties.ReturnType	getReturnType()
int	hashCode()
void	setBatchSize(Integer batchSize)
void	setCollapsePositions(Boolean collapsePositions)
void	setKeepNull(Boolean keepNull)
void	setMemoryLimit(Long memoryLimit)
void	setQueryString(String queryString)
void	setReturnType(AQLAnalyzerProperties.ReturnType returnType)

Methods inherited from class java.lang.Object

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

Constructor Detail

AQLAnalyzerProperties

public AQLAnalyzerProperties()

Method Detail

getQueryString

public String getQueryString()

Returns:

AQL query to be executed

setQueryString

public void setQueryString(String queryString)

getCollapsePositions

public Boolean getCollapsePositions()

Returns:

• true: set the position to 0 for all members of the query result array
• false (default): set the position corresponding to the index of the result array member

setCollapsePositions

public void setCollapsePositions(Boolean collapsePositions)

getKeepNull

public Boolean getKeepNull()

Returns:

• true (default): treat null like an empty string
• false: discard nulls from View index. Can be used for index filtering (i.e. make your query return null for unwanted data). Note that empty results are always discarded.

setKeepNull

public void setKeepNull(Boolean keepNull)

getBatchSize

public Integer getBatchSize()

Returns:

number between 1 and 1000 (default = 1) that determines the batch size for reading data from the query. In general, a single token is expected to be returned. However, if the query is expected to return many results, then increasing batchSize trades memory for performance.

setBatchSize

public void setBatchSize(Integer batchSize)

getMemoryLimit

public Long getMemoryLimit()

Returns:

memory limit for query execution in bytes. (default is 1048576 = 1Mb) Maximum is 33554432U (32Mb)

setMemoryLimit

public void setMemoryLimit(Long memoryLimit)

getReturnType

public AQLAnalyzerProperties.ReturnType getReturnType()

Returns:

data type of the returned tokens. If the indicated type does not match the actual type then an implicit type conversion is applied.

setReturnType

public void setReturnType(AQLAnalyzerProperties.ReturnType returnType)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object