Class SelectMultiQuery
java.lang.Object
fr.gouv.vitam.common.database.builder.request.AbstractRequest
fr.gouv.vitam.common.database.builder.request.multiple.RequestMultiple
fr.gouv.vitam.common.database.builder.request.multiple.SelectMultiQuery
Select: { $roots: roots, $query : query, $filter : filter, $projection : projection, $facets : facet }
-
Field Summary
FieldsFields inherited from class fr.gouv.vitam.common.database.builder.request.multiple.RequestMultiple
queries, rootsFields inherited from class fr.gouv.vitam.common.database.builder.request.AbstractRequest
filter, projection -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal SelectMultiQueryprotected voidaddFacetsToNode(com.fasterxml.jackson.databind.node.ObjectNode node) Add facets to given nodefinal SelectMultiQueryaddOrderByAscFilter(String... variableNames) final SelectMultiQueryaddOrderByDescFilter(String... variableNames) final SelectMultiQueryaddOrderByFilter(com.fasterxml.jackson.databind.JsonNode filterContent) final SelectMultiQueryaddProjection(com.fasterxml.jackson.databind.JsonNode projectionContent) final SelectMultiQueryaddUnusedProjection(String... variableNames) final SelectMultiQueryaddUsedProjection(String... variableNames) final booleandefault implements of getAllProjectiongetFacetsfinal com.fasterxml.jackson.databind.node.ObjectNodefinal com.fasterxml.jackson.databind.node.ObjectNodefinal com.fasterxml.jackson.databind.node.ObjectNodedefault implements of getProjectionGetter for thresholdfinal SelectMultiQueryparseLimitFilter(String filter) final SelectMultiQueryparseOrderByFilter(String filter) final SelectMultiQueryparseProjection(String projection) final SelectMultiQueryreset()final SelectMultiQueryfinal SelectMultiQueryfinal SelectMultiQueryfinal SelectMultiQueryfinal SelectMultiQueryprotected final SelectMultiQueryselectSetProjection(com.fasterxml.jackson.databind.JsonNode projectionContent) final SelectMultiQuerysetFilter(com.fasterxml.jackson.databind.JsonNode filterContent) final SelectMultiQuerysetLimitFilter(long offset, long limit) final SelectMultiQuerysetLimitFilter(com.fasterxml.jackson.databind.JsonNode filterContent) final SelectMultiQuerysetProjection(com.fasterxml.jackson.databind.JsonNode projectionContent) final SelectMultiQuerysetScrollFilter(String scrollId, int scrollTimeout, int limit) voidsetThreshold(Long threshold) Setter for thresholdfinal SelectMultiQuerysetUsageProjection(com.fasterxml.jackson.databind.JsonNode projectionContent) final SelectMultiQuerysetUsageProjection(String usage) toString()final SelectMultiQuerytrackTotalHits(boolean trackTotalHits) Methods inherited from class fr.gouv.vitam.common.database.builder.request.multiple.RequestMultiple
addQueries, addRoots, addRoots, getActions, getData, getFinal, getNbQueries, getNthQuery, getQueries, getRoots, parseRoots, resetQueries, resetRoots, setFacets, setQueryMethods inherited from class fr.gouv.vitam.common.database.builder.request.AbstractRequest
addHintFilter, addHintFilter, getFilter, parseFilter, resetFilter, resetHintFilter, selectAddOrderByAscFilter, selectAddOrderByDescFilter, selectAddOrderByFilter, selectAddProjection, selectAddUnusedProjection, selectAddUsedProjection, selectGetAllProjection, selectGetFinalSelect, selectGetProjection, selectParseLimitFilter, selectParseOrderByFilter, selectParseProjection, selectReset, selectResetLimitFilter, selectResetOrderByFilter, selectResetUsedProjection, selectSetFilter, selectSetLimitFilter, selectSetLimitFilter, selectSetScrollFilter
-
Field Details
-
facets
Facets -
threshold
-
-
Constructor Details
-
SelectMultiQuery
public SelectMultiQuery()
-
-
Method Details
-
resetFacets
- Returns:
- this Request
-
resetLimitFilter
- Returns:
- this Query
-
resetOrderByFilter
- Returns:
- this Query
-
resetUsedProjection
- Returns:
- this Query
-
resetUsageProjection
- Returns:
- this Query
-
reset
- Overrides:
resetin classRequestMultiple- Returns:
- this Query
-
setLimitFilter
- Parameters:
offset- ignored if 0limit- ignored if 0- Returns:
- this Query
-
setLimitFilter
- Parameters:
filterContent- content json- Returns:
- this Query
-
trackTotalHits
- Parameters:
trackTotalHits- to set. false (default) to return approximative total hits, true to return exact total hits- Returns:
- this Query
-
parseLimitFilter
- Parameters:
filter- string filter- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
addOrderByAscFilter
public final SelectMultiQuery addOrderByAscFilter(String... variableNames) throws InvalidParseOperationException - Parameters:
variableNames- list of key name- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
addOrderByDescFilter
public final SelectMultiQuery addOrderByDescFilter(String... variableNames) throws InvalidParseOperationException - Parameters:
variableNames- list of key name- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
addOrderByFilter
public final SelectMultiQuery addOrderByFilter(com.fasterxml.jackson.databind.JsonNode filterContent) throws InvalidParseOperationException - Parameters:
filterContent- json filter- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
parseOrderByFilter
public final SelectMultiQuery parseOrderByFilter(String filter) throws InvalidParseOperationException - Parameters:
filter- string filter- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
setFilter
public final SelectMultiQuery setFilter(com.fasterxml.jackson.databind.JsonNode filterContent) throws InvalidParseOperationException - Overrides:
setFilterin classAbstractRequest- Parameters:
filterContent- json filter- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
addUsedProjection
public final SelectMultiQuery addUsedProjection(String... variableNames) throws InvalidParseOperationException - Parameters:
variableNames- list of key name- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
addUnusedProjection
public final SelectMultiQuery addUnusedProjection(String... variableNames) throws InvalidParseOperationException - Parameters:
variableNames- list of key name- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
addProjection
public final SelectMultiQuery addProjection(com.fasterxml.jackson.databind.JsonNode projectionContent) - Parameters:
projectionContent- json projection- Returns:
- this Query
-
parseProjection
public final SelectMultiQuery parseProjection(String projection) throws InvalidParseOperationException - Parameters:
projection- string projection- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
setUsageProjection
public final SelectMultiQuery setUsageProjection(String usage) throws InvalidParseOperationException - Parameters:
usage- string- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
setUsageProjection
public final SelectMultiQuery setUsageProjection(com.fasterxml.jackson.databind.JsonNode projectionContent) throws InvalidParseOperationException - Parameters:
projectionContent- json projection- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
selectSetProjection
protected final SelectMultiQuery selectSetProjection(com.fasterxml.jackson.databind.JsonNode projectionContent) throws InvalidParseOperationException - Overrides:
selectSetProjectionin classAbstractRequest- Parameters:
projectionContent- json projection- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
setProjection
public final SelectMultiQuery setProjection(com.fasterxml.jackson.databind.JsonNode projectionContent) throws InvalidParseOperationException - Parameters:
projectionContent- json projection- Returns:
- this Query
- Throws:
InvalidParseOperationException- when query is invalid
-
getFinalSelect
public final com.fasterxml.jackson.databind.node.ObjectNode getFinalSelect()- Returns:
- the Final Select containing all 5 parts: roots array, queries array, facets array, filter and projection
-
getFinalSelectById
public final com.fasterxml.jackson.databind.node.ObjectNode getFinalSelectById()- Returns:
- the Final Select By Id containing only one part: projection
-
addFacetsToNode
protected void addFacetsToNode(com.fasterxml.jackson.databind.node.ObjectNode node) Add facets to given node- Parameters:
node- with facets
-
getAllProjection
public final boolean getAllProjection()Description copied from class:RequestMultipledefault implements of getAllProjection- Overrides:
getAllProjectionin classRequestMultiple- Returns:
- True if the projection is not restricted
-
getProjection
public final com.fasterxml.jackson.databind.node.ObjectNode getProjection()Description copied from class:RequestMultipledefault implements of getProjection- Overrides:
getProjectionin classRequestMultiple- Returns:
- the projection
-
getFacets
Description copied from class:RequestMultiplegetFacets- Overrides:
getFacetsin classRequestMultiple- Returns:
- the facets
-
addFacets
- Parameters:
facets- list of facet- Returns:
- this Request
- Throws:
IllegalArgumentException- when facet is invalid
-
setFacet
- Parameters:
facet- facet- Returns:
- this Request
- Throws:
IllegalArgumentException- when facet is invalid
-
setScrollFilter
- Parameters:
scrollId- ignored if empty or nullscrollTimeout- ignored if 0limit- ignored if 0- Returns:
- this Query
-
getThreshold
Getter for threshold- Overrides:
getThresholdin classRequestMultiple- Returns:
- the threshold
-
setThreshold
Setter for threshold- Overrides:
setThresholdin classRequestMultiple- Parameters:
threshold- the value to set for the threshold
-
toString
- Overrides:
toStringin classRequestMultiple
-