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

Class RequestParserMultiple

java.lang.Object

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

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

Direct Known Subclasses:

DeleteParserMultiple, InsertParserMultiple, SelectParserMultiple, UpdateParserMultiple

public abstract class RequestParserMultiple
extends AbstractParser<RequestMultiple>

Partial Request Parser (common base): [ {root}, {query}, {filter} ] or { $roots: root, $query : query, $filter : filter }

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	FILTER_POS
protected int	lastDepth Last computed Depth
protected static int	QUERY_POS
protected static int	ROOT_POS Component's position [ {root}, {query}, {filter} ] [ 0 , 1 , 2 ]

Fields inherited from class fr.gouv.vitam.common.database.parser.request.AbstractParser

adapter, hasFullTextCurrentQuery, hasFullTextQuery, request, rootNode, sourceRequest

Constructor Summary

Constructors

Constructor and Description
RequestParserMultiple() Constructor for Internal API
RequestParserMultiple(VarNameAdapter adapter) Constructor for Metadata

Method Summary

Modifier and Type	Method and Description
void	addCondition(Query condition) Allow to add one condition to the current parsed Request on top Query Example:
protected void	analyzeRootQuery(com.fasterxml.jackson.databind.JsonNode command) { expression, $exactdepth : exactdepth, $depth : /- depth }, $exactdepth and $depth being optional (mutual exclusive)
protected void	filterParse(com.fasterxml.jackson.databind.JsonNode rootNode) Filter part
String	getFinalScrollId() get ScrollId
int	getFinalScrollTimeout() get ScrollTimeout
int	getLastDepth()
RequestMultiple	getRequest()
boolean	hintCache()
boolean	hintNoTimeout()
BuilderToken.FILTERARGS	model()
protected void	parseJson(com.fasterxml.jackson.databind.JsonNode jsonRequest)
protected void	parseQueryOnly(String query)
protected void	queryParse(com.fasterxml.jackson.databind.JsonNode rootNode) [ query, query ] or { query } if one level only
protected void	rootParse(com.fasterxml.jackson.databind.JsonNode rootNode) Will be used as extra arguments in the first query
String	toString()

Methods inherited from class fr.gouv.vitam.common.database.parser.request.AbstractParser

analyzeArrayCommand, analyzeOneCommand, getNewRequest, getRequestId, getRootNode, getSource, hasFullTextQuery, isCommandAsFullText, parse

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_POS

protected static final int ROOT_POS

Component's position [ {root}, {query}, {filter} ] [ 0 , 1 , 2 ]

See Also:

Constant Field Values

QUERY_POS

protected static final int QUERY_POS

See Also:

Constant Field Values

FILTER_POS

protected static final int FILTER_POS

See Also:

Constant Field Values

lastDepth

protected int lastDepth

Last computed Depth

Constructor Detail

RequestParserMultiple

public RequestParserMultiple()

Constructor for Internal API

RequestParserMultiple

public RequestParserMultiple(VarNameAdapter adapter)

Constructor for Metadata

Parameters:

adapter - VarNameAdapter

Method Detail

parseJson

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

Overrides:

parseJson in class AbstractParser<RequestMultiple>

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

parseQueryOnly

protected void parseQueryOnly(String query)
                       throws InvalidParseOperationException

Parameters:

query - containing only the JSON query part (no filter neither roots)

Throws:

InvalidParseOperationException - if query could not parse to JSON

rootParse

protected void rootParse(com.fasterxml.jackson.databind.JsonNode rootNode)
                  throws InvalidParseOperationException

Will be used as extra arguments in the first query

Parameters:

rootNode - JsonNode the root of the request

Throws:

InvalidParseOperationException - if rootNode could not parse to JSON

filterParse

protected void filterParse(com.fasterxml.jackson.databind.JsonNode rootNode)
                    throws InvalidParseOperationException

Filter part

Parameters:

rootNode - JsonNode The filter of the request

Throws:

InvalidParseOperationException - if rootNode could not parse to JSON

queryParse

protected void queryParse(com.fasterxml.jackson.databind.JsonNode rootNode)
                   throws InvalidParseOperationException

[ query, query ] or { query } if one level only

Parameters:

rootNode - JsonNode the query of the request

Throws:

InvalidParseOperationException - if rootNode could not parse to JSON

analyzeRootQuery

protected void analyzeRootQuery(com.fasterxml.jackson.databind.JsonNode command)
                         throws InvalidParseOperationException,
                                InvalidCreateOperationException

{ expression, $exactdepth : exactdepth, $depth : /- depth }, $exactdepth and $depth being optional (mutual exclusive)

Parameters:

command - JsonNode

Throws:

InvalidParseOperationException - if query could not parse to JSON

InvalidCreateOperationException - if could not create query in JSON

toString

public String toString()

Overrides:

toString in class Object

getRequest

public RequestMultiple getRequest()

Overrides:

getRequest in class AbstractParser<RequestMultiple>

Returns:

the Request

addCondition

public void addCondition(Query condition)
                  throws InvalidCreateOperationException,
                         InvalidParseOperationException

Allow to add one condition to the current parsed Request on top Query

Example:

 
   XxxxxxxParserMultiple parser = new XxxxxxParserMultiple(...);
   parser.parse(jsonQuery);
   parser.addCondition(eq(FieldName, value));
   JsonNode newJsonQuery = parser.getRootNode();
 
 

Parameters:

condition - the condition to add

Throws:

InvalidCreateOperationException - when invalid create query exception occurred

InvalidParseOperationException - when invalid parse data to create query

getLastDepth

public final int getLastDepth()

Specified by:

getLastDepth in class AbstractParser<RequestMultiple>

Returns:

the lastDepth

hintCache

public boolean hintCache()

Specified by:

hintCache in class AbstractParser<RequestMultiple>

Returns:

True if the hint contains cache

hintNoTimeout

public boolean hintNoTimeout()

Specified by:

hintNoTimeout in class AbstractParser<RequestMultiple>

Returns:

True if the hint contains notimeout

model

public BuilderToken.FILTERARGS model()

Specified by:

model in class AbstractParser<RequestMultiple>

Returns:

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

getFinalScrollId

public String getFinalScrollId()

get ScrollId

Returns:

the limit

getFinalScrollTimeout

public int getFinalScrollTimeout()

get ScrollTimeout

Returns:

ScrollTimeout