xal.tools.data

Class KeyValueListFilter<RecordType>

java.lang.Object

xal.tools.data.KeyValueListFilter<RecordType>

public class KeyValueListFilter<RecordType>
extends java.lang.Object

filter a list of objects according to the values associated with the specified keys

Constructor Summary

Constructors

Constructor and Description
KeyValueListFilter(KeyValueAdaptor adaptor, java.util.List<RecordType> allRecords, java.lang.String... matchingKeyPaths) Primary Constructor

Method Summary

Modifier and Type	Method and Description
java.util.List<RecordType>	filterRecords(java.lang.String text) Filter the records for those that match (case insensitive) every word in the specified text.
void	filterRecordsTo(java.lang.String text, java.util.List<RecordType> matchingRecords) Filter the records for those that match (case insensitive) every word in the specified text.
void	indexRecords() index all records by the keyed values in the list
void	reIndexRecord(RecordType record) re-index the specified record (e.g.
void	setAllRecords(java.util.List<RecordType> allRecords) Set the list of all objects to filter
void	setMatchingKeyPaths(java.lang.String... matchingKeyPaths) Set the matching key paths

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueListFilter

public KeyValueListFilter(KeyValueAdaptor adaptor,
                          java.util.List<RecordType> allRecords,
                          java.lang.String... matchingKeyPaths)

Primary Constructor

Parameters:

adaptor - key value adaptor to use to get the keyed values for the objects

allRecords - all of the objects to filter

matchingKeyPaths - the key paths corresponding to an object's keyed values to use for matching

Method Detail

setAllRecords

public void setAllRecords(java.util.List<RecordType> allRecords)

Set the list of all objects to filter

setMatchingKeyPaths

public void setMatchingKeyPaths(java.lang.String... matchingKeyPaths)

Set the matching key paths

indexRecords

public void indexRecords()

index all records by the keyed values in the list

reIndexRecord

public void reIndexRecord(RecordType record)

re-index the specified record (e.g. if a value in the record has changed )

filterRecordsTo

public void filterRecordsTo(java.lang.String text,
                            java.util.List<RecordType> matchingRecords)

Filter the records for those that match (case insensitive) every word in the specified text.

Parameters:

text - the text whose every word is matched against each record

matchingRecords - the container (first gets cleared) into which the matching records are placed preserving order

filterRecords

public java.util.List<RecordType> filterRecords(java.lang.String text)

Filter the records for those that match (case insensitive) every word in the specified text.

Parameters:

text - the text whose every word is matched against each record

Returns:

the list of matching records preserving order