org.codice.ddf.opensearch.query

Class OpenSearchQuery

java.lang.Object

org.codice.ddf.opensearch.query.OpenSearchQuery

All Implemented Interfaces:

Query, org.opengis.filter.Filter

public class OpenSearchQuery
extends Object
implements Query

Field Summary

Fields

Modifier and Type	Field and Description
static String	CARET
static org.opengis.filter.FilterFactory	FILTER_FACTORY

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
OpenSearchQuery(Integer startIndex, Integer count, String sortField, String sortOrderIn, long maxTimeout, FilterBuilder filterBuilder) Creates an Implementation of a DDF Query interface.

Method Summary

Modifier and Type	Method and Description
Object	accept(org.opengis.filter.FilterVisitor visitor, Object obj)
void	addBBoxSpatialFilter(String bbox)
void	addContextualFilter(String searchTerm, String selectors)
void	addGeometrySpatialFilter(String geometryWkt)
void	addPolygonSpatialFilter(String polygon)
void	addSpatialDistanceFilter(String lon, String lat, String radius)
void	addTemporalFilter(String dateStart, String dateEnd, String dateOffset)
void	addTemporalFilter(TemporalFilter temporalFilter)
void	addTypeFilter(String type, String versions)
boolean	evaluate(Object object)
org.opengis.filter.Filter	getFilter()
int	getPageSize() The page size represents the maximum amount of results the query will return.
Set<String>	getSiteIds()
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.
FederationStrategy	getStrategy()
long	getTimeoutMillis() The timeout is specified in milliseconds.
boolean	isEnterprise()
boolean	requestsTotalResultsCount() Determines whether the total number of results should be returned
void	setIsEnterprise(boolean isEnterprise)
void	setSiteIds(Set<String> siteIds)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CARET

public static final String CARET

See Also:

Constant Field Values

FILTER_FACTORY

public static final org.opengis.filter.FilterFactory FILTER_FACTORY

Constructor Detail

OpenSearchQuery

public OpenSearchQuery(Integer startIndex,
                       Integer count,
                       String sortField,
                       String sortOrderIn,
                       long maxTimeout,
                       FilterBuilder filterBuilder)

Creates an Implementation of a DDF Query interface. This object is passed from the endpoint to DDF and will be used by sites to perform queries on their respective systems.

Parameters:

startIndex - Offset of the returned results.

count - Number of results to return.

sortField - Area that the results should be sorted by. Possible values: 'date' and 'relevance'

sortOrderIn - Order of the results. Possible values: 'asc', 'desc'

maxTimeout - Maximum amount of time for a query to respond.

filterBuilder - FilterBuilder object to use for filter creation.

Method Detail

addContextualFilter

public void addContextualFilter(String searchTerm,
                                String selectors)
                         throws org.parboiled.errors.ParsingException

Throws:

org.parboiled.errors.ParsingException

addTemporalFilter

public void addTemporalFilter(String dateStart,
                              String dateEnd,
                              String dateOffset)

addTemporalFilter

public void addTemporalFilter(TemporalFilter temporalFilter)

addGeometrySpatialFilter

public void addGeometrySpatialFilter(String geometryWkt)

addBBoxSpatialFilter

public void addBBoxSpatialFilter(String bbox)

addPolygonSpatialFilter

public void addPolygonSpatialFilter(String polygon)

addSpatialDistanceFilter

public void addSpatialDistanceFilter(String lon,
                                     String lat,
                                     String radius)

addTypeFilter

public void addTypeFilter(String type,
                          String versions)

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 object)

Specified by:

evaluate in interface org.opengis.filter.Filter

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

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

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

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.

getSiteIds

public Set<String> getSiteIds()

setSiteIds

public void setSiteIds(Set<String> siteIds)

isEnterprise

public boolean isEnterprise()

setIsEnterprise

public void setIsEnterprise(boolean isEnterprise)

getStrategy

public FederationStrategy getStrategy()

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

getFilter

public org.opengis.filter.Filter getFilter()

toString

public String toString()

Overrides:

toString in class Object