org.kuali.kra.lookup.keyvalue

Class PrefixValuesFinder

java.lang.Object

org.kuali.kra.lookup.keyvalue.PrefixValuesFinder

All Implemented Interfaces:

org.kuali.rice.krad.keyvalues.KeyValuesFinder

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

A KeyValuesFinder that adds a prefix KeyValue.

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
PrefixValuesFinder(org.kuali.rice.krad.keyvalues.KeyValuesFinder finder) Wraps a KeyValuesFinder using the default prefix value.
PrefixValuesFinder(org.kuali.rice.krad.keyvalues.KeyValuesFinder finder, String prefixValue) Wraps a KeyValuesFinder and using the passed in prefix value.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearInternalCache()
static String	getDefaultPrefixValue() Gets the default prefix value.
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)
static String	getPrefixKey() Gets the prefix key.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefixValuesFinder

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

Wraps a KeyValuesFinder using the default prefix value.

Parameters:

finder - the finder.

Throws:

NullPointerException - if the finder is null.

See Also:

getDefaultPrefixValue()

PrefixValuesFinder

public PrefixValuesFinder(org.kuali.rice.krad.keyvalues.KeyValuesFinder finder,
                  String prefixValue)

Wraps a KeyValuesFinder and using the passed in prefix value.

Parameters:

finder - the finder.

prefixValue - the prefix value. This value can be an empty string.

Throws:

NullPointerException - if the finder or the prefix 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

getPrefixKey

public static String getPrefixKey()

Gets the prefix key.

Returns:

the prefix key

getDefaultPrefixValue

public static String getDefaultPrefixValue()

Gets the default prefix value.

Returns:

the default prefix value

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