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

Class NodeTreeContentProvider

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BoundChildrenTreeContentProvider, ListTreeContentProvider, XMLTreeContentProvider

public class NodeTreeContentProvider
extends FilterableSelectableListTableContentProvider
implements ISelectableTreeContentProvider

Tree provider backed by a list of INode roots.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	NodeTreeContentProvider.DummyValueExpression
protected static class	NodeTreeContentProvider.NodeComparator	Compares two nodes using column sorting info.
protected static class	NodeTreeContentProvider.NodeIdsIterator	Iterates over a list of INodes, returning each node's id.

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 TreeContentProviderHelper	m_helper
protected List<Object>	m_roots	List of INode roots.
protected int	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
NodeTreeContentProvider()	New tree provider.
NodeTreeContentProvider(INode root)	New tree provider backed by single INode root.
NodeTreeContentProvider(List<?> list)	New tree provider backed by a list of INode roots.

Method Summary

Modifier and Type	Method	Description
protected String	calculateRowId(int index, Object data)	Calculates row id from the row data object using ListTableContentProvider.getRowIdBinding() expression.
protected void	flatten(List<?> nodes, List<Object> master)	Flattens list of nodes at a given level, recursively.
boolean	getCanTemplateRow()	True if provider can be put into template row state.
Iterator<String>	getChildIds()	String ids of child rows, in order.
protected INode	getCurrentNode()	Returns the current node.
Object	getCurrentRow()	Returns current row.
int	getDepth()	Depth of current row.
boolean	getHasChildren()	True if current row has children.
boolean[]	getLastChildAncestors()	ITreeContentProvider.isLastChild() value of ancestors to the current row, from the root to the current row's parent.
Collection<String>	getOpenIds()	Collection of String ids of open rows.
int	getOpenToDepth()
String	getParentId()	Id of parent row.
Iterator<String>	getRootIds()	String ids of root rows, in order.
Collection<String>	getUnopenIds()	Collection of String ids of un-open rows (all other rows are open implicitly).
boolean	getUseUnopenModel()	True if it's more effecient to use the un-open model (ITreeContentProvider.getUnopenIds()) rather than the open model (ITreeContentProvider.getOpenIds()).
boolean	isFirstChild()	True if current row is first child of parent (not whether or not current row is first row in tree).
boolean	isLastChild()	True if current row is last child of parent (not whether or not current row is last row in tree).
boolean	isOpen()	True if current row is open.
boolean	isRowMixed()	True if row selection state is mixed.
boolean	isVisible()	True if ancestors of current row are all open.
void	openTreeNodes(int depth)	setOpenToDepth() optimization
void	setList(List<?> list)	Sets a list to wrap
void	setOpen(boolean open)	True if current row is open.
void	setOpenIds(Collection<String> ids)	Collection of String ids of open rows.
void	setOpenToDepth(int depth)	Sets tree open to the specified depth.
void	setUnopenIds(Collection<String> ids)	Collection of String ids of un-open rows (all other rows are open implicitly).
protected void	sort()	(Re-)sorts list according to sort info.
protected void	sort(List<?> nodes, List<Object> master)	Sorts list of nodes at a given level, recursively; then adds newly re-positioned nodes back into master Row list with new index.

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, getType, getValue, hasProperty, isReadOnly, isReorderable, isRowAvailable, isTemplateRow, newRow, setArray, setCanTemplateRow, setOnCreateRow, setOnCreateRowExpression, setOnDeleteRow, setOnDeleteRowExpression, setRowId, setRowIdBinding, setRowIdExpression, setRowIndex, setRowType, setSort, setValue, 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, getType, getValue, hasProperty, 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

m_helper

protected TreeContentProviderHelper m_helper

openToDepth

protected int openToDepth

m_roots

protected List<Object> m_roots

List of INode roots.

Constructor Details

NodeTreeContentProvider

public NodeTreeContentProvider()

New tree provider. List of INode roots must be set via setList(java.util.List<?>).

NodeTreeContentProvider

public NodeTreeContentProvider(INode root)

New tree provider backed by single INode root.

Parameters:

root - Single INode root.

NodeTreeContentProvider

public NodeTreeContentProvider(List<?> list)

New tree provider backed by a list of INode roots.

Parameters:

list - List of INode roots.

Method Details

getRootIds

public Iterator<String> getRootIds()

Description copied from interface: ITreeContentProvider

String ids of root rows, in order. Empty iterator (not null) if tree is empty.

Specified by:

getRootIds in interface ITreeContentProvider

getDepth

public int getDepth()

Description copied from interface: ITreeContentProvider

Depth of current row. Zero (0) for root.

Specified by:

getDepth in interface ITreeContentProvider

getParentId

public String getParentId()

Description copied from interface: ITreeContentProvider

Id of parent row. Null for root. Parent depth must be exactly one less than current depth.

Specified by:

getParentId in interface ITreeContentProvider

getChildIds

public Iterator<String> getChildIds()

Description copied from interface: ITreeContentProvider

String ids of child rows, in order. Empty iterator (not null) if row has no children. Child depth must be exactly one more than current depth.

Specified by:

getChildIds in interface ITreeContentProvider

getHasChildren

public boolean getHasChildren()

Description copied from interface: ITreeContentProvider

True if current row has children.

Specified by:

getHasChildren in interface ITreeContentProvider

isFirstChild

public boolean isFirstChild()

Description copied from interface: ITreeContentProvider

True if current row is first child of parent (not whether or not current row is first row in tree). Also true for first root in tree (child with no parent is a root).

Specified by:

isFirstChild in interface ITreeContentProvider

isLastChild

public boolean isLastChild()

Description copied from interface: ITreeContentProvider

True if current row is last child of parent (not whether or not current row is last row in tree). Also true for last root in tree (child with no parent is a root).

Specified by:

isLastChild in interface ITreeContentProvider

getLastChildAncestors

public boolean[] getLastChildAncestors()

Description copied from interface: ITreeContentProvider

ITreeContentProvider.isLastChild() value of ancestors to the current row, from the root to the current row's parent. Zero-length array (non-null) for root.

Specified by:

getLastChildAncestors in interface ITreeContentProvider

isOpen

public boolean isOpen()

Description copied from interface: ITreeContentProvider

True if current row is open.

Specified by:

isOpen in interface ITreeContentProvider

setOpen

public void setOpen(boolean open)

Description copied from interface: ITreeContentProvider

True if current row is open.

Specified by:

setOpen in interface ITreeContentProvider

isVisible

public boolean isVisible()

Description copied from interface: ITreeContentProvider

True if ancestors of current row are all open. Root is always visible.

Specified by:

isVisible in interface ITreeContentProvider

getOpenIds

public Collection<String> getOpenIds()

Description copied from interface: ITreeContentProvider

Collection of String ids of open rows. May be empty or contain non-existent ids; never null, never contains null.

Specified by:

getOpenIds in interface ITreeContentProvider

setOpenIds

public void setOpenIds(Collection<String> ids)

Description copied from interface: ITreeContentProvider

Collection of String ids of open rows. May be empty or contain non-existent ids; never null, never contains null.

Specified by:

setOpenIds in interface ITreeContentProvider

getUseUnopenModel

public boolean getUseUnopenModel()

Description copied from interface: ITreeContentProvider

True if it's more effecient to use the un-open model (ITreeContentProvider.getUnopenIds()) rather than the open model (ITreeContentProvider.getOpenIds()).

Specified by:

getUseUnopenModel in interface ITreeContentProvider

getUnopenIds

public Collection<String> getUnopenIds()

Description copied from interface: ITreeContentProvider

Collection of String ids of un-open rows (all other rows are open implicitly). May be empty or contain non-existent ids; never null, never contains null.

Specified by:

getUnopenIds in interface ITreeContentProvider

setUnopenIds

public void setUnopenIds(Collection<String> ids)

Description copied from interface: ITreeContentProvider

Collection of String ids of un-open rows (all other rows are open implicitly). May be empty or contain non-existent ids; never null, never contains null.

Specified by:

setUnopenIds in interface ITreeContentProvider

getCanTemplateRow

public boolean getCanTemplateRow()

Description copied from interface: IUpdateableTableContentProvider

True if provider can be put into template row state.

Specified by:

getCanTemplateRow in interface IUpdateableTableContentProvider

Overrides:

getCanTemplateRow in class ListTableContentProvider

isRowMixed

public boolean isRowMixed()

Description copied from interface: ISelectableTreeContentProvider

True if row selection state is mixed.

Specified by:

isRowMixed in interface ISelectableTreeContentProvider

getCurrentRow

public Object getCurrentRow()

Description copied from class: SelectableListTableContentProvider

Returns current row. If no row is current, returns first row. If doesn't have first row, returns null.

Specified by:

getCurrentRow in interface ITableContentProvider

Overrides:

getCurrentRow in class SelectableListTableContentProvider

Returns:

row object or null

See Also:

• ITableContentProvider.isRowAvailable()

sort

protected void sort()

Description copied from class: ListTableContentProvider

(Re-)sorts list according to sort info.

Overrides:

sort in class FilterableSelectableListTableContentProvider

See Also:

• ListTableContentProvider.setSort(ISortInfo)

setList

public void setList(List<?> list)

Description copied from class: SelectableListTableContentProvider

Sets a list to wrap

Overrides:

setList in class FilterableSelectableListTableContentProvider

Parameters:

list - a list

calculateRowId

protected String calculateRowId(int index,
 Object data)

Description copied from class: ListTableContentProvider

Calculates row id from the row data object using ListTableContentProvider.getRowIdBinding() expression.

Overrides:

calculateRowId in class ListTableContentProvider

Parameters:

index - row index

data - row data object

Returns:

row id

getCurrentNode

protected INode getCurrentNode()

Returns the current node.

Throws:

IllegalStateException - if no current row

setOpenToDepth

public void setOpenToDepth(int depth)

Sets tree open to the specified depth.

Parameters:

depth - Depth to which to open. 0 = roots, 1 = roots + children, 2 = roots + children + grandchildren of roots, etc.

openTreeNodes

public void openTreeNodes(int depth)

Description copied from interface: ISelectableTreeContentProvider

setOpenToDepth() optimization

Specified by:

openTreeNodes in interface ISelectableTreeContentProvider

getOpenToDepth

public int getOpenToDepth()

Returns:

tree open depth

sort

protected void sort(List<?> nodes,
 List<Object> master)

Sorts list of nodes at a given level, recursively; then adds newly re-positioned nodes back into master Row list with new index.

flatten

protected void flatten(List<?> nodes,
 List<Object> master)

Flattens list of nodes at a given level, recursively.