com.esri.gpt.control.webharvest.common
Class CommonCriteria

java.lang.Object
  com.esri.gpt.control.webharvest.common.CommonCriteria

All Implemented Interfaces:

Criteria

public class CommonCriteria
extends Object
implements Criteria

Common implementation of criteria.

Since:

10.0

Constructor Summary

CommonCriteria()

Method Summary

Envelope	getBBox() Gets bounding box.
ISearchFilterSpatialObj.OptionsBounds	getBBoxOption() Gets bounding box option.
SearchEngineCSW.AimsContentTypes	getContentType() Content type.
String[]	getDataCategory() Gets data categories.
Date	getFromDate() Gets update date to search from.
Integer	getMaxRecords() Gets maximum number of records to fetch.
String	getSearchText() Gets search text.
SearchFilterSort.OptionsSort	getSortOption() Gets sort option.
Date	getToDate() Gets update date to search to.
static CommonCriteria	parseXmlString(String str) Parses criteria from XML string.
void	setBBox(Envelope bBox) Sets bounding box.
void	setBBoxOption(ISearchFilterSpatialObj.OptionsBounds bBoxOption) Sets bounding box options.
void	setContentType(SearchEngineCSW.AimsContentTypes contentType) Sets content type.
void	setDataCategory(String[] dataCategory) Sets data category
void	setFromDate(Date fromDate) Sets FROM date.
void	setMaxRecords(Integer maxRecords) Sets maximum records.
void	setSearchText(String searchText) Sets search text.
void	setSortOption(SearchFilterSort.OptionsSort sortOption) Sets sort options.
void	setToDate(Date toDate) Sets TO date
String	toString()
String	toXmlString() Converts criteria into XML string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonCriteria

public CommonCriteria()

Method Detail

getMaxRecords

public Integer getMaxRecords()

Description copied from interface: Criteria

Gets maximum number of records to fetch.

Specified by:

getMaxRecords in interface Criteria

Returns:

maximum number of records to fetch or null if no limit

setMaxRecords

public void setMaxRecords(Integer maxRecords)

Sets maximum records.

Parameters:

maxRecords - maximum records

getSearchText

public String getSearchText()

Description copied from interface: Criteria

Gets search text.

Specified by:

getSearchText in interface Criteria

Returns:

search text or null or empty string if no search text

setSearchText

public void setSearchText(String searchText)

Sets search text.

Parameters:

searchText - search text

getFromDate

public Date getFromDate()

Description copied from interface: Criteria

Gets update date to search from.

Specified by:

getFromDate in interface Criteria

Returns:

update date to search from or null if no date

setFromDate

public void setFromDate(Date fromDate)

Sets FROM date.

Parameters:

fromDate - FROM date

getToDate

public Date getToDate()

Description copied from interface: Criteria

Gets update date to search to.

Specified by:

getToDate in interface Criteria

Returns:

update date to search to or null if no date

setToDate

public void setToDate(Date toDate)

Sets TO date

Parameters:

toDate - TO date

getBBox

public Envelope getBBox()

Description copied from interface: Criteria

Gets bounding box. Bounding box is an array of numbers arranged in the following pattern: [xmin,ymin,xmax,ymax].

Specified by:

getBBox in interface Criteria

Returns:

bounding box or null if no bounding box

setBBox

public void setBBox(Envelope bBox)

Sets bounding box.

Parameters:

bBox - bounding box

getContentType

public SearchEngineCSW.AimsContentTypes getContentType()

Description copied from interface: Criteria

Content type.

Specified by:

getContentType in interface Criteria

Returns:

content type

setContentType

public void setContentType(SearchEngineCSW.AimsContentTypes contentType)

Sets content type.

Parameters:

contentType - content type

getDataCategory

public String[] getDataCategory()

Description copied from interface: Criteria

Gets data categories.

Specified by:

getDataCategory in interface Criteria

Returns:

array of data categories or null if no any data category

setDataCategory

public void setDataCategory(String[] dataCategory)

Sets data category

Parameters:

dataCategory - data category

getBBoxOption

public ISearchFilterSpatialObj.OptionsBounds getBBoxOption()

Description copied from interface: Criteria

Gets bounding box option.

Specified by:

getBBoxOption in interface Criteria

Returns:

bounding box option

setBBoxOption

public void setBBoxOption(ISearchFilterSpatialObj.OptionsBounds bBoxOption)

Sets bounding box options.

Parameters:

bBoxOption - bounding box options

getSortOption

public SearchFilterSort.OptionsSort getSortOption()

Description copied from interface: Criteria

Gets sort option.

Specified by:

getSortOption in interface Criteria

Returns:

sort option

setSortOption

public void setSortOption(SearchFilterSort.OptionsSort sortOption)

Sets sort options.

Parameters:

sortOption - sort options.

toString

public String toString()

Overrides:

toString in class Object

toXmlString

public String toXmlString()

Converts criteria into XML string.

Returns:

criteria as XML string

parseXmlString

public static CommonCriteria parseXmlString(String str)

Parses criteria from XML string.

Parameters:

str - criteria as XML string

Returns:

criteria