com.neurosys.reporting.wicket.components

Class ReportResult<T extends Serializable,RM extends ReporterMeta>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.neurosys.reporting.wicket.components.ReportResult<T,RM>

Type Parameters:

T - as Report row Record type

RM - as ReporterMeta type

All Implemented Interfaces:

ChangeListener<Object[]>, Serializable, EventListener, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator

Direct Known Subclasses:

PoppableReportResult

public class ReportResult<T extends Serializable,RM extends ReporterMeta>
extends org.apache.wicket.markup.html.WebMarkupContainer
implements ChangeListener<Object[]>

Any listing for a report, also supports custom Bulk action buttons on report result items.

Author:

Arjun Dhar

See Also:

TODO: All markups using this have the same HTML, consider making this a Panel ?!, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizationModule<Void>	authorizationModule
protected Object[]	params
protected static org.slf4j.Logger	secirityLog

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
ReportResult(String id) Report definition ReporterMeta, passed on dynamically after construction
ReportResult(String id, org.apache.wicket.model.IModel<RM> model, Object[] params) Report definition ReporterMeta, provided @ construction time.

Method Summary

Modifier and Type	Method and Description
protected List<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<?>>	defineColumns(RM reporterMeta) It will use ReporterMeta.getReporter().Reporter.getColumnNames() to define all the Columns in the report.
protected org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider	defineReportDataProvider() Add ability to Sort on the Report by overriding the SortableDataProvider and customizing it Assumes Reporter is DataSourceReporter using a JPAQueryTransformer
protected boolean	filter(User user, FacetMeta facetMeta) By default Filter Authorizable Columns(FacetMeta) that are not meant for current user
protected org.apache.wicket.Component	getComponentForCell(String componentId, Object value, Object record, int colIndex, String fieldName, RM reporterMeta) By default converts every cell data into a Label
org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable	getDataPanel() Access the DataTable directly
Object[]	getParams() Supply the Reporter additional params, if supported/necessary
protected boolean	getStatelessHint()
void	onChange(ChangeGenerator<Object[]> changeGenerator, Object[] params)
void	onInitialize()
protected void	populateBulkButtonItem(org.apache.wicket.model.IModel<Collection<Long>> selectedList, org.apache.wicket.markup.html.list.ListItem<FacetMeta> item) Bulk buttons override option for more cool buttons.
protected Object	secure(Object value, String fieldName) Data may come from anywhere, including user interfaces.
void	setParams(Object[] params) Supply the Reporter additional params, if supported/necessary

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Field Detail

secirityLog

protected static org.slf4j.Logger secirityLog

params

protected transient Object[] params

authorizationModule

protected AuthorizationModule<Void> authorizationModule

Constructor Detail

ReportResult

public ReportResult(String id)

Report definition ReporterMeta, passed on dynamically after construction

See Also:

ReportingAdmin

ReportResult

public ReportResult(String id,
                    org.apache.wicket.model.IModel<RM> model,
                    Object[] params)

Report definition ReporterMeta, provided @ construction time.

Method Detail

filter

protected boolean filter(User user,
                         FacetMeta facetMeta)

By default Filter Authorizable Columns(FacetMeta) that are not meant for current user

Returns:

false means it will be remove

getDataPanel

public org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable getDataPanel()

Access the DataTable directly

Returns:

onInitialize

public void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

defineReportDataProvider

protected org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider defineReportDataProvider()

Add ability to Sort on the Report by overriding the SortableDataProvider and customizing it
Assumes Reporter is DataSourceReporter using a JPAQueryTransformer

defineColumns

protected List<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<?>> defineColumns(RM reporterMeta)

It will use ReporterMeta.getReporter().Reporter.getColumnNames() to define all the Columns in the report.

Sorting: If a ReporterMeta#getColumnToEntityNameMapping() is defined, it will use that to drive the original entity field to associate with. This can be used for more control over the Grid, like sorting that will require one to know the field it is associated/data-source.

Grid Cell: Defined by #getComponentForCell(String, Object, Object, int, ReporterMeta)

Authorization: In the ReporterMeta.getColumnToEntityValueMapping() the Mapping of AuthorizableFacetMeta will apply Authorization on that column

populateBulkButtonItem

protected void populateBulkButtonItem(org.apache.wicket.model.IModel<Collection<Long>> selectedList,
                                      org.apache.wicket.markup.html.list.ListItem<FacetMeta> item)

Bulk buttons override option for more cool buttons. All buttons are passed the selectedList model. By default the selectedList is passed to the FacetMeta.getSubmitTransformer() and the result is synchronously returned/added as String in the listing FeedbackPanel.

Parameters:

selectedList - as List of selected items in the Listing

item - as ListItem for FacetMeta type

getComponentForCell

protected org.apache.wicket.Component getComponentForCell(String componentId,
                                                          Object value,
                                                          Object record,
                                                          int colIndex,
                                                          String fieldName,
                                                          RM reporterMeta)

By default converts every cell data into a Label

Parameters:

componentId - as String, passed Id for component from the Container like a Data grid

value - as Object of the cell

record - as Object, defining the row as a List, Array or any Entity

colIndex - as int

fieldName - as String (Name of the field if its an entity or ColIndex is not)

reporterMeta - as

Returns:

Component

secure

protected Object secure(Object value,
                        String fieldName)
                 throws SecurityException

Data may come from anywhere, including user interfaces. This makes it prone to CSRF and XSS kind of attacks.
Ensure the data to be rendered is safe for Web display.
By default it employs some basic testing, but for more advanced checks one can override and employ for example ESAPI , OWASP Anti-Samy toolkit

Parameters:

value - as Object

fieldName - as String (provided for any conditional checks; optional). Its advised that all checks be on all data without exceptions.

Returns:

Object (Sanitized value Object) or throw a SecurityException if not interested in Sanitizing

Throws:

SecurityException

getStatelessHint

protected boolean getStatelessHint()

Overrides:

getStatelessHint in class org.apache.wicket.Component

getParams

public Object[] getParams()

Supply the Reporter additional params, if supported/necessary

Returns:

setParams

public void setParams(Object[] params)

Supply the Reporter additional params, if supported/necessary

onChange

public void onChange(ChangeGenerator<Object[]> changeGenerator,
                     Object[] params)

Specified by:

onChange in interface ChangeListener<Object[]>

Parameters:

changeGenerator - as the generator that caused the change. Specially useful if the Listener is subscribing to multiple ChangeGenerators

params - as the model change communicated