com.raritantechnologies.utils.comparators
Class StringStartsWithComparator

java.lang.Object
  com.raritantechnologies.utils.comparators.StringStartsWithComparator

All Implemented Interfaces:

java.util.Comparator, IComparator, IConfigurable

public class StringStartsWithComparator

extends java.lang.Object

implements IComparator

Configurable java.util.Comparator that determines if a String starts with a given substring.

XML Configuration Template:

   <Comparator class="com.raritantechnologies.utils.comparators.StringStartsWithComparator" 
                  startsWith="starting match"
                  caseSensitive="true(default)|false" />
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.utils.comparators.IComparator

TEMPLATE

Constructor Summary

StringStartsWithComparator()

StringStartsWithComparator(java.lang.String startString)

StringStartsWithComparator(java.lang.String startString, boolean caseSensitive)

Method Summary

int	compare(java.lang.Object ob1, java.lang.Object ob2)
boolean	equals(java.lang.Object object)
boolean	getCaseSensitive()
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
java.lang.String	getStartString()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setCaseSensitive(boolean caseSensitive)
void	setStartString(java.lang.String startString)

Methods inherited from class java.lang.Object

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

Constructor Detail

StringStartsWithComparator

public StringStartsWithComparator()

StringStartsWithComparator

public StringStartsWithComparator(java.lang.String startString)

StringStartsWithComparator

public StringStartsWithComparator(java.lang.String startString,
                                  boolean caseSensitive)

Method Detail

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Comparator

compare

public int compare(java.lang.Object ob1,
                   java.lang.Object ob2)

Specified by:

compare in interface java.util.Comparator

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

setStartString

public void setStartString(java.lang.String startString)

getStartString

public java.lang.String getStartString()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

getCaseSensitive

public boolean getCaseSensitive()

getConfigurationXML

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

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)