com.esri.gpt.catalog.search
Class SearchFilterTemporal

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

All Implemented Interfaces:

ISearchFilter, ISearchFilterTemporal, Serializable

public class SearchFilterTemporal
extends Object
implements ISearchFilter, ISearchFilterTemporal

The Class SearchFilterTemporal. Filter Bean class holding date information.

See Also:

Serialized Form

Nested Class Summary

static class

SearchFilterTemporal.SelectedTimePeriod The Enum SelectedTimePeriod.

Field Summary

static String

DEFAULT_TIME_FORMAT The default time format.

Constructor Summary

SearchFilterTemporal()
Instantiates a new search filter temporal.

Method Summary

boolean	equals(Object obj) Checks if an object argument is the same as this.
String	getDateModifiedFrom() Gets the date modified from.
Date	getDateModifiedFromAsDate() Gets the date modified From as Date object.
String	getDateModifiedTo() Gets the date modified to.
Date	getDateModifiedToAsDate() Gets the date modified to as Date object.
SearchParameterMap	getParams() Search parameters
SearchParameterMap	getParams(SimpleDateFormat format) Gets the params.
String	getSelectedModifiedDateOption() Gets the selected modified date option.
boolean	isEquals(Object obj) Checks if is equals.
void	reset() Reset this object
void	setDateModifiedFrom(String dateModifiedFrom) Sets the date modified from.
void	setDateModifiedTo(String dateModfiedTo) Sets the date modified to.
void	setParams(SearchParameterMap parameterMap) Sets the params.
void	setSelectedModifiedDateOption(String selectedModifiedDateOption) Sets the selected modified date option.
String	toString() String representation of class
void	validate() Validate.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIME_FORMAT

public static String DEFAULT_TIME_FORMAT

The default time format.

Constructor Detail

SearchFilterTemporal

public SearchFilterTemporal()

Instantiates a new search filter temporal.

Method Detail

getDateModifiedTo

public String getDateModifiedTo()

Gets the date modified to.

Returns:

the date modified to (trimmed, never null)

setDateModifiedTo

public void setDateModifiedTo(String dateModfiedTo)

Sets the date modified to.

Parameters:

dateModfiedTo - the new date modified to

getDateModifiedToAsDate

public Date getDateModifiedToAsDate()

Gets the date modified to as Date object.

Specified by:

getDateModifiedToAsDate in interface ISearchFilterTemporal

Returns:

the date modified to (possibly null)

getDateModifiedFrom

public String getDateModifiedFrom()

Gets the date modified from.

Returns:

the date modified from (trimmed, never null)

getDateModifiedFromAsDate

public Date getDateModifiedFromAsDate()

Gets the date modified From as Date object.

Specified by:

getDateModifiedFromAsDate in interface ISearchFilterTemporal

Returns:

the date modified to (possibly null)

setDateModifiedFrom

public void setDateModifiedFrom(String dateModifiedFrom)

Sets the date modified from.

Parameters:

dateModifiedFrom - the new date modified from

getSelectedModifiedDateOption

public String getSelectedModifiedDateOption()

Gets the selected modified date option.

Specified by:

getSelectedModifiedDateOption in interface ISearchFilterTemporal

Returns:

the selected modified date option (trimmed, never null or empty, default = "any")

setSelectedModifiedDateOption

public void setSelectedModifiedDateOption(String selectedModifiedDateOption)

Sets the selected modified date option.

Specified by:

setSelectedModifiedDateOption in interface ISearchFilterTemporal

Parameters:

selectedModifiedDateOption - the new selected modified date option

getParams

public SearchParameterMap getParams()

Search parameters

Specified by:

getParams in interface ISearchFilter

Returns:

(never null)

isEquals

public boolean isEquals(Object obj)

Checks if is equals.

Specified by:

isEquals in interface ISearchFilter

Parameters:

obj - the obj

Returns:

true, if checks if is equals

equals

public boolean equals(Object obj)

Checks if an object argument is the same as this.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true or false if object is equal to this this or not

reset

public void reset()

Reset this object

Specified by:

reset in interface ISearchFilter

setParams

public void setParams(SearchParameterMap parameterMap)
               throws SearchException

Sets the params.

Specified by:

setParams in interface ISearchFilter

Parameters:

parameterMap - the parameter map

Throws:

SearchException - the search exception

validate

public void validate()
              throws SearchException

Validate.

Specified by:

validate in interface ISearchFilter

Throws:

SearchException - the search exception

getParams

public SearchParameterMap getParams(SimpleDateFormat format)

Gets the params.

Specified by:

getParams in interface ISearchFilterTemporal

Parameters:

format - the format (if null, then default is used)

Returns:

the params (never null)

toString

public String toString()

String representation of class

Overrides:

toString in class Object

Returns:

string representation