com.raritantechnologies.utils.time
Class DateSearchField

java.lang.Object
  com.raritantechnologies.utils.time.DateSearchField

All Implemented Interfaces:

IConfigurable

public class DateSearchField

extends java.lang.Object

implements IConfigurable

Represents a date search field - has information about the field ID, date formatting requirements, date operator field and value.

XML Configuration Template:

  <DateSearchField dateFieldID="[fieldID of date field]"
                      dateOpField="[fieldID of operator field]"
                      dateOpValue="[value of operator field]" >

   <!-- DateFieldFormatter applied to date strings passed to the setDate( String ) method. -->
   <InputFormatter >

   </InputFormatter>

   <!-- DateFieldFormatter applied to set the date search field value: matches the format -->
   <!-- required by the search source. -->
   <OutputFormatter>

   <!-- DateFieldFormatter -->
   </OutputFormatter>

  </DateSearchField>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

static java.lang.String	EQUALS_OPERATOR
static java.lang.String	GREATER_THAN_OPERATOR
static java.lang.String	LESS_THAN_OPERATOR

Constructor Summary

DateSearchField()

Method Summary

void	addDateField(OrderedMap inputParameters)
void	addDateField(OrderedMap inputParameters, java.util.Date theDate)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	removeDateField(OrderedMap inputParameters)
void	setDate(java.util.Date date)
void	setDate(java.lang.String dateValue)
void	setOperator(java.lang.String type) Sets the operator to the value configured for a specified type.

Methods inherited from class java.lang.Object

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

Field Detail

EQUALS_OPERATOR

public static final java.lang.String EQUALS_OPERATOR

See Also:

Constant Field Values

LESS_THAN_OPERATOR

public static final java.lang.String LESS_THAN_OPERATOR

See Also:

Constant Field Values

GREATER_THAN_OPERATOR

public static final java.lang.String GREATER_THAN_OPERATOR

See Also:

Constant Field Values

Constructor Detail

DateSearchField

public DateSearchField()

Method Detail

addDateField

public void addDateField(OrderedMap inputParameters)

addDateField

public void addDateField(OrderedMap inputParameters,
                         java.util.Date theDate)

removeDateField

public void removeDateField(OrderedMap inputParameters)

setDate

public void setDate(java.util.Date date)

setDate

public void setDate(java.lang.String dateValue)

setOperator

public void setOperator(java.lang.String type)

Sets the operator to the value configured for a specified type. Types are "EQUALS" "Greater Than" and "Less Than"

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable