com.neurosys.reporting.wicket.components

Class Exporters<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.Exporters<RM>

Type Parameters:

RM - as ReporterMeta type

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator

public class Exporters<RM extends ReporterMeta>
extends org.apache.wicket.markup.html.WebMarkupContainer

Component to display all the formating Options based on the ReporterMeta

Author:

Arjun Dhar

See Also:

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

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
Exporters(String id, org.apache.wicket.model.IModel<RM> model, Object[] params)

Method Summary

Modifier and Type	Method and Description
String	constructExportResourceName(RM reporterMeta, ExportType exportType) Create file name as report_report name or Id_datetime.extension
protected Reporter<Object[]>	createProxyReporter(User user, ReporterMeta reporterMeta, ExportType exportType) The Reporter for export may require some modification to Data and headers/Columns due to an override using ExportMeta or Authorizable definitions in the ReporterMeta.getColumnToEntityValueMapping()
protected void	export(User user, ExportType exportType, Map<Integer,Authorizable> authorizableColumns) Export a file as IResourceStreamWriter so it can be downloaded
protected boolean	filter(User user, Authorizable authorizable)
protected boolean	filter(User user, ExportType exportType) By default Filter Authorizable Columns(FacetMeta) that are not meant for current user Filter the EXPORT type option based on Authorization
protected Map<Integer,Authorizable>	getAuthorizableColumns(ReporterMeta reporterMeta) Looks for Authorizable column definitions in values of ReporterMeta.getColumnToEntityValueMapping()
Object[]	getParams() Supply the Reporter additional params, if supported/necessary
void	onInitialize()
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, getStatelessHint, 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

authorizationModule

protected AuthorizationModule<Void> authorizationModule

Constructor Detail

Exporters

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

Method Detail

filter

protected boolean filter(User user,
                         ExportType exportType)

By default Filter Authorizable Columns(FacetMeta) that are not meant for current user
Filter the EXPORT type option based on Authorization

Returns:

false means it will be remove

filter

protected boolean filter(User user,
                         Authorizable authorizable)

export

protected void export(User user,
                      ExportType exportType,
                      Map<Integer,Authorizable> authorizableColumns)

Export a file as IResourceStreamWriter so it can be downloaded

Parameters:

user -

exportType -

authorizableColumns -

onInitialize

public void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

constructExportResourceName

public String constructExportResourceName(RM reporterMeta,
                                          ExportType exportType)

Create file name as report_report name or Id_datetime.extension

Parameters:

reporterMeta - as RM

exportType - as ExportType

Returns:

getAuthorizableColumns

protected Map<Integer,Authorizable> getAuthorizableColumns(ReporterMeta reporterMeta)

Looks for Authorizable column definitions in values of ReporterMeta.getColumnToEntityValueMapping()

Parameters:

reporterMeta -

Returns:

Map of Column Name to Authorizable @nullable true

createProxyReporter

protected Reporter<Object[]> createProxyReporter(User user,
                                                 ReporterMeta reporterMeta,
                                                 ExportType exportType)
                                          throws Exception

The Reporter for export may require some modification to Data and headers/Columns due to an override using ExportMeta or Authorizable definitions in the ReporterMeta.getColumnToEntityValueMapping()

Parameters:

user - as User

reporterMeta - as ReporterMeta

exportType - as ExportType

Returns:

Throws:

Exception

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