org.kuali.kra.lookup.keyvalue

Class SortedValuesFinder

java.lang.Object

org.kuali.kra.lookup.keyvalue.SortedValuesFinder

All Implemented Interfaces:

org.kuali.rice.krad.keyvalues.KeyValuesFinder

public final class SortedValuesFinder
extends Object
implements org.kuali.rice.krad.keyvalues.KeyValuesFinder

A KeyValuesFinder that sort the KeyValue returned from getKeyValues().

This class is designed to wrap other KeyValuesFinders in order to add behavior.

for example:

        PersistableBusinessObjectValuesFinder boFinder = new PersistableBusinessObjectValuesFinder();
        boFinder.setBusinessObjectClass(Foo.class);
        boFinder.setKeyAttributeName("foo");
        boFinder.setLabelAttributeName("bar");
        this.finder = new PrefixValuesFinder(new SortedValuesFinder(boFinder));
        .
        .
        .
        boFinder.getKeyValues();
   

Then just use the wrapped KeyValuesFinder within a custom finder.

Constructor Summary

Constructors

Constructor and Description
SortedValuesFinder(org.kuali.rice.krad.keyvalues.KeyValuesFinder finder) Wraps a KeyValuesFinder and using the default Comparator.
SortedValuesFinder(org.kuali.rice.krad.keyvalues.KeyValuesFinder finder, Comparator<org.kuali.rice.core.api.util.KeyValue> comparator) Wraps a KeyValuesFinder and using the passed in prefix value.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearInternalCache()
static Comparator<org.kuali.rice.core.api.util.KeyValue>	getDefaultComparator() Gets the default Comparator.
String	getKeyLabel(String key)
Map<String,String>	getKeyLabelMap()
List<org.kuali.rice.core.api.util.KeyValue>	getKeyValues()
List<org.kuali.rice.core.api.util.KeyValue>	getKeyValues(boolean includeActiveOnly)

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedValuesFinder

public SortedValuesFinder(org.kuali.rice.krad.keyvalues.KeyValuesFinder finder)

Wraps a KeyValuesFinder and using the default Comparator.

Parameters:

finder - the finder.

Throws:

NullPointerException - if the finder is null.

See Also:

getDefaultComparator()

SortedValuesFinder

public SortedValuesFinder(org.kuali.rice.krad.keyvalues.KeyValuesFinder finder,
                  Comparator<org.kuali.rice.core.api.util.KeyValue> comparator)

Wraps a KeyValuesFinder and using the passed in prefix value.

Parameters:

finder - the finder.

comparator - the comparator to use for sorting.

Throws:

NullPointerException - if the finder or the comparator value is null.

Method Detail

getKeyLabel

public String getKeyLabel(String key)

Specified by:

getKeyLabel in interface org.kuali.rice.krad.keyvalues.KeyValuesFinder

getKeyLabelMap

public Map<String,String> getKeyLabelMap()

Specified by:

getKeyLabelMap in interface org.kuali.rice.krad.keyvalues.KeyValuesFinder

getKeyValues

public List<org.kuali.rice.core.api.util.KeyValue> getKeyValues()

Specified by:

getKeyValues in interface org.kuali.rice.krad.keyvalues.KeyValuesFinder

getDefaultComparator

public static Comparator<org.kuali.rice.core.api.util.KeyValue> getDefaultComparator()

Gets the default Comparator.

Returns:

the default Comparator

getKeyValues

public List<org.kuali.rice.core.api.util.KeyValue> getKeyValues(boolean includeActiveOnly)

Specified by:

getKeyValues in interface org.kuali.rice.krad.keyvalues.KeyValuesFinder

clearInternalCache

public void clearInternalCache()

Specified by:

clearInternalCache in interface org.kuali.rice.krad.keyvalues.KeyValuesFinder