com.webmethods.caf.faces.data.object

Class BoundPropertiesContentProvider

java.lang.Object

com.webmethods.caf.faces.data.object.BoundPropertiesContentProvider

All Implemented Interfaces:

IContentProvider, IUpdateableContentProvider

Direct Known Subclasses:

AtomFeedExportProvider, BoundPropertiesTableContentProvider

public class BoundPropertiesContentProvider
extends Object
implements IContentProvider, IUpdateableContentProvider

Provider which limits a wrapped provider to exposing a specified set of properties; the properties are specified via binding expressions.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,ValueExpression>	m_keys
protected IContentProvider	m_provider
protected String	m_var

Constructor Summary

Constructors

Constructor and Description
BoundPropertiesContentProvider() Blank provider.
BoundPropertiesContentProvider(IContentProvider provider, Map<String,?> keys, String var) Provider limiting specified provider to specified keys.

Method Summary

Modifier and Type	Method and Description
static Map<String,ValueExpression>	createDefaultKeyExpressions(IContentProvider provider, String var) Creates the default key mapping for the specified provider and provider variable.
static Map<String,ValueBinding>	createDefaultKeys(IContentProvider provider, String var) Deprecated. use createDefaultKeyExpressions(IContentProvider, String) instead
Map<String,ValueExpression>	getKeyExpressions() Maps property names to value-binding expressions.
Map<String,ValueBinding>	getKeys() Deprecated. use getKeyExpressions() instead
Object[]	getPropertyKeys() Returns list of properties supported by this content provider.
IContentProvider	getProvider() Source provider that this provider limits.
Class<?>	getType(Object propertyKey) Returns java type of the given property
Object	getValue(Object propertyKey) Returns value of the given property
String	getVar() Variable representing the source provider to use in key value bindings.
boolean	hasProperty(Object propertyKey) Checks if the given property is supported by this content provider
boolean	isReadOnly(Object propertyKey) Returns true if the given property is readonly.
void	setKeyExpressions(Map<String,ValueExpression> keys) Maps property names to value-binding expressions.
void	setKeys(Map<String,ValueBinding> keys) Deprecated. use setKeyExpressions(Map) instead
void	setProvider(IContentProvider provider) Source provider that this provider limits.
void	setValue(Object propertyKey, Object value) Sets new value of the given property
void	setVar(String var) Variable representing the source provider to use in key value bindings.
String	toString() Returns string representation of content.

Methods inherited from class java.lang.Object

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

Field Detail

m_provider

protected IContentProvider m_provider

m_keys

protected Map<String,ValueExpression> m_keys

m_var

protected String m_var

Constructor Detail

BoundPropertiesContentProvider

public BoundPropertiesContentProvider()

Blank provider. Must be initialized with setProvider(com.webmethods.caf.faces.data.IContentProvider), setKeys(java.util.Map<java.lang.String, javax.faces.el.ValueBinding>), and setVar(java.lang.String).

BoundPropertiesContentProvider

public BoundPropertiesContentProvider(IContentProvider provider,
                                      Map<String,?> keys,
                                      String var)

Provider limiting specified provider to specified keys.

Method Detail

createDefaultKeys

@Deprecated
public static Map<String,ValueBinding> createDefaultKeys(IContentProvider provider,
                                                                     String var)

Deprecated. use createDefaultKeyExpressions(IContentProvider, String) instead

Creates the default key mapping for the specified provider and provider variable. For example, if the provider has three keys ["foo", "bar", "baz"], the default key mapping would be (with var "p") {"foo":"#{p.foo}", "bar":"#{p.bar}", "baz":"#{p.baz}"}.

createDefaultKeyExpressions

public static Map<String,ValueExpression> createDefaultKeyExpressions(IContentProvider provider,
                                                                      String var)

Creates the default key mapping for the specified provider and provider variable. For example, if the provider has three keys ["foo", "bar", "baz"], the default key mapping would be (with var "p") {"foo":"#{p.foo}", "bar":"#{p.bar}", "baz":"#{p.baz}"}.

toString

public String toString()

Description copied from interface: IContentProvider

Returns string representation of content.

Specified by:

toString in interface IContentProvider

Overrides:

toString in class Object

Returns:

String representation of the wrapped content

getPropertyKeys

public Object[] getPropertyKeys()

Description copied from interface: IContentProvider

Returns list of properties supported by this content provider. Can return Object[0], never null.

Specified by:

getPropertyKeys in interface IContentProvider

Returns:

array of property keys which is typically of type String or Integer

getType

public Class<?> getType(Object propertyKey)
                 throws PropertyNotFoundException

Description copied from interface: IContentProvider

Returns java type of the given property

Specified by:

getType in interface IContentProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

property java Class

Throws:

PropertyNotFoundException - if property is not supported

getValue

public Object getValue(Object propertyKey)
                throws ELException,
                       PropertyNotFoundException

Description copied from interface: IContentProvider

Returns value of the given property

Specified by:

getValue in interface IContentProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

value of the property, can be null

Throws:

PropertyNotFoundException - if property is not supported

ELException

hasProperty

public boolean hasProperty(Object propertyKey)

Description copied from interface: IContentProvider

Checks if the given property is supported by this content provider

Specified by:

hasProperty in interface IContentProvider

Parameters:

propertyKey - property key of type String or Integer

Returns:

true if property is supported

isReadOnly

public boolean isReadOnly(Object propertyKey)
                   throws ELException,
                          PropertyNotFoundException

Description copied from interface: IUpdateableContentProvider

Returns true if the given property is readonly. If it is readonly, IUpdateableContentProvider.setValue(Object, Object) will definitely fail.

Specified by:

isReadOnly in interface IUpdateableContentProvider

Parameters:

propertyKey - property key of type String or Integer

Returns:

true if the property is readonly

Throws:

PropertyNotFoundException

ELException

setValue

public void setValue(Object propertyKey,
                     Object value)
              throws ELException,
                     PropertyNotFoundException

Description copied from interface: IUpdateableContentProvider

Sets new value of the given property

Specified by:

setValue in interface IUpdateableContentProvider

Parameters:

propertyKey - property key of type String or Integer

value - new property value

Throws:

PropertyNotFoundException - if property is not found

ELException

getProvider

public IContentProvider getProvider()

Source provider that this provider limits.

setProvider

public void setProvider(IContentProvider provider)

Source provider that this provider limits.

getKeys

@Deprecated
public Map<String,ValueBinding> getKeys()

Deprecated. use getKeyExpressions() instead

Maps property names to value-binding expressions.

setKeys

@Deprecated
public void setKeys(Map<String,ValueBinding> keys)

Deprecated. use setKeyExpressions(Map) instead

Maps property names to value-binding expressions.

getKeyExpressions

public Map<String,ValueExpression> getKeyExpressions()

Maps property names to value-binding expressions.

setKeyExpressions

public void setKeyExpressions(Map<String,ValueExpression> keys)

Maps property names to value-binding expressions.

getVar

public String getVar()

Variable representing the source provider to use in key value bindings.

setVar

public void setVar(String var)

Variable representing the source provider to use in key value bindings.