Class NarrowExecutor.QueryInfo
- java.lang.Object
-
- com.broadleafcommerce.data.tracking.core.filtering.NarrowExecutor.QueryInfo
-
- Enclosing interface:
- NarrowExecutor
public static class NarrowExecutor.QueryInfo extends Object
-
-
Constructor Summary
Constructors Constructor Description QueryInfo(QueryContainer queryContainer, boolean isLimiting, boolean isCountQuery, boolean isExistsQuery, boolean isDeleteQuery, boolean isCollectionQuery, boolean isPageQuery, boolean isStreamQuery, ContextInfo contextInfo, Class<?> typeToRead, boolean isExplicitType)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
Map<String,Object>
getAdditionalParams()
Arbitrary additional parametersContextInfo
getContextInfo()
The request context information (sandbox, application, catalog)int
getLinkedHitLimit()
When leveragingLink
annotated field fetch, a initial query is performed to fetch all matching entities for the linked domain.org.springframework.data.domain.Pageable
getPageable()
ThePageable
for the query, if applicableQueryContainer
getQueryContainer()
Generic container for the repository plaform specific queryClass<?>
getTypeToRead()
The domain class type returned from the queryint
hashCode()
boolean
isCollectionQuery()
Whether or not the query is a collection query (i.e.boolean
isCountQuery()
Whether or not the query is a count queryboolean
isDeleteQuery()
Whether or not the query is a delete queryboolean
isExistsQuery()
Whether or not the query is an exists queryboolean
isExplicitType()
Whether or nottypeToRead
should be used to limit the results to that type only.boolean
isLimiting()
Whether or not the query results are limited via a limiting clauseboolean
isPageQuery()
Whether or not the query is a page query (i.e.boolean
isStreamQuery()
Whether or not the query is a stream query (i.e.void
setAdditionalParams(Map<String,Object> additionalParams)
Arbitrary additional parametersvoid
setLinkedHitLimit(int linkedHitLimit)
When leveragingLink
annotated field fetch, a initial query is performed to fetch all matching entities for the linked domain.void
setPageable(org.springframework.data.domain.Pageable pageable)
ThePageable
for the query, if applicableString
toString()
NarrowExecutor.QueryInfo
withPageable(org.springframework.data.domain.Pageable pageable)
-
-
-
Constructor Detail
-
QueryInfo
public QueryInfo(QueryContainer queryContainer, boolean isLimiting, boolean isCountQuery, boolean isExistsQuery, boolean isDeleteQuery, boolean isCollectionQuery, boolean isPageQuery, boolean isStreamQuery, ContextInfo contextInfo, Class<?> typeToRead, boolean isExplicitType)
-
-
Method Detail
-
withPageable
public NarrowExecutor.QueryInfo withPageable(org.springframework.data.domain.Pageable pageable)
-
getPageable
public org.springframework.data.domain.Pageable getPageable()
ThePageable
for the query, if applicable- Returns:
- The pageable for the query
-
getQueryContainer
public QueryContainer getQueryContainer()
Generic container for the repository plaform specific query- Returns:
- Generic container for the query
-
isLimiting
public boolean isLimiting()
Whether or not the query results are limited via a limiting clause- Returns:
- Whether or not the query result count is limited
-
isCountQuery
public boolean isCountQuery()
Whether or not the query is a count query- Returns:
- Whether or not the query is a count query
-
isExistsQuery
public boolean isExistsQuery()
Whether or not the query is an exists query- Returns:
- Whether or not the query is an exists query
-
isDeleteQuery
public boolean isDeleteQuery()
Whether or not the query is a delete query- Returns:
- Whether or not the query is a delete query
-
isCollectionQuery
public boolean isCollectionQuery()
Whether or not the query is a collection query (i.e. return a collection of results)- Returns:
- Whether or not the query is a collection query
-
isPageQuery
public boolean isPageQuery()
Whether or not the query is a page query (i.e. return a Page of results)- Returns:
- Whether or not the query is a page query
-
isStreamQuery
public boolean isStreamQuery()
Whether or not the query is a stream query (i.e. return a Stream of results)- Returns:
- Whether or not the query is a stream query
-
getContextInfo
public ContextInfo getContextInfo()
The request context information (sandbox, application, catalog)- Returns:
- The request context information
-
getTypeToRead
public Class<?> getTypeToRead()
The domain class type returned from the query- Returns:
- The domain class type returned from the query
-
isExplicitType
public boolean isExplicitType()
Whether or nottypeToRead
should be used to limit the results to that type only.- Returns:
- Whether or not
typeToRead
should be used to limit the results to that type only
-
getAdditionalParams
public Map<String,Object> getAdditionalParams()
Arbitrary additional parameters- Returns:
- Arbitrary additional parameters
-
getLinkedHitLimit
public int getLinkedHitLimit()
When leveragingLink
annotated field fetch, a initial query is performed to fetch all matching entities for the linked domain. Then, the contextIds for those matches are used for a matching IN clause against the soft reference field of the containing entity. It is advisable to set some reasonable limit on the number of matches allowed in the initial search, which is the purpose of this field. The default value is 900. To allow an unbounded quantity of hits, set this field to -1.
-
setPageable
public void setPageable(org.springframework.data.domain.Pageable pageable)
ThePageable
for the query, if applicable- Parameters:
pageable
- The Pageable for the query
-
setAdditionalParams
public void setAdditionalParams(Map<String,Object> additionalParams)
Arbitrary additional parameters- Parameters:
Arbitrary
- additional parameters
-
setLinkedHitLimit
public void setLinkedHitLimit(int linkedHitLimit)
When leveragingLink
annotated field fetch, a initial query is performed to fetch all matching entities for the linked domain. Then, the contextIds for those matches are used for a matching IN clause against the soft reference field of the containing entity. It is advisable to set some reasonable limit on the number of matches allowed in the initial search, which is the purpose of this field. The default value is 900. To allow an unbounded quantity of hits, set this field to -1.
-
canEqual
protected boolean canEqual(Object other)
-
-