fr.gouv.vitam.common.database.parser.request

Class AbstractParser<E extends AbstractRequest>

java.lang.Object

fr.gouv.vitam.common.database.parser.request.AbstractParser<E>

Type Parameters:

E - is one of RequestMultiple or RequestSingle

Direct Known Subclasses:

RequestParserMultiple, RequestParserSingle

public abstract class AbstractParser<E extends AbstractRequest>
extends Object

Abstract class implementing Parser for a Request Common abstract for both Multiple and Single Request

Field Summary

Fields

Modifier and Type	Field and Description
protected VarNameAdapter	adapter
protected boolean	hasFullTextCurrentQuery Current analyzed query to be computed by a full text index
protected boolean	hasFullTextQuery Contains queries to be computed by a full text index
protected E	request
protected com.fasterxml.jackson.databind.JsonNode	rootNode
protected String	sourceRequest

Constructor Summary

Constructors

Constructor and Description
AbstractParser()

Method Summary

Modifier and Type	Method and Description
protected Query[]	analyzeArrayCommand(BuilderToken.QUERY query, com.fasterxml.jackson.databind.JsonNode commands)
protected Query	analyzeOneCommand(String refCommand, com.fasterxml.jackson.databind.JsonNode command)
abstract int	getLastDepth()
protected abstract E	getNewRequest()
E	getRequest()
static BuilderToken.QUERY	getRequestId(String queryroot) Compute the QUERY from command
com.fasterxml.jackson.databind.JsonNode	getRootNode()
String	getSource()
boolean	hasFullTextQuery()
abstract boolean	hintCache()
abstract boolean	hintNoTimeout()
protected static boolean	isCommandAsFullText(BuilderToken.QUERY query) Check if the command is allowed using the "standard" database
abstract BuilderToken.FILTERARGS	model()
abstract void	parse(com.fasterxml.jackson.databind.JsonNode jsonRequest)
protected void	parseJson(com.fasterxml.jackson.databind.JsonNode jsonRequest)

Methods inherited from class java.lang.Object

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

Field Detail

adapter

protected VarNameAdapter adapter

sourceRequest

protected String sourceRequest

request

protected E extends AbstractRequest request

hasFullTextQuery

protected boolean hasFullTextQuery

Contains queries to be computed by a full text index

hasFullTextCurrentQuery

protected boolean hasFullTextCurrentQuery

Current analyzed query to be computed by a full text index

rootNode

protected com.fasterxml.jackson.databind.JsonNode rootNode

Constructor Detail

AbstractParser

public AbstractParser()

Method Detail

getSource

public String getSource()

Returns:

the source

getRootNode

public com.fasterxml.jackson.databind.JsonNode getRootNode()

Returns:

the rootNode

getRequest

public E getRequest()

Returns:

the Request

getNewRequest

protected abstract E getNewRequest()

Returns:

a new Request

parse

public abstract void parse(com.fasterxml.jackson.databind.JsonNode jsonRequest)
                    throws InvalidParseOperationException

Parameters:

jsonRequest - containing a parsed JSON as [ {root}, {query}, {filter} ] or { $roots: root, $query : query, $filter : filter }

Throws:

InvalidParseOperationException - if jsonRequest could not parse to JSON

parseJson

protected void parseJson(com.fasterxml.jackson.databind.JsonNode jsonRequest)
                  throws InvalidParseOperationException

Parameters:

jsonRequest - containing a parsed JSON as [ {root}, {query}, {filter} ] or { $roots: root, $query : query, $filter : filter }

Throws:

InvalidParseOperationException - if jsonRequest could not parse to JSON

hasFullTextQuery

public final boolean hasFullTextQuery()

Returns:

the hasFullTextQuery

analyzeArrayCommand

protected Query[] analyzeArrayCommand(BuilderToken.QUERY query,
                                      com.fasterxml.jackson.databind.JsonNode commands)
                               throws InvalidParseOperationException,
                                      InvalidCreateOperationException

Throws:

InvalidParseOperationException

InvalidCreateOperationException

isCommandAsFullText

protected static boolean isCommandAsFullText(BuilderToken.QUERY query)

Check if the command is allowed using the "standard" database

Parameters:

query - QUERY

Returns:

true if only valid in "index" database support

getRequestId

public static final BuilderToken.QUERY getRequestId(String queryroot)
                                             throws InvalidParseOperationException

Compute the QUERY from command

Parameters:

queryroot - String

Returns:

the QUERY

Throws:

InvalidParseOperationException - if queryroot could not parse to JSON

analyzeOneCommand

protected Query analyzeOneCommand(String refCommand,
                                  com.fasterxml.jackson.databind.JsonNode command)
                           throws InvalidParseOperationException,
                                  InvalidCreateOperationException

Throws:

InvalidParseOperationException

InvalidCreateOperationException

getLastDepth

public abstract int getLastDepth()

Returns:

int the depth of the query

model

public abstract BuilderToken.FILTERARGS model()

Returns:

FILTERARGS the filter argument

hintNoTimeout

public abstract boolean hintNoTimeout()

Returns:

true if not time out

hintCache

public abstract boolean hintCache()

Returns:

true if not cache hint