Package org.codice.ddf.opensearch.endpoint.query

Class OpenSearchQuery

java.lang.Object
org.codice.ddf.opensearch.endpoint.query.OpenSearchQuery
All Implemented Interfaces:
ddf.catalog.operation.Query, org.geotools.api.filter.Filter
public class OpenSearchQuery extends Object implements ddf.catalog.operation.Query

  • Field Details

  • Constructor Details

    • OpenSearchQuery

      public OpenSearchQuery(Integer startIndex, Integer count, String sortField, String sortOrderIn, long maxTimeout, ddf.catalog.filter.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 Details

    • addContextualFilter

      public void addContextualFilter(String searchTerms, String selectors) throws org.parboiled.errors.ParsingException
      Throws:
      org.parboiled.errors.ParsingException

    • addStartEndTemporalFilter

      public void addStartEndTemporalFilter(String dateStart, String dateEnd)

    • addOffsetTemporalFilter

      public void addOffsetTemporalFilter(String dateOffset)

    • addGeometrySpatialFilter

      public void addGeometrySpatialFilter(String geometryWkt)

    • addBBoxSpatialFilter

      public void addBBoxSpatialFilter(String bbox)

    • addPolygonSpatialFilter

      public void addPolygonSpatialFilter(String polygon)

    • addPointRadiusSpatialFilter

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

    • addTypeFilter

      public void addTypeFilter(String type, String versions)

    • addRecordIds

      public void addRecordIds(String recordIds)

    • accept

      public Object accept(org.geotools.api.filter.FilterVisitor visitor, Object obj)
      Specified by:
      accept in interface org.geotools.api.filter.Filter

    • evaluate

      public boolean evaluate(Object object)
      Specified by:
      evaluate in interface org.geotools.api.filter.Filter

    • getStartIndex

      public int getStartIndex()
      Specified by:
      getStartIndex in interface ddf.catalog.operation.Query

    • getPageSize

      public int getPageSize()
      Specified by:
      getPageSize in interface ddf.catalog.operation.Query

    • requestsTotalResultsCount

      public boolean requestsTotalResultsCount()
      Specified by:
      requestsTotalResultsCount in interface ddf.catalog.operation.Query

    • getTimeoutMillis

      public long getTimeoutMillis()
      Specified by:
      getTimeoutMillis in interface ddf.catalog.operation.Query

    • getSiteIds

      public Set<String> getSiteIds()

    • setSiteIds

      public void setSiteIds(Set<String> siteIds)

    • isEnterprise

      public boolean isEnterprise()

    • setIsEnterprise

      public void setIsEnterprise(boolean isEnterprise)

    • getSortBy

      public org.geotools.api.filter.sort.SortBy getSortBy()
      Specified by:
      getSortBy in interface ddf.catalog.operation.Query

    • getFilter

      public org.geotools.api.filter.Filter getFilter()
      Returns:
      a combined spatial, contextual and temporal filters together with a logical AND

    • toString

      public String toString()
      Overrides:
      toString in class Object