com.esri.gpt.catalog.search
Class SearchFilterSpatial

java.lang.Object
  com.esri.gpt.catalog.search.SearchFilterSpatial

All Implemented Interfaces:

ISearchFilter, ISearchFilterSpatialObj, Serializable

Direct Known Subclasses:

SearchFilterHarvestSpatial

public class SearchFilterSpatial
extends Object
implements ISearchFilter, ISearchFilterSpatialObj

The Class SearchFilterSpatial. Filter specializing in spatial information.

See Also:

Serialized Form

Nested Class Summary

static class

SearchFilterSpatial.SaveParams The Enum SaveParams.

Nested classes/interfaces inherited from interface com.esri.gpt.catalog.search.ISearchFilterSpatialObj

ISearchFilterSpatialObj.OptionsBounds

Constructor Summary

SearchFilterSpatial()
Instantiates a new search filter spatial.

Method Summary

boolean	equals(Object obj) Compares two objects.
Envelope	getEnvelope() Gets the envelope associated with the class
String	getMvsUrl() Gets the mvs url.
SearchParameterMap	getParams() Gets the params.
String	getSelectedBounds() Gets the selected bounds.
ISearchFilterSpatialObj.OptionsBounds	getSelectedBoundsAsEnum() Gets the selected bounds options.
Envelope	getSelectedEnvelope() Gets the user selected envelope.
Envelope	getVisibleEnvelope() Gets the visible envelope (can be projected).
boolean	isEquals(Object obj) Checks if object in argument is equal to this
void	reset() Reset this object to default.
void	setEnvelope(Envelope envelope) Sets the envelope associated with the class
void	setParams(SearchParameterMap parameterMap) Sets the params.
void	setSelectedBounds(String selectedBounds) Sets the selected bounds.
void	setSelectedBoundsAsEnum(ISearchFilterSpatialObj.OptionsBounds selectedBounds) Sets the selected bounds options i.e.
void	setSelectedEnvelope(Envelope envelope) Sets the user selected envelope.
void	setVisibleEnvelope(Envelope envelope) Sets the visible envelope (can be projected).
String	toString()
void	validate() Validate.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilterSpatial

public SearchFilterSpatial()

Instantiates a new search filter spatial.

Method Detail

getSelectedEnvelope

public Envelope getSelectedEnvelope()

Gets the user selected envelope.

Returns:

the envelope (never null)

setSelectedEnvelope

public void setSelectedEnvelope(Envelope envelope)

Sets the user selected envelope.

Parameters:

envelope - the new envelope

setSelectedBoundsAsEnum

public void setSelectedBoundsAsEnum(ISearchFilterSpatialObj.OptionsBounds selectedBounds)

Sets the selected bounds options i.e. whether data envelopes are contained, anywhere or intersecting.

Specified by:

setSelectedBoundsAsEnum in interface ISearchFilterSpatialObj

Parameters:

selectedBounds - the new selected bounds

getSelectedBoundsAsEnum

public ISearchFilterSpatialObj.OptionsBounds getSelectedBoundsAsEnum()

Gets the selected bounds options.

Specified by:

getSelectedBoundsAsEnum in interface ISearchFilterSpatialObj

Returns:

the selected bounds

getSelectedBounds

public String getSelectedBounds()

Gets the selected bounds.

Specified by:

getSelectedBounds in interface ISearchFilterSpatialObj

Returns:

the selected bounds (trimmed, never null, default = "anywhere")

setSelectedBounds

public void setSelectedBounds(String selectedBounds)

Sets the selected bounds.

Specified by:

setSelectedBounds in interface ISearchFilterSpatialObj

Parameters:

selectedBounds - the new selected bounds

Throws:

IllegalArgumentException - if selectedBounds not in OptionsBounds

getVisibleEnvelope

public Envelope getVisibleEnvelope()

Gets the visible envelope (can be projected).

Specified by:

getVisibleEnvelope in interface ISearchFilterSpatialObj

Returns:

the visible envelope (never null)

setVisibleEnvelope

public void setVisibleEnvelope(Envelope envelope)

Sets the visible envelope (can be projected).

Specified by:

setVisibleEnvelope in interface ISearchFilterSpatialObj

Parameters:

envelope - the visible envelope

reset

public void reset()

Reset this object to default.

Specified by:

reset in interface ISearchFilter

validate

public void validate()
              throws SearchException

Validate.

Specified by:

validate in interface ISearchFilter

Throws:

SearchException - the search exception

See Also:

ISearchFilter.validate()

getParams

public SearchParameterMap getParams()

Gets the params.

Specified by:

getParams in interface ISearchFilter

Returns:

the params

See Also:

ISearchFilter.getParams()

setParams

public void setParams(SearchParameterMap parameterMap)

Sets the params.

Specified by:

setParams in interface ISearchFilter

Parameters:

parameterMap - the parameter map

See Also:

ISearchFilter.setParams(com.esri.gpt.catalog.search.SearchParameterMap)

equals

public boolean equals(Object obj)

Compares two objects.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if two objects are equal

isEquals

public boolean isEquals(Object obj)

Checks if object in argument is equal to this

Specified by:

isEquals in interface ISearchFilter

Parameters:

obj -

Returns:

true if equal, false otherwise

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getMvsUrl

public String getMvsUrl()

Gets the mvs url. If empty, there was an error getting the MVS url.

Returns:

the mvs url

getEnvelope

public Envelope getEnvelope()

Gets the envelope associated with the class

Specified by:

getEnvelope in interface ISearchFilterSpatialObj

Returns:

the envelope

setEnvelope

public void setEnvelope(Envelope envelope)

Sets the envelope associated with the class

Specified by:

setEnvelope in interface ISearchFilterSpatialObj

Parameters:

envelope -