ddf.catalog.operation.impl

Class QueryRequestImpl

java.lang.Object

ddf.catalog.operation.impl.OperationImpl

ddf.catalog.operation.impl.QueryRequestImpl

All Implemented Interfaces:

Federatable, Operation, QueryRequest, Request, Serializable

Direct Known Subclasses:

FacetedQueryRequest

public class QueryRequestImpl
extends OperationImpl
implements QueryRequest

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isEnterprise
protected Query	query

Constructor Summary

Constructors

Constructor and Description
QueryRequestImpl(Query query) Instantiates a new QueryRequestImpl with a $(@link Query) query,
QueryRequestImpl(Query query, boolean isEnterprise) Instantiates a new QueryRequestImpl with a $(@link Query) and a boolean indicating if it is an Enterprise QueryRequest.
QueryRequestImpl(Query query, boolean isEnterprise, Collection<String> siteNames, Map<String,Serializable> properties) Instantiates a new QueryRequestImpl with a $(@link Query), a boolean indicating if it is an Enterprise QueryRequest, a $Collection of siteNames, and a $Map of properties
QueryRequestImpl(Query query, Collection<String> sourceIds) Instantiates a new QueryRequestImpl with a $(@link Query) and a $Collection of sourceIDs
QueryRequestImpl(Query query, Map<String,Serializable> properties) Instantiates a new QueryRequestImpl with a $(@link Query) and a $Map of properties

Method Summary

Modifier and Type	Method and Description
Query	getQuery() Returns a Query associated with the QueryRequest
Set<String>	getSourceIds() Returns the source ids that are associated with the Federatable implementation.
boolean	isEnterprise() Specifies whether the Federatable implementation should be applied to the enterprise
String	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

Field Detail

query

protected Query query

isEnterprise

protected boolean isEnterprise

Constructor Detail

QueryRequestImpl

public QueryRequestImpl(Query query)

Instantiates a new QueryRequestImpl with a $(@link Query) query,

Parameters:

query - the query

QueryRequestImpl

public QueryRequestImpl(Query query,
                        Map<String,Serializable> properties)

Instantiates a new QueryRequestImpl with a $(@link Query) and a $Map of properties

Parameters:

query - the query

properties - a Map of properties

QueryRequestImpl

public QueryRequestImpl(Query query,
                        Collection<String> sourceIds)

Instantiates a new QueryRequestImpl with a $(@link Query) and a $Collection of sourceIDs

Parameters:

query - the query

sourceIds - a Collection of sourceIDs

QueryRequestImpl

public QueryRequestImpl(Query query,
                        boolean isEnterprise)

Instantiates a new QueryRequestImpl with a $(@link Query) and a boolean indicating if it is an Enterprise QueryRequest.

Parameters:

query - the query

isEnterprise - the enterprise indicator

QueryRequestImpl

public QueryRequestImpl(Query query,
                        boolean isEnterprise,
                        Collection<String> siteNames,
                        Map<String,Serializable> properties)

Instantiates a new QueryRequestImpl with a $(@link Query), a boolean indicating if it is an Enterprise QueryRequest, a $Collection of siteNames, and a $Map of properties

Parameters:

query - the query

isEnterprise - the enterprise indicator

siteNames - a Collection of siteNames

properties - the properties

Method Detail

getQuery

public Query getQuery()

Description copied from interface: QueryRequest

Returns a Query associated with the QueryRequest

Specified by:

getQuery in interface QueryRequest

Returns:

- a Query to be executed

getSourceIds

public Set<String> getSourceIds()

Description copied from interface: Federatable

Returns the source ids that are associated with the Federatable implementation. The source ids will be the complete set of sources that should be acted upon. A set is used to avoid duplicate ids.

Specified by:

getSourceIds in interface Federatable

Returns:

set of source ids that should be acted upon. Can be null or an empty list if Federatable.isEnterprise() method returns true as that means all known sources should be acted upon (and the complete list might not have been known at Object creation).

isEnterprise

public boolean isEnterprise()

Description copied from interface: Federatable

Specifies whether the Federatable implementation should be applied to the enterprise

Specified by:

isEnterprise in interface Federatable

Returns:

true if the Federatable implementation should be applied to the entire enterprise (meaning all sources), otherwise false is returned. If false is returned then a list containing at least 1 source id should be returned by the Federatable.getSourceIds() method.

toString

public String toString()

Overrides:

toString in class Object