com.webmethods.caf.faces.component.gmap

Class GMarkerGroupTableContentProvider

java.lang.Object

com.webmethods.caf.faces.component.gmap.GMarkerGroupTableContentProvider

All Implemented Interfaces:

IAddressableTableContentProvider, IContentProvider, ISelectableTableContentProvider, ITableContentProvider, IUpdateableContentProvider, Serializable

public class GMarkerGroupTableContentProvider
extends Object
implements Serializable, IUpdateableContentProvider, ISelectableTableContentProvider

Content provider which exposes the marker controls in a GMarkerGroup as rows in the content provider, so the GMarkerList renderer can be used to render a GMarkerGroup.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<GMarker>	EMPTY_MARKER_LIST
protected String	m_id ID of marker group.
protected int	m_index Current row index.
protected boolean	m_useUnselectedModel Unselected model state.
protected String	m_var Row variable name.

Constructor Summary

Constructors

Constructor and Description
GMarkerGroupTableContentProvider()
GMarkerGroupTableContentProvider(GMarkerGroup group)

Method Summary

Modifier and Type	Method and Description
GMarker	getCurrentMarker() Marker at the current row index or null.
Object	getCurrentRow() Returns wrapped current row object.
GMarkerGroup	getGroup() GMarkerGroup wrapped by this provider.
List<GMarker>	getMarkers() GMarkers in the wrapped GMarkerGroup, or an empty list (never null).
Object[]	getPropertyKeys() Returns list of properties supported by this content provider.
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.
Class<?>	getType(Object propertyKey) Returns java type of the given property
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	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.
void	setGroup(GMarkerGroup group) GMarkerGroup wrapped by this provider.
protected void	setMarkerSelected(FacesContext context, GMarker marker, boolean selected) Selects/unselects the specified marker.
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	setValue(Object propertyKey, Object value) Sets new value of the given property

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 Detail

EMPTY_MARKER_LIST

protected static final List<GMarker> EMPTY_MARKER_LIST

m_id

protected String m_id

ID of marker group.

m_index

protected int m_index

Current row index.

m_var

protected String m_var

Row variable name.

m_useUnselectedModel

protected boolean m_useUnselectedModel

Unselected model state.

Constructor Detail

GMarkerGroupTableContentProvider

public GMarkerGroupTableContentProvider()

GMarkerGroupTableContentProvider

public GMarkerGroupTableContentProvider(GMarkerGroup group)

Method Detail

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

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.isRowAvailable()

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:

DataModel.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:

DataModel.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.setRowVariable(String)

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:

DataModel.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:

DataModel.getRowIndex()

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

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

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.

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

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

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

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

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

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

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.

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

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

getGroup

public GMarkerGroup getGroup()

GMarkerGroup wrapped by this provider.

setGroup

public void setGroup(GMarkerGroup group)

GMarkerGroup wrapped by this provider.

getCurrentMarker

public GMarker getCurrentMarker()

Marker at the current row index or null.

getMarkers

public List<GMarker> getMarkers()

GMarkers in the wrapped GMarkerGroup, or an empty list (never null).

setMarkerSelected

protected void setMarkerSelected(FacesContext context,
                                 GMarker marker,
                                 boolean selected)

Selects/unselects the specified marker.