ddf.catalog.operation.impl

Class QueryImpl

java.lang.Object

ddf.catalog.operation.impl.QueryImpl

All Implemented Interfaces:

Query, org.opengis.filter.Filter

public class QueryImpl
extends Object
implements Query

Field Summary

Fields

Modifier and Type	Field and Description
protected org.opengis.filter.Filter	filter
protected int	pageSize
protected Map<String,Object>	properties
protected boolean	requestsTotalResultsCount
protected org.opengis.filter.sort.SortBy	sortBy
protected int	startIndex
protected long	timeoutMillis

Fields inherited from interface ddf.catalog.operation.Query

DEFAULT_MAXIMUM_RETURNED_RESULTS

Fields inherited from interface org.opengis.filter.Filter

EXCLUDE, INCLUDE

Constructor Summary

Constructors

Constructor and Description
QueryImpl(org.opengis.filter.Filter filter) Instantiates a new QueryImpl with a Filter Throws IllegalArgumentException if a null object is passed in.
QueryImpl(org.opengis.filter.Filter rootFilter, int startIndex, int pageSize, org.opengis.filter.sort.SortBy sortPolicy, boolean requestsTotalResultsCount, long timeoutMillis) Instantiates a new QueryImpl with a Filter, startIndex, pageSize, sortPolicy, requestsTotalResultsCount, and timeoutMillis

Method Summary

Modifier and Type	Method and Description
Object	accept(org.opengis.filter.FilterVisitor visitor, Object obj)
boolean	evaluate(Object obj)
org.opengis.filter.Filter	getFilter()
int	getPageSize() The page size represents the maximum amount of results the query will return.
org.opengis.filter.sort.SortBy	getSortBy() The sortBy determines how the results will be sorted.
int	getStartIndex() Get the offset where the query results will begin.
long	getTimeoutMillis() The timeout is specified in milliseconds.
boolean	requestsTotalResultsCount() Determines whether the total number of results should be returned
void	setFilter(org.opengis.filter.Filter rootFilter) Throws IllegalArgumentException if a null object is passed in.
void	setPageSize(int pageSize)
void	setProperties(Map<String,Object> properties)
void	setRequestsTotalResultsCount(boolean requestsTotalResultsCount)
void	setSortBy(org.opengis.filter.sort.SortBy sortBy)
void	setStartIndex(int startIndex)
void	setTimeoutMillis(long timeoutMillis)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

filter

protected org.opengis.filter.Filter filter

startIndex

protected int startIndex

pageSize

protected int pageSize

requestsTotalResultsCount

protected boolean requestsTotalResultsCount

timeoutMillis

protected long timeoutMillis

sortBy

protected org.opengis.filter.sort.SortBy sortBy

properties

protected Map<String,Object> properties

Constructor Detail

QueryImpl

public QueryImpl(org.opengis.filter.Filter filter)

Instantiates a new QueryImpl with a Filter Throws IllegalArgumentException if a null object is passed in.

Parameters:

filter - the filter

QueryImpl

public QueryImpl(org.opengis.filter.Filter rootFilter,
                 int startIndex,
                 int pageSize,
                 org.opengis.filter.sort.SortBy sortPolicy,
                 boolean requestsTotalResultsCount,
                 long timeoutMillis)

Instantiates a new QueryImpl with a Filter, startIndex, pageSize, sortPolicy, requestsTotalResultsCount, and timeoutMillis

Parameters:

rootFilter - the filter

startIndex - the starting index

pageSize - the page size

sortPolicy - the sort policy

requestsTotalResultsCount - if the Total Results Count is requested or not

timeoutMillis - the timeout in milliseconds

Method Detail

accept

public Object accept(org.opengis.filter.FilterVisitor visitor,
                     Object obj)

Specified by:

accept in interface org.opengis.filter.Filter

evaluate

public boolean evaluate(Object obj)

Specified by:

evaluate in interface org.opengis.filter.Filter

getFilter

public org.opengis.filter.Filter getFilter()

Returns:

filter

setFilter

public void setFilter(org.opengis.filter.Filter rootFilter)

Throws IllegalArgumentException if a null object is passed in.

Parameters:

rootFilter -

getPageSize

public int getPageSize()

Description copied from interface: Query

The page size represents the maximum amount of results the query will return. Page sizes of less than 1 (0 or a negative number) should return the maximum number of results supported by the catalog or the maximum supported by each Source, whichever is smaller.

Specified by:

getPageSize in interface Query

Returns:

the page size - the maximum result size

setPageSize

public void setPageSize(int pageSize)

Parameters:

pageSize -

getSortBy

public org.opengis.filter.sort.SortBy getSortBy()

Description copied from interface: Query

The sortBy determines how the results will be sorted.

Specified by:

getSortBy in interface Query

Returns:

SortBy. Null if no sortBy is specified.

See Also:

SortBy

setSortBy

public void setSortBy(org.opengis.filter.sort.SortBy sortBy)

Parameters:

sortBy -

getStartIndex

public int getStartIndex()

Description copied from interface: Query

Get the offset where the query results will begin.

Start index is required to be 1-based. For example if the query specifies a start index of 5 then the query results will start with the 5th result discovered by the query.

If a value less than 1 is returned, Source implementations will throw UnsupportedQueryException.

Specified by:

getStartIndex in interface Query

Returns:

int - the start index for the query results

setStartIndex

public void setStartIndex(int startIndex)

Parameters:

startIndex -

getTimeoutMillis

public long getTimeoutMillis()

Description copied from interface: Query

The timeout is specified in milliseconds. This will cause the query to timeout and return results by the specified timeout, if the query has not done so already.
Return 0 if no timeout should occur.

Specified by:

getTimeoutMillis in interface Query

Returns:

max time to wait for query results in milliseconds, 0 if no timeout should occur.

setTimeoutMillis

public void setTimeoutMillis(long timeoutMillis)

Parameters:

timeoutMillis -

requestsTotalResultsCount

public boolean requestsTotalResultsCount()

Description copied from interface: Query

Determines whether the total number of results should be returned

Specified by:

requestsTotalResultsCount in interface Query

Returns:

true, if the count should be returned

setProperties

public void setProperties(Map<String,Object> properties)

Parameters:

properties -

setRequestsTotalResultsCount

public void setRequestsTotalResultsCount(boolean requestsTotalResultsCount)

Parameters:

requestsTotalResultsCount -

toString

public String toString()

Overrides:

toString in class Object