Package com.webmethods.caf.faces.data.object

Class DefaultSelectItemGroupProvider

java.lang.Object

javax.faces.model.SelectItem

com.webmethods.caf.faces.data.object.DefaultSelectItemProvider

com.webmethods.caf.faces.data.object.DefaultSelectItemGroupProvider

All Implemented Interfaces:

IFilterableSelectItemGroupProvider, ISelectItemGroupProvider, ISelectItemProvider, Serializable

Direct Known Subclasses:

CharacterEncodingSelectItemGroupProvider, DirectoryServicesSelectItemGroupProvider, LocaleSelectItemGroupProvider, PrincipalAttributeValueSourceSelectItemGroupProvider

public class DefaultSelectItemGroupProvider
extends DefaultSelectItemProvider
implements Serializable, IFilterableSelectItemGroupProvider

Default implementation of ISelectItemGroupProvider.

Used by UI controls internally to adapt various input objects to ISelectItemGroupProvider.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_filter	Filter expression; null by default (indicating no filter).
protected boolean	m_filterable	True if this provider can filter select-items; false by default.
protected List<ISelectItemProvider>	m_items	Static list of select-items.

Fields inherited from class com.webmethods.caf.faces.data.object.DefaultSelectItemProvider

m_description, m_disabled, m_escaped, m_icon, m_label, m_style, m_value, source

Constructor Summary

Constructors

Constructor	Description
DefaultSelectItemGroupProvider()	Default constructor.
DefaultSelectItemGroupProvider(ISelectItemGroupProvider group)	Adds ISelectItemGroupProvider instance to the list of providers
DefaultSelectItemGroupProvider(ISelectItemProvider[] group)	Adds an array of ISelectItemProvider to the list
DefaultSelectItemGroupProvider(Object o)	Adds given object (if supported) to the list of ISelectItemProvider's
DefaultSelectItemGroupProvider(Object[] o)	Adds given object array (if supported) to the list of ISelectItemProvider's
DefaultSelectItemGroupProvider(Collection<?> group)	Adds collection of all supported input objects to the list
DefaultSelectItemGroupProvider(Map<String,?> group)	Adds map of Stringlabel and Object value pairs to the list of ISelectItemProvider's
DefaultSelectItemGroupProvider(UISelectItems component)	Adapts UISeletcItems component
DefaultSelectItemGroupProvider(SelectItem[] group)	Adapts array of SelectItem components
DefaultSelectItemGroupProvider(SelectItemGroup group)	Adapts SelectItemGroup component

Method Summary

Modifier and Type	Method	Description
void	add(ISelectItemProvider item)	Adds and single ISelectItemProvider to the list
ISelectItemProvider	findSelectItemContentProvider(Object value)	Finds the first item in the group with the exact specified value.
String	getFilter()	Filter expression.
Collection<ISelectItemProvider>	getSelectItemContentProviders()	Returns a collection of ISelectItemProviders.
void	initialize(ISelectItemGroupProvider group)
void	initialize(ISelectItemProvider item)
void	initialize(ISelectItemProvider[] group)
void	initialize(Object o)	Initializes the provider with a given source object.
void	initialize(Object[] array)
void	initialize(String[] array)
void	initialize(Collection<?> group)
void	initialize(Map<String,?> group)
void	initialize(UISelectItems component)
void	initialize(SelectItem item)
void	initialize(SelectItem[] group)
void	initialize(SelectItemGroup group)
boolean	isFilterable()	True if this provider truely is filterable.
void	setFilter(String filter)	Filter expression.
void	setFilterable(boolean filterable)	True if this provider truely is filterable.

Methods inherited from class com.webmethods.caf.faces.data.object.DefaultSelectItemProvider

getDescription, getIcon, getLabel, getSource, getStyle, getValue, initialize, initialize, isDisabled, isEscape, setDescription, setDisabled, setEscape, setIcon, setLabel, setSource, setStyle, setValue

Methods inherited from class javax.faces.model.SelectItem

isNoSelectionOption, setNoSelectionOption

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webmethods.caf.faces.data.ISelectItemProvider

getDescription, getIcon, getLabel, getStyle, getValue, isDisabled, isEscape

Field Details

m_items

protected List<ISelectItemProvider> m_items

Static list of select-items.

m_filterable

protected boolean m_filterable

True if this provider can filter select-items; false by default.

m_filter

protected String m_filter

Filter expression; null by default (indicating no filter).

Constructor Details

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider()

Default constructor. Requires DefaultSelectItemProvider.setSource(Object) method to be called with the input object.

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(UISelectItems component)

Adapts UISeletcItems component

Parameters:

component - UISelectItems component to add to the list of ISelectItemProvider's

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(ISelectItemGroupProvider group)

Adds ISelectItemGroupProvider instance to the list of providers

Parameters:

group - another ISelectItemGroupProvider instance

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(SelectItemGroup group)

Adapts SelectItemGroup component

Parameters:

group - SelectItemGroup component to add to the list of ISelectItemProvider's

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(ISelectItemProvider[] group)

Adds an array of ISelectItemProvider to the list

Parameters:

group - array of ISelectItemProvider component to add to the list of ISelectItemProvider's

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(SelectItem[] group)

Adapts array of SelectItem components

Parameters:

group - array of SelectItem components to add to the list of ISelectItemProvider's

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(Collection<?> group)

Adds collection of all supported input objects to the list

Parameters:

group - collection all supported input objects

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(Map<String,?> group)

Adds map of Stringlabel and Object value pairs to the list of ISelectItemProvider's

Parameters:

group - map of label/value pairs

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(Object o)

Adds given object (if supported) to the list of ISelectItemProvider's

Parameters:

o - a supported type of object

DefaultSelectItemGroupProvider

public DefaultSelectItemGroupProvider(Object[] o)

Adds given object array (if supported) to the list of ISelectItemProvider's

Parameters:

o - array of supported types of objects

Method Details

getSelectItemContentProviders

public Collection<ISelectItemProvider> getSelectItemContentProviders()

Description copied from interface: ISelectItemGroupProvider

Returns a collection of ISelectItemProviders.

Specified by:

getSelectItemContentProviders in interface ISelectItemGroupProvider

Returns:

collectio of individual select items

isFilterable

public boolean isFilterable()

Description copied from interface: IFilterableSelectItemGroupProvider

True if this provider truely is filterable.

Specified by:

isFilterable in interface IFilterableSelectItemGroupProvider

getFilter

public String getFilter()

Description copied from interface: IFilterableSelectItemGroupProvider

Filter expression. The collection returned by the ISelectItemGroupProvider.getSelectItemContentProviders() method should reflect the filter settings. Null or empty ("") signals expose the default collection.

Specified by:

getFilter in interface IFilterableSelectItemGroupProvider

setFilter

public void setFilter(String filter)

Description copied from interface: IFilterableSelectItemGroupProvider

Filter expression. The collection returned by the ISelectItemGroupProvider.getSelectItemContentProviders() method should reflect the filter settings. Null or empty ("") signals expose the default collection.

Specified by:

setFilter in interface IFilterableSelectItemGroupProvider

findSelectItemContentProvider

public ISelectItemProvider findSelectItemContentProvider(Object value)

Description copied from interface: IFilterableSelectItemGroupProvider

Finds the first item in the group with the exact specified value. Searches the entire collection, regardless of the filter expression. Returns null if no item is found.

Specified by:

findSelectItemContentProvider in interface IFilterableSelectItemGroupProvider

initialize

public void initialize(ISelectItemProvider item)

Overrides:

initialize in class DefaultSelectItemProvider

See Also:

• DefaultSelectItemGroupProvider(ISelectItemGroupProvider)

initialize

public void initialize(SelectItem item)

Overrides:

initialize in class DefaultSelectItemProvider

See Also:

• DefaultSelectItemGroupProvider(SelectItem)

initialize

public void initialize(UISelectItems component)

See Also:

• DefaultSelectItemGroupProvider(UISelectItems)

initialize

public void initialize(ISelectItemGroupProvider group)

See Also:

• DefaultSelectItemGroupProvider(ISelectItemGroupProvider)

initialize

public void initialize(SelectItemGroup group)

See Also:

• DefaultSelectItemGroupProvider(SelectItemGroup)

initialize

public void initialize(ISelectItemProvider[] group)

See Also:

• DefaultSelectItemGroupProvider(ISelectItemProvider[])

initialize

public void initialize(SelectItem[] group)

See Also:

• DefaultSelectItemGroupProvider(SelectItem[])

initialize

public void initialize(Collection<?> group)

See Also:

• DefaultSelectItemGroupProvider(Collection)

initialize

public void initialize(Map<String,?> group)

See Also:

• DefaultSelectItemGroupProvider(Map)

initialize

public void initialize(String[] array)

Parameters:

array -

See Also:

• DefaultSelectItemGroupProvider(Object[])

initialize

public void initialize(Object[] array)

See Also:

• DefaultSelectItemGroupProvider(Object[])

initialize

public void initialize(Object o)

Description copied from class: DefaultSelectItemProvider

Initializes the provider with a given source object. Supported types are:

• ISelectItemProvider
• SelectItem
• UISelectItem

Overrides:

initialize in class DefaultSelectItemProvider

Parameters:

o - a supported object type instance

See Also:

• DefaultSelectItemGroupProvider(Object)

add

public void add(ISelectItemProvider item)

Adds and single ISelectItemProvider to the list

Parameters:

item - ISelectItemProvider

setFilterable

public void setFilterable(boolean filterable)

True if this provider truely is filterable.