ddf.catalog.operation.faceting

Class FacetedQueryRequest

java.lang.Object

ddf.catalog.operation.impl.OperationImpl

ddf.catalog.operation.impl.QueryRequestImpl

ddf.catalog.operation.faceting.FacetedQueryRequest

All Implemented Interfaces:

Federatable, Operation, QueryRequest, Request, Serializable

public class FacetedQueryRequest
extends QueryRequestImpl

See Also:

Serialized Form

Field Summary

Fields inherited from class ddf.catalog.operation.impl.QueryRequestImpl

isEnterprise, query

Constructor Summary

Constructors

Constructor and Description
FacetedQueryRequest(Query query, boolean isEnterprise, Collection<String> sourceIds, Map<String,Serializable> properties, FacetProperties facetProperties) Instantiates a FacetedQueryRequest to facet on the provided attributes.
FacetedQueryRequest(Query query, FacetProperties facetProperties) Instantiates a FacetedQueryRequest to facet using the provided FacetProperties.
FacetedQueryRequest(Query query, Set<String> facetAttributes) Instantiates a FacetedQueryRequest to facet on the provided attributes.

Method Summary

Methods inherited from class ddf.catalog.operation.impl.QueryRequestImpl

getQuery, getSourceIds, isEnterprise, toString

Methods inherited from class ddf.catalog.operation.impl.OperationImpl

containsPropertyName, getProperties, getPropertyNames, getPropertyValue, hasProperties, setProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.operation.Request

getStoreIds

Methods inherited from interface ddf.catalog.operation.Operation

containsPropertyName, getProperties, getPropertyNames, getPropertyValue, hasProperties

Constructor Detail

FacetedQueryRequest

public FacetedQueryRequest(Query query,
                           Set<String> facetAttributes)

Instantiates a FacetedQueryRequest to facet on the provided attributes.

Parameters:

query - The query to be sent to the data source

facetAttributes - A list of attributes for which to return text faceting counts

FacetedQueryRequest

public FacetedQueryRequest(Query query,
                           FacetProperties facetProperties)

Instantiates a FacetedQueryRequest to facet using the provided FacetProperties.

Parameters:

query - The query to be sent to the data source.

facetProperties - Properties describing the faceting parameters.

FacetedQueryRequest

public FacetedQueryRequest(Query query,
                           boolean isEnterprise,
                           Collection<String> sourceIds,
                           Map<String,Serializable> properties,
                           FacetProperties facetProperties)

Instantiates a FacetedQueryRequest to facet on the provided attributes.

Parameters:

query - The query to be sent to the data source

isEnterprise - Specifies if this FacetedQueryRequest is an enterprise query

sourceIds - A list of sources to query

properties - Properties supplied to this query for auth, transactions, etc

facetProperties - A structure describing the desired faceting constraints