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

Class TableTreeContentProvider

java.lang.Object

com.webmethods.caf.faces.bean.PageFlowScopeAdapter

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

All Implemented Interfaces:

IPageFlowScopeAdapter, IAddressableTableContentProvider, IContentProvider, IFilterableTableContentProvider, IRefreshable, IRefreshableContentProvider, ISelectableTableContentProvider, ISortableTableContentProvider, ITableContentProvider, ITransactionalContentProvider, IUpdateableContentProvider, IUpdateableTableContentProvider, ITreeContentProvider

public class TableTreeContentProvider
extends PageFlowScopeAdapter
implements ITreeContentProvider, IRefreshableContentProvider, ISortableTableContentProvider, IFilterableTableContentProvider, ISelectableTableContentProvider, ITransactionalContentProvider, IUpdateableTableContentProvider

Adapts an IAddressableTableContentProvider to an ITreeContentProvider. The table content provider must provide the rows in proper depth-first tree order (contrast this with other tree providers, such as ListTreeContentProvider, which are able to automatically re-order rows into depth-first tree order). For each of the following properties, either the getter method must be overriden, or this instance must be supplied with the corresponding --FieldName property:

• rootIds
• depth
• parentId
• childIds
• hasChildren
• firstChild
• lastChild

This relies on the underlying table content provider to implement any IRefreshableContentProvider, ISortableTableContentProvider, ISelectableTableContentProvider, ITransactionalContentProvider, IFilterableTableContentProvider, or IUpdateableTableContentProvider functionality, if used.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_childIdsFieldName
protected String	m_depthFieldName
protected String	m_firstChildFieldName
protected String	m_hasChildrenFieldName
protected TreeContentProviderHelper	m_helper
protected String	m_lastChildFieldName
protected String	m_parentIdFieldName
protected String	m_rootIdsFieldName
protected IAddressableTableContentProvider	m_table

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

fExpireWithPageFlow

Constructor Summary

Constructors

Constructor	Description
TableTreeContentProvider()	Default constructor which doesn't do any intialization.
TableTreeContentProvider(IAddressableTableContentProvider table)	Construct new instance and initialize table.
TableTreeContentProvider(IAddressableTableContentProvider table, String rootIdsFieldName, String depthFieldName, String parentIdFieldName, String childIdsFieldName, String hasChildrenFieldName, String firstChildFieldName, String lastChildFieldName)	Construct new instance and initialize instance variables.

Method Summary

Modifier and Type	Method	Description
void	applyChanges()	Commits changes back to the data source.
void	cancelChanges()	Reverts all changes made since the last ITransactionalContentProvider.applyChanges() call.
void	createRow()	Appends the template row to the table data.
void	deleteRow()	Deletes currently positioned row
boolean	getCanTemplateRow()	True if provider can be put into template row state.
Iterator<String>	getChildIds()	String ids of child rows, in order.
String	getChildIdsFieldName()
Object	getCurrentRow()	Returns wrapped current row object.
int	getDepth()	Depth of current row.
String	getDepthFieldName()
String	getFilter()	Filter expression.
String	getFirstChildFieldName()
boolean	getHasChildren()	True if current row has children.
String	getHasChildrenFieldName()
boolean[]	getLastChildAncestors()	ITreeContentProvider.isLastChild() value of ancestors to the current row, from the root to the current row's parent.
String	getLastChildFieldName()
boolean	getNeedRefresh()	Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.
Collection<String>	getOpenIds()	Collection of String ids of open rows.
String	getParentId()	Id of parent row.
String	getParentIdFieldName()
Object[]	getPropertyKeys()	Returns list of properties supported by this content provider.
Iterator<String>	getRootIds()	String ids of root rows, in order.
String	getRootIdsFieldName()
int	getRowCount()	Return the number of rows of data objects represented by this DataModel.
String	getRowId()	Returns unique identifier for the current row.
int	getRowIndex()	Return the zero-relative index of the currently selected row.
int	getRowSelectedCount()	Returns number of selected rows.
Collection<String>	getRowSelectedIds()	Returns collection of String ids of the selected rows.
Collection<String>	getRowUnselectedIds()	Returns collection of String ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.
String	getRowVariable()	Returns row variable name.
ISortInfo	getSort()	Returns current sort info.
IAddressableTableContentProvider	getTable()
Class<?>	getType(Object propertyKey)	Returns java type of the given property
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	getUseUnselectedModel()	Returns true if it's more effecient to use unselected model (ie ISelectableTableContentProvider.getRowUnselectedIds() rather than ISelectableTableContentProvider.getRowSelectedIds()).
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	isAddressable()	Checks if this content provider truly is addressable.
boolean	isAutoRefresh()	Returns true if the provider is currenlty in auto-refresh mode
boolean	isFilterable()	True if this provider truely is filterable.
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	isReadOnly(Object propertyKey)	Returns true if the given property is readonly.
boolean	isRowAvailable()	Return a flag indicating whether there is rowData available at the current rowIndex.
boolean	isRowSelected()	Returns true if current row is selected.
boolean	isTemplateRow()	Is provider in state where it returns properties for template pseudo-row.
boolean	isVisible()	True if ancestors of current row are all open.
void	refresh()	(Re)loads data from the data source.
void	setAutoRefresh(boolean autorefresh)	Sets auto refresh mode on.
void	setCanTemplateRow(boolean value)	True if provider can be put into template row state.
void	setChildIdsFieldName(String childIdsFieldName)
void	setCurrentRow(Object row)	Sets new current row object
void	setDepthFieldName(String depthFieldName)
void	setFilter(String filter)	Filter expression.
void	setFirstChildFieldName(String firstChildFieldName)
void	setHasChildrenFieldName(String hasChildrenFieldName)
void	setLastChildFieldName(String lastChildFieldName)
void	setNeedRefresh(boolean needRefresh)	Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).
void	setOpen(boolean open)	True if current row is open.
void	setOpenIds(Collection<String> ids)	Collection of String ids of open rows.
void	setParentIdFieldName(String parentIdFieldName)
void	setRootIdsFieldName(String rootIdsFieldName)
void	setRowById(String id)	Selects current row by its id.
void	setRowIndex(int rowIndex)	Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.
void	setRowSelected(boolean selected)	Sets the selection status for the current row.
void	setRowSelectedIds(Collection ids)	Sets new selection using a collection of String ids of the rows to select.
void	setRowUnselectedIds(Collection ids)	Unselects rows using a collection of String ids of the un-selected rows (all other rows are selected implicitly).
void	setRowVariable(String var)	Sets row variable name to use for accessing row specific data.
void	setSort(ISortInfo sort)	Sets new sort info, re-sorting the table (if necessary).
void	setTable(IAddressableTableContentProvider table)
void	setTemplateRow()	Sets provider to state where it returns properties for template pseudo-row.
void	setUnopenIds(Collection<String> ids)	Collection of String ids of un-open rows (all other rows are open implicitly).
void	setValue(Object propertyKey, Object value)	Sets new value of the given property
boolean	supportsAutoRefresh()	Returns true if this content provider supports auto refresh feature.

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, toString, wait, wait, wait

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

toString

Field Details

m_table

protected IAddressableTableContentProvider m_table

m_helper

protected TreeContentProviderHelper m_helper

m_rootIdsFieldName

protected String m_rootIdsFieldName

m_depthFieldName

protected String m_depthFieldName

m_parentIdFieldName

protected String m_parentIdFieldName

m_childIdsFieldName

protected String m_childIdsFieldName

m_hasChildrenFieldName

protected String m_hasChildrenFieldName

m_firstChildFieldName

protected String m_firstChildFieldName

m_lastChildFieldName

protected String m_lastChildFieldName

Constructor Details

TableTreeContentProvider

public TableTreeContentProvider()

Default constructor which doesn't do any intialization.

TableTreeContentProvider

public TableTreeContentProvider(IAddressableTableContentProvider table)

Construct new instance and initialize table.

Parameters:

table -

TableTreeContentProvider

public TableTreeContentProvider(IAddressableTableContentProvider table,
 String rootIdsFieldName,
 String depthFieldName,
 String parentIdFieldName,
 String childIdsFieldName,
 String hasChildrenFieldName,
 String firstChildFieldName,
 String lastChildFieldName)

Construct new instance and initialize instance variables.

Parameters:

table -

rootIdsFieldName -

depthFieldName -

parentIdFieldName -

childIdsFieldName -

hasChildrenFieldName -

firstChildFieldName -

lastChildFieldName -

Method Details

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

applyChanges

public void applyChanges()
                  throws ContentProviderException

Description copied from interface: ITransactionalContentProvider

Commits changes back to the data source.

Specified by:

applyChanges in interface ITransactionalContentProvider

Throws:

ContentProviderException - if error happens during commit

cancelChanges

public void cancelChanges()
                   throws ContentProviderException

Description copied from interface: ITransactionalContentProvider

Reverts all changes made since the last ITransactionalContentProvider.applyChanges() call.

Specified by:

cancelChanges in interface ITransactionalContentProvider

Throws:

ContentProviderException

isAutoRefresh

public boolean isAutoRefresh()

Description copied from interface: IRefreshable

Returns true if the provider is currenlty in auto-refresh mode

Specified by:

isAutoRefresh in interface IRefreshable

Returns:

false if auto-refresh mode is off or not supported

getNeedRefresh

public boolean getNeedRefresh()

Description copied from interface: IRefreshable

Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.

Implementations may return an accurate value from this method if they can track the changes to the input parameter properties or they may require the clients to call IRefreshable.setNeedRefresh(boolean) explicitely.

Specified by:

getNeedRefresh in interface IRefreshable

Returns:

true when the output properties are not up-to-date with the current input parameters, i.e. IRefreshable.refresh() needs to be executed manually or automatically.

setNeedRefresh

public void setNeedRefresh(boolean needRefresh)

Description copied from interface: IRefreshable

Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).

Specified by:

setNeedRefresh in interface IRefreshable

Parameters:

needRefresh - true if the input parameters have changed

refresh

public void refresh()
             throws ContentProviderException

Description copied from interface: IRefreshable

(Re)loads data from the data source. Implementation specific meaning can be executing a SQL query or a web service call. All current data will be lost and updated with the new results if successful.

Specified by:

refresh in interface IRefreshable

Throws:

ContentProviderException - if error loading data from the data source

setAutoRefresh

public void setAutoRefresh(boolean autorefresh)
                    throws ContentProviderException

Description copied from interface: IRefreshable

Sets auto refresh mode on. When auto refresh mode is on, the provider calls IRefreshable.getNeedRefresh() to determine whether the refresh needs to be done before returning any result properties. If it returns true, the provider calls IRefreshable.refresh() method to updated the result properties.

Specified by:

setAutoRefresh in interface IRefreshable

Parameters:

autorefresh - true to turn it on

Throws:

ContentProviderException - if auto refresh mode is not supported

See Also:

• IRefreshable.supportsAutoRefresh()
• IRefreshable.getNeedRefresh()
• IRefreshable.setNeedRefresh(boolean)

supportsAutoRefresh

public boolean supportsAutoRefresh()

Description copied from interface: IRefreshable

Returns true if this content provider supports auto refresh feature.

Specified by:

supportsAutoRefresh in interface IRefreshable

Returns:

true when auto refresh is supported

See Also:

• IRefreshable.setAutoRefresh(boolean)

getRowCount

public int getRowCount()

Description copied from interface: ITableContentProvider

Return the number of rows of data objects represented by this DataModel.

Return -1, if the number of rows is unknown, or no wrappedData is available.

Specified by:

getRowCount in interface ITableContentProvider

See Also:

• ITableContentProvider.getRowCount()

getRowIndex

public int getRowIndex()

Description copied from interface: ITableContentProvider

Return the zero-relative index of the currently selected row.

If we are not currently positioned on a row, or no wrappedData is available, return -1.

Specified by:

getRowIndex in interface ITableContentProvider

See Also:

• ITableContentProvider.getRowIndex()

getRowVariable

public String getRowVariable()

Description copied from interface: ITableContentProvider

Returns row variable name.

If specified row variable can be used to access current row data for the provider internal needs, like sorting or addressing.

Specified by:

getRowVariable in interface ITableContentProvider

Returns:

row variable name or null if not specified

See Also:

• ITableContentProvider.getRowVariable()

isRowAvailable

public boolean isRowAvailable()

Description copied from interface: ITableContentProvider

Return a flag indicating whether there is rowData available at the current rowIndex. If no wrappedData is available, return false.

Specified by:

isRowAvailable in interface ITableContentProvider

See Also:

• ITableContentProvider.isRowAvailable()

setRowIndex

public void setRowIndex(int rowIndex)

Description copied from interface: ITableContentProvider

Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.

Specified by:

setRowIndex in interface ITableContentProvider

See Also:

• ITableContentProvider.setRowIndex(int)

setRowVariable

public void setRowVariable(String var)

Description copied from interface: ITableContentProvider

Sets row variable name to use for accessing row specific data. For example, if the provider wrapps an array of a data objects with id property and the variable name is item, then the provider implementation can access id property of each record as item.id.

This property should set only once at the provider initialization time

Specified by:

setRowVariable in interface ITableContentProvider

See Also:

• ITableContentProvider.setRowVariable(String)

getCurrentRow

public Object getCurrentRow()

Description copied from interface: ITableContentProvider

Returns wrapped current row object. Can be null if not data is available

Specified by:

getCurrentRow in interface ITableContentProvider

Returns:

current row object

See Also:

• ITableContentProvider.getCurrentRow()

isAddressable

public boolean isAddressable()

Description copied from interface: IAddressableTableContentProvider

Checks if this content provider truly is addressable.

Specified by:

isAddressable in interface IAddressableTableContentProvider

Returns:

true if addressable.

See Also:

• IAddressableTableContentProvider.isAddressable()

getRowId

public String getRowId()

Description copied from interface: IAddressableTableContentProvider

Returns unique identifier for the current row. If no current row is avaiable, returns null.

Specified by:

getRowId in interface IAddressableTableContentProvider

Returns:

current row id or null

See Also:

• IAddressableTableContentProvider.getRowId()

setRowById

public void setRowById(String id)

Description copied from interface: IAddressableTableContentProvider

Selects current row by its id. If id doesn't identify a row, makes no row current (equivalent to setRowIndex(-1)).

Specified by:

setRowById in interface IAddressableTableContentProvider

Parameters:

id - row id to find and make current

See Also:

• IAddressableTableContentProvider.setRowById(String)

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

See Also:

• IUpdateableTableContentProvider.getCanTemplateRow()

setCanTemplateRow

public void setCanTemplateRow(boolean value)

Description copied from interface: IUpdateableTableContentProvider

True if provider can be put into template row state. Default: true

Specified by:

setCanTemplateRow in interface IUpdateableTableContentProvider

See Also:

• IUpdateableTableContentProvider.setCanTemplateRow(boolean)

isTemplateRow

public boolean isTemplateRow()

Description copied from interface: IUpdateableTableContentProvider

Is provider in state where it returns properties for template pseudo-row. In this state, row index is -1 and row id is null; ITableContentProvider.isRowAvailable() returns false. Setting the row index or id to any value removes provider from this state.

Specified by:

isTemplateRow in interface IUpdateableTableContentProvider

See Also:

• IUpdateableTableContentProvider.isTemplateRow()

setTemplateRow

public void setTemplateRow()

Description copied from interface: IUpdateableTableContentProvider

Sets provider to state where it returns properties for template pseudo-row. In this state, row index is -1 and row id is null; ITableContentProvider.isRowAvailable() returns false. Setting the row index or id to any value removes provider from this state.

Specified by:

setTemplateRow in interface IUpdateableTableContentProvider

See Also:

• IUpdateableTableContentProvider.setTemplateRow()

setCurrentRow

public void setCurrentRow(Object row)

Description copied from interface: IUpdateableTableContentProvider

Sets new current row object

Specified by:

setCurrentRow in interface IUpdateableTableContentProvider

Parameters:

row - new row object to replace object returned by ITableContentProvider.getCurrentRow()

See Also:

• IUpdateableTableContentProvider.setCurrentRow(Object)

createRow

public void createRow()
               throws ContentProviderException

Description copied from interface: IUpdateableTableContentProvider

Appends the template row to the table data.

Specified by:

createRow in interface IUpdateableTableContentProvider

Throws:

ContentProviderException - if error happens during creation

See Also:

• IUpdateableTableContentProvider.createRow()

deleteRow

public void deleteRow()
               throws ContentProviderException

Description copied from interface: IUpdateableTableContentProvider

Deletes currently positioned row

Specified by:

deleteRow in interface IUpdateableTableContentProvider

Throws:

ContentProviderException - if error happens during deletion

See Also:

• IUpdateableTableContentProvider.deleteRow()

getSort

public ISortInfo getSort()

Description copied from interface: ISortableTableContentProvider

Returns current sort info. Never null.

Specified by:

getSort in interface ISortableTableContentProvider

Returns:

currenly set sort info

See Also:

• ISortableTableContentProvider.getSort()

setSort

public void setSort(ISortInfo sort)

Description copied from interface: ISortableTableContentProvider

Sets new sort info, re-sorting the table (if necessary). This does not change the model's rowIndex property, even though it will probably now point to a different row.

Specified by:

setSort in interface ISortableTableContentProvider

Parameters:

sort - Sort info, must not be null.

See Also:

• ISortableTableContentProvider.setSort(ISortInfo)

getRowSelectedCount

public int getRowSelectedCount()

Description copied from interface: ISelectableTableContentProvider

Returns number of selected rows.

Specified by:

getRowSelectedCount in interface ISelectableTableContentProvider

Returns:

number of currently selection rows

See Also:

• ISelectableTableContentProvider.getRowSelectedCount()

getRowSelectedIds

public Collection<String> getRowSelectedIds()

Description copied from interface: ISelectableTableContentProvider

Returns collection of String ids of the selected rows. May be empty or contain non-existent ids; never null, never contains null.

Specified by:

getRowSelectedIds in interface ISelectableTableContentProvider

Returns:

collection of ids of selected rows

See Also:

• ISelectableTableContentProvider.getRowSelectedIds()

getRowUnselectedIds

public Collection<String> getRowUnselectedIds()

Description copied from interface: ISelectableTableContentProvider

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

Specified by:

getRowUnselectedIds in interface ISelectableTableContentProvider

Returns:

collection of ids of the un-selection rows

See Also:

• ISelectableTableContentProvider.getRowUnselectedIds()

getUseUnselectedModel

public boolean getUseUnselectedModel()

Description copied from interface: ISelectableTableContentProvider

Returns true if it's more effecient to use unselected model (ie ISelectableTableContentProvider.getRowUnselectedIds() rather than ISelectableTableContentProvider.getRowSelectedIds()).

Specified by:

getUseUnselectedModel in interface ISelectableTableContentProvider

Returns:

true if it's more effecient to use unselected model

See Also:

• ISelectableTableContentProvider.getUseUnselectedModel()

isRowSelected

public boolean isRowSelected()

Description copied from interface: ISelectableTableContentProvider

Returns true if current row is selected.

Specified by:

isRowSelected in interface ISelectableTableContentProvider

Returns:

true if current row is selection

See Also:

• ISelectableTableContentProvider.isRowSelected()

setRowSelected

public void setRowSelected(boolean selected)

Description copied from interface: ISelectableTableContentProvider

Sets the selection status for the current row.

Specified by:

setRowSelected in interface ISelectableTableContentProvider

Parameters:

selected - true to select current row; false to unselect.

See Also:

• ISelectableTableContentProvider.setRowSelected(boolean)

setRowSelectedIds

public void setRowSelectedIds(Collection ids)

Description copied from interface: ISelectableTableContentProvider

Sets new selection using a collection of String ids of the rows to select. May be empty or contain non-existent ids; never null, never contains null.

Specified by:

setRowSelectedIds in interface ISelectableTableContentProvider

Parameters:

ids - the collection of String row ids

See Also:

• ISelectableTableContentProvider.setRowSelectedIds(Collection)

setRowUnselectedIds

public void setRowUnselectedIds(Collection ids)

Description copied from interface: ISelectableTableContentProvider

Unselects rows using a collection of String ids of the un-selected rows (all other rows are selected implicitly). May be empty or contain non-existent ids; never null, never contains null.

Specified by:

setRowUnselectedIds in interface ISelectableTableContentProvider

Parameters:

ids - collection of String row ids

See Also:

• ISelectableTableContentProvider.setRowUnselectedIds(Collection)

isFilterable

public boolean isFilterable()

Description copied from interface: IFilterableTableContentProvider

True if this provider truely is filterable.

Specified by:

isFilterable in interface IFilterableTableContentProvider

getFilter

public String getFilter()

Description copied from interface: IFilterableTableContentProvider

Filter expression. Only rows matched by this filter should be exposed. Null or empty ("") signals expose the default set of rows.

Specified by:

getFilter in interface IFilterableTableContentProvider

setFilter

public void setFilter(String filter)

Description copied from interface: IFilterableTableContentProvider

Filter expression. Only rows matched by this filter should be exposed. Null or empty ("") signals expose the default set of rows.

Specified by:

setFilter in interface IFilterableTableContentProvider

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

getTable

public IAddressableTableContentProvider getTable()

setTable

public void setTable(IAddressableTableContentProvider table)

getRootIdsFieldName

public String getRootIdsFieldName()

setRootIdsFieldName

public void setRootIdsFieldName(String rootIdsFieldName)

getChildIdsFieldName

public String getChildIdsFieldName()

setChildIdsFieldName

public void setChildIdsFieldName(String childIdsFieldName)

getDepthFieldName

public String getDepthFieldName()

setDepthFieldName

public void setDepthFieldName(String depthFieldName)

getFirstChildFieldName

public String getFirstChildFieldName()

setFirstChildFieldName

public void setFirstChildFieldName(String firstChildFieldName)

getHasChildrenFieldName

public String getHasChildrenFieldName()

setHasChildrenFieldName

public void setHasChildrenFieldName(String hasChildrenFieldName)

getLastChildFieldName

public String getLastChildFieldName()

setLastChildFieldName

public void setLastChildFieldName(String lastChildFieldName)

getParentIdFieldName

public String getParentIdFieldName()

setParentIdFieldName

public void setParentIdFieldName(String parentIdFieldName)