org.richfaces.model
Class TreeDataModel

java.lang.Object
  javax.faces.model.DataModel
      org.ajax4jsf.model.ExtendedDataModel
          org.richfaces.model.AbstractTreeDataModel
              org.richfaces.model.TreeDataModel

public class TreeDataModel
extends AbstractTreeDataModel

That is intended for internal use

Author:

Nick Belaevski - nbelaevski@exadel.com created 16.11.2006

Field Summary

Fields inherited from class org.richfaces.model.AbstractTreeDataModel

SEPARATOR

Constructor Summary

TreeDataModel()

Method Summary

protected void	doWalk(javax.faces.context.FacesContext context, DataVisitor dataVisitor, Range range, java.lang.Object rowKey, java.lang.Object argument, boolean last)
java.lang.Object	getRowData()
java.lang.Object	getRowKey()
TreeNode	getTreeNode()
boolean	isLeaf() returns whether this node is leaf
boolean	isRowAvailable()
TreeNode	locateTreeNode(TreeRowKey rowKey)
TreeNode	locateTreeNode(TreeRowKey rowKey, boolean allowCreate)
void	setRowKey(java.lang.Object rowKey) Instead of simple int for current state selection, this model can use any object for select current data.
void	walk(javax.faces.context.FacesContext context, DataVisitor dataVisitor, Range range, java.lang.Object rowKey, java.lang.Object argument, boolean last) walk sub-model having row key argument as its root
void	walkModel(javax.faces.context.FacesContext context, DataVisitor visitor, Range range, java.lang.Object key, java.lang.Object argument, boolean last) Walk backing sub-model having row key argument as its root.

Methods inherited from class org.richfaces.model.AbstractTreeDataModel

getRowCount, getRowIndex, getWrappedData, processElement, setRowIndex, setWrappedData, walk

Methods inherited from class org.ajax4jsf.model.ExtendedDataModel

getSerializableModel

Methods inherited from class javax.faces.model.DataModel

addDataModelListener, getDataModelListeners, removeDataModelListener

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeDataModel

public TreeDataModel()

Method Detail

getRowKey

public java.lang.Object getRowKey()

Specified by:

getRowKey in class ExtendedDataModel

Returns:

key for selected data or null

setRowKey

public void setRowKey(java.lang.Object rowKey)

Description copied from class: ExtendedDataModel

Instead of simple int for current state selection, this model can use any object for select current data. Implementation depend on model, with any restrictions :

1. key must be Serializable.
2. Object.toString() method must return representation compatible with UIComponent.getClientId(javax.faces.context.FacesContext), as far as this string will be appended to clientId of iterator component.

Specified by:

setRowKey in class ExtendedDataModel

Parameters:

rowKey - key for select current data, or null for clear selection.

doWalk

protected void doWalk(javax.faces.context.FacesContext context,
                      DataVisitor dataVisitor,
                      Range range,
                      java.lang.Object rowKey,
                      java.lang.Object argument,
                      boolean last)
               throws java.io.IOException

Throws:

java.io.IOException

walk

public void walk(javax.faces.context.FacesContext context,
                 DataVisitor dataVisitor,
                 Range range,
                 java.lang.Object rowKey,
                 java.lang.Object argument,
                 boolean last)
          throws java.io.IOException

Description copied from class: AbstractTreeDataModel

walk sub-model having row key argument as its root

Specified by:

walk in class AbstractTreeDataModel

Parameters:

context - faces context

dataVisitor - org.ajax4jsf.ajax.repeat.UIDataAdaptor.ComponentVisitor

range - TreeRange to constraint the walk

rowKey - row key to treat as root of sub-model

argument - implementation specific argument

last - boolean flag indicating whether we started our walk from last element

Throws:

java.io.IOException

See Also:

ExtendedDataModel#walk(FacesContext, DataVisitor, Range, Object)}

locateTreeNode

public TreeNode locateTreeNode(TreeRowKey rowKey)

locateTreeNode

public TreeNode locateTreeNode(TreeRowKey rowKey,
                               boolean allowCreate)

isRowAvailable

public boolean isRowAvailable()

Specified by:

isRowAvailable in class javax.faces.model.DataModel

getRowData

public java.lang.Object getRowData()

Specified by:

getRowData in class javax.faces.model.DataModel

isLeaf

public boolean isLeaf()

Description copied from class: AbstractTreeDataModel

returns whether this node is leaf

Specified by:

isLeaf in class AbstractTreeDataModel

Returns:

walkModel

public void walkModel(javax.faces.context.FacesContext context,
                      DataVisitor visitor,
                      Range range,
                      java.lang.Object key,
                      java.lang.Object argument,
                      boolean last)
               throws java.io.IOException

Description copied from class: AbstractTreeDataModel

Walk backing sub-model having row key argument as its root. If there is no backing model configured, calling this method is equivalent to calling AbstractTreeDataModel.walk(FacesContext, DataVisitor, Range, Object, Object, boolean)

Specified by:

walkModel in class AbstractTreeDataModel

Parameters:

context - faces context

visitor - org.ajax4jsf.ajax.repeat.UIDataAdaptor.ComponentVisitor instance

range - Range to constraint the walk

key - row key to treat as root of sub-model

argument - implementation-specific argument

Throws:

java.io.IOException

See Also:

#walk(FacesContext, DataVisitor, Range, TreeRowKey, Object, boolean)}

getTreeNode

public TreeNode getTreeNode()

Specified by:

getTreeNode in class AbstractTreeDataModel