fr.gouv.vitam.common.database.translators

Class RequestToAbstract

java.lang.Object

fr.gouv.vitam.common.database.translators.RequestToAbstract

Direct Known Subclasses:

RequestToElasticsearch, RequestToMongodb

public class RequestToAbstract
extends Object

Request To X Abstract class. All translators should be based on this one.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractParser<?>	requestParser

Constructor Summary

Constructors

Constructor and Description
RequestToAbstract(AbstractParser<?> requestParser)

Method Summary

Modifier and Type	Method and Description
int	getFinalLimit() FindIterable.limit(limit)
int	getFinalOffset() FindIterable.skip(offset)
com.fasterxml.jackson.databind.node.ArrayNode	getHints() Used by the Data Engine (cache, nocache, notimeout (noCursorTimeout(noCursorTimeout)))
int	getLastDepth()
int	getNbQueries()
Query	getNthQuery(int nth)
AbstractRequest	getRequest()
AbstractParser<?>	getRequestParser()
String	getUsage()
boolean	hasFullTextQuery()
boolean	hintCache()
boolean	hintNoTimeout()
boolean	isMultiple()
BuilderToken.FILTERARGS	model()

Methods inherited from class java.lang.Object

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

Field Detail

requestParser

protected AbstractParser<?> requestParser

Constructor Detail

RequestToAbstract

public RequestToAbstract(AbstractParser<?> requestParser)

Parameters:

requestParser - AbstractParser in unknown type

Method Detail

getRequestParser

public AbstractParser<?> getRequestParser()

Returns:

the associated RequestParser

hasFullTextQuery

public boolean hasFullTextQuery()

Returns:

true if at least one Query is needing Elasticsearch

hintCache

public boolean hintCache()

Returns:

True if the hint contains cache

hintNoTimeout

public boolean hintNoTimeout()

Returns:

True if the hint contains notimeout

model

public BuilderToken.FILTERARGS model()

Returns:

the model between Units/ObjectGroups/Objects (in that order)

getLastDepth

public int getLastDepth()

Returns:

The possible maximum depth

getRequest

public AbstractRequest getRequest()

Returns:

the Request

getNbQueries

public int getNbQueries()

Returns:

the number of queries

isMultiple

public boolean isMultiple()

Returns:

True if this request is a "multiple" result request

getHints

public com.fasterxml.jackson.databind.node.ArrayNode getHints()

Used by the Data Engine (cache, nocache, notimeout (noCursorTimeout(noCursorTimeout)))

Returns:

the array of hints (if any)

getFinalLimit

public int getFinalLimit()

FindIterable.limit(limit)

Returns:

the limit

getFinalOffset

public int getFinalOffset()

FindIterable.skip(offset)

Returns:

the offset

getUsage

public String getUsage()

Returns:

the associated usage if any

getNthQuery

public final Query getNthQuery(int nth)

Parameters:

nth - int

Returns:

the nth Query