com.raritantechnologies.utils.filter
Class DateStringFilter

java.lang.Object
  extended bycom.raritantechnologies.utils.filter.DateStringFilter
All Implemented Interfaces:
IConfigurable, IStringFilter

public class DateStringFilter
extends java.lang.Object
implements IStringFilter

Performs date formatting on an input string. Takes one or more input format patterns and an output format pattern. See the SimpleDateFormat documentation for valid format strings.

XML Configuration Template:
    <StringFilter 
        class="com.raritantechnologies.utils.filter.DateStringFilter" 
        inputFormat="EEE, MMM d, yyyy" outputFormat="MM/dd/yy" >

      <!-- Alternate input formats -->
      <InputFormat>MM/dd/yy hh:mm:ss

    </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
static java.lang.String TODAY
           
 
Fields inherited from interface com.raritantechnologies.utils.filter.IStringFilter
TEMPLATE
 
Constructor Summary
DateStringFilter()
           
 
Method Summary
 void addAlternateInputFormat(java.lang.String inputFormat)
           
 java.lang.String filterString(java.util.Map parameters, java.lang.String inputString)
           
 java.lang.String filterString(java.lang.String inputString)
           
 java.lang.String filterString(java.lang.String sessionID, java.lang.String inputString)
           
 java.lang.String[] getAlternateInputFormats()
           
 java.lang.String getConfigurationXML()
           
 java.lang.String getConfigurationXML(java.lang.String configurationTemplate)
           
 void getConfigurationXML(java.io.Writer writer)
           
 java.lang.String getInputDateFormat()
           
 java.lang.String getInputForm()
           
 java.lang.String getOutputDateFormat()
           
 boolean getUseConstant()
           
 void initialize(org.w3c.dom.Element elem)
          Initializes the object from an XML tag or element.
 void setAlternateInputFormats(java.lang.String[] altFormats)
           
 void setInputDateFormat(java.lang.String inputFormat)
           
 void setInputForm(java.lang.String inputForm)
           
 void setOutputDateFormat(java.lang.String outputFormat)
           
 void setUseConstant(boolean useConstant)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TODAY

public static final java.lang.String TODAY
See Also:
Constant Field Values
Constructor Detail

DateStringFilter

public DateStringFilter()
Method Detail

filterString

public java.lang.String filterString(java.lang.String inputString)
Specified by:
filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.util.Map parameters,
                                     java.lang.String inputString)
Specified by:
filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.lang.String sessionID,
                                     java.lang.String inputString)
Specified by:
filterString in interface IStringFilter

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

setInputDateFormat

public void setInputDateFormat(java.lang.String inputFormat)

getInputDateFormat

public java.lang.String getInputDateFormat()

setOutputDateFormat

public void setOutputDateFormat(java.lang.String outputFormat)

getOutputDateFormat

public java.lang.String getOutputDateFormat()

addAlternateInputFormat

public void addAlternateInputFormat(java.lang.String inputFormat)

setAlternateInputFormats

public void setAlternateInputFormats(java.lang.String[] altFormats)

getAlternateInputFormats

public java.lang.String[] getAlternateInputFormats()

setUseConstant

public void setUseConstant(boolean useConstant)

getUseConstant

public boolean getUseConstant()

setInputForm

public void setInputForm(java.lang.String inputForm)

getInputForm

public java.lang.String getInputForm()

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException
Throws:
java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()
Specified by:
getConfigurationXML in interface IStringFilter

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)
Specified by:
getConfigurationXML in interface IStringFilter