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

Class XMLTreeContentProvider

java.lang.Object

com.webmethods.caf.faces.bean.PageFlowScopeAdapter

com.webmethods.caf.faces.data.object.ListTableContentProvider

com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

com.webmethods.caf.faces.data.object.FilterableSelectableListTableContentProvider

com.webmethods.caf.faces.data.tree.object.NodeTreeContentProvider

com.webmethods.caf.faces.data.tree.object.XMLTreeContentProvider

All Implemented Interfaces:

IPageFlowScopeAdapter, IAddressableTableContentProvider, IContentProvider, IFilterableTableContentProvider, IRefreshable, IRefreshableContentProvider, IReorderableTableContentProvider, ISelectableTableContentProvider, ISortableTableContentProvider, ITableContentProvider, IUpdateableContentProvider, IUpdateableTableContentProvider, ISelectableTreeContentProvider, ITreeContentProvider, Serializable

public class XMLTreeContentProvider
extends NodeTreeContentProvider

Tree provider which displays a tree of W3C DOM (Nodes). If this provider is configured with a row-id xpath expression (see setRowIdXpath(String)), the xpath expression should resolve to a unique row id for each node to display. If this provider is not configured with a row-id xpath expression, all elements in the tree will be displayed with an auto-generated row id (which may not work well if the tree is frequently updated).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.caf.faces.data.tree.object.NodeTreeContentProvider

NodeTreeContentProvider.DummyValueExpression, NodeTreeContentProvider.NodeComparator, NodeTreeContentProvider.NodeIdsIterator

Nested classes/interfaces inherited from class com.webmethods.caf.faces.data.object.FilterableSelectableListTableContentProvider

FilterableSelectableListTableContentProvider.RowFilterableValueDecorator

Nested classes/interfaces inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

SelectableListTableContentProvider.Row, SelectableListTableContentProvider.RowComparator

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Object[]	EMPTY_ARGS
protected Map<String,PropertyDescriptor>	m_descriptors
protected String	m_rowIdXpath

Fields inherited from class com.webmethods.caf.faces.data.tree.object.NodeTreeContentProvider

m_helper, m_roots, openToDepth

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

m_filter, m_filterable, m_filterValue, m_unfilteredlist

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

m_autoIdCounter, m_map, m_originalList, m_selectableHelper

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

m_array, m_canTemplateRow, m_index, m_list, m_onCreateRow, m_onDeleteRow, m_rowId, m_rowType, m_sort, m_templateRow, m_var

Fields inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter

fExpireWithPageFlow

Constructor Summary

Constructors

Constructor	Description
XMLTreeContentProvider()	Creates a new, uninitialized tree content-provider.
XMLTreeContentProvider(Node root)	Creates a new tree content-provider with the specified element root.
XMLTreeContentProvider(Node root, String rowIdXpath)	Creates a new tree content-provider with the specified root and row-id xpath expression (ie the xpath expression resolves to a unique id for each node to display).

Method Summary

Modifier and Type	Method	Description
protected Map<String,PropertyDescriptor>	getPropertyDescriptors()	Returns map of bean property-names to bean property-descriptors for all of the bean's properties.
Node	getRoot()	Tree root.
String	getRowIdXpath()	Xpath expression which resolves to a unique id for each node to display.
Class<?>	getType(Object propertyKey)	Returns java type of the given property
Object	getValue(Object propertyKey)	Returns value of the given property
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	setRoot(Node root)	Tree root.
void	setRowIdXpath(String rowIdXpath)	Xpath expression which resolves to a unique id for each node to display.
void	setValue(Object propertyKey, Object value)	Sets new value of the given property

Methods inherited from class com.webmethods.caf.faces.data.tree.object.NodeTreeContentProvider

calculateRowId, flatten, getCanTemplateRow, getChildIds, getCurrentNode, getCurrentRow, getDepth, getHasChildren, getLastChildAncestors, getOpenIds, getOpenToDepth, getParentId, getRootIds, getUnopenIds, getUseUnopenModel, isFirstChild, isLastChild, isOpen, isRowMixed, isVisible, openTreeNodes, setList, setOpen, setOpenIds, setOpenToDepth, setUnopenIds, sort, sort

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

filter, getFilter, getRowFilterValueBinding, getRowFilterValueBindingAsString, getRowFilterValueExpression, isFilterable, setFilter, setFilterable, setRowFilterValueBinding, setRowFilterValueBindingAsString, setRowFilterValueExpression

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

createRow, deleteRow, getList, getNeedRefresh, getRowId, getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getSelectedRows, getUseUnselectedModel, isAddressable, isAutoRefresh, isRowSelected, moveTo, refresh, setAutoRefresh, setCurrentRow, setNeedRefresh, setRowById, setRowSelected, setRowSelectedIds, setRowUnselectedIds, setRowVariable, setTemplateRow, supportsAutoRefresh, updateOriginalList

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

calculateRowId, getArray, getOnCreateRow, getOnCreateRowExpression, getOnDeleteRow, getOnDeleteRowExpression, getPropertyKeys, getRowCount, getRowIdBinding, getRowIdExpression, getRowIndex, getRowType, getRowVariable, getSort, isReorderable, isRowAvailable, isTemplateRow, newRow, setArray, setCanTemplateRow, setOnCreateRow, setOnCreateRowExpression, setOnDeleteRow, setOnDeleteRowExpression, setRowId, setRowIdBinding, setRowIdExpression, setRowIndex, setRowType, setSort, toString

Methods inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter

getExpireWithPageFlow, setExpireWithPageFlow

Methods inherited from class java.lang.Object

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

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

getRowId, isAddressable, setRowById

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

getPropertyKeys, toString

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

getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getUseUnselectedModel, isRowSelected, setRowSelected, setRowSelectedIds, setRowUnselectedIds

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

getRowCount, getRowIndex, getRowVariable, isRowAvailable, setRowIndex, setRowVariable

Field Details

EMPTY_ARGS

protected static final Object[] EMPTY_ARGS

m_descriptors

protected Map<String,PropertyDescriptor> m_descriptors

m_rowIdXpath

protected String m_rowIdXpath

Constructor Details

XMLTreeContentProvider

public XMLTreeContentProvider()

Creates a new, uninitialized tree content-provider. This provider must be initialized with a root.

XMLTreeContentProvider

public XMLTreeContentProvider(Node root)

Creates a new tree content-provider with the specified element root. Unless a row-id xpath expression is also configured, the tree nodes will use auto-generated ids (which may not work well if the tree's content changes frequently).

XMLTreeContentProvider

public XMLTreeContentProvider(Node root,
 String rowIdXpath)

Creates a new tree content-provider with the specified root and row-id xpath expression (ie the xpath expression resolves to a unique id for each node to display).

Method Details

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

Overrides:

getType in class ListTableContentProvider

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

Overrides:

getValue in class ListTableContentProvider

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

Overrides:

hasProperty in class ListTableContentProvider

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

Overrides:

isReadOnly in class ListTableContentProvider

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

Overrides:

setValue in class ListTableContentProvider

Parameters:

propertyKey - property key of type String or Integer

value - new property value

Throws:

PropertyNotFoundException - if property is not found

ELException

getRoot

public Node getRoot()

Tree root.

setRoot

public void setRoot(Node root)

Tree root.

getRowIdXpath

public String getRowIdXpath()

Xpath expression which resolves to a unique id for each node to display. If null, the tree will use auto-generated ids (which may not work well if the tree's content changes frequently).

setRowIdXpath

public void setRowIdXpath(String rowIdXpath)

Xpath expression which resolves to a unique id for each node to display. If null, the tree will use auto-generated ids (which may not work well if the tree's content changes frequently).

getPropertyDescriptors

protected Map<String,PropertyDescriptor> getPropertyDescriptors()

Returns map of bean property-names to bean property-descriptors for all of the bean's properties.