com.neurosys.template.wicket.components

Class EntityDetailsTemplatePanel<T extends Serializable>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup

org.apache.wicket.markup.html.panel.Panel

com.neurosys.content.wicket.pages.panel.TemplatePanel<T,M>

com.neurosys.content.wicket.pages.panel.ListViewTemplatePanel<EntityTemplate<TemplatePanel>,T>

com.neurosys.template.wicket.components.EntityDetailsTemplatePanel<T>

All Implemented Interfaces:

ContentPanel, CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>, Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderPartContainerProvider

Direct Known Subclasses:

CollectionTypesTemplatePanel, ContentDetailsTemplatePanel, CustomerDetailsTemplatePanel, DeliveryDetailsTemplatePanel, DynamicConfigTemplatePanel, ETLInputTemplatePanel, OrderDetailsTemplatePanel, ProductSearchInputTemplatePanel, PromotionDetailsTemplatePanel, ReporterInputTemplatePanel, UserAttributesDetailsTemplatePanel, UserPropertiesDetailsTemplatePanel, VisitorDetailsTemplatePanel

public class EntityDetailsTemplatePanel<T extends Serializable>
extends ListViewTemplatePanel<EntityTemplate<TemplatePanel>,T>
implements CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>

Represents the dynamically generated Panel for ENTITY . Renders its attributes and params dynamically.
Also caches components it adds, to retain their state across refresh. See cachedComponents.

Author:

Arjun Dhar TODO: Review this class code, was copied and modified from Product Details Panel. It may have redundant elements + Add Unit Test case

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

Nested classes/interfaces inherited from interface com.neurosys.template.model.CustomTemplateRenderAdapter

CustomTemplateRenderAdapter.Nothing

Field Summary

Fields

Modifier and Type	Field and Description
static String	ON_SAVE_EnsureAccessorExistsTransformer The FacetMeta Requires a EnsureAccessorExistsTransformer to be called on save(Serializable, MetaItem, Object) The value of this attribute is expected to be either a EnsureAccessorExistsTransformer or a Boolean value.

Fields inherited from class com.neurosys.content.wicket.pages.panel.ListViewTemplatePanel

authorizationModule

Fields inherited from class com.neurosys.content.wicket.pages.panel.TemplatePanel

template

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

Fields inherited from interface com.neurosys.template.model.CustomTemplateRenderAdapter

nothing

Constructor Summary

Constructors

Constructor and Description
EntityDetailsTemplatePanel(String id, org.apache.wicket.model.IModel<T> model, EntityTemplate template, CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer> defaultRenderAdapter)

Method Summary

Modifier and Type	Method and Description
protected Object	extractFieldValue(Object rawValue, MetaItem metaItemObject) Converts different type of model field values to a model that is sent to the display
protected String	getAddToCollectionSectionName(MetaItem metaItemObject) The add section which should have a minimum of one "addOption" component can be customized for different scenarios; by type or field name etc.
org.apache.wicket.Component	getComponentForType(MetaItem metaItem, String fieldComponentName, org.apache.wicket.model.IModel model, org.apache.wicket.MarkupContainer container, T modelObject, User user)
protected org.apache.wicket.Component[]	getComponents(T modelObject, org.apache.wicket.markup.html.list.ListItem<MetaItem> item) Main rendering method; adds components to the container
protected Collection<org.apache.wicket.Component>	getComponentsForCollectionType(T modelObject, MetaItem metaItem, org.apache.wicket.MarkupContainer container)
protected Collection<org.apache.wicket.Component>	getComponentsForType(T modelObject, MetaItem metaItem, org.apache.wicket.model.IModel model, org.apache.wicket.MarkupContainer container)
<C extends org.apache.wicket.Component> List<C>	getDataRelatedComponents(Class<C> type) All elements added to the dynamic panel maybe added within wrapper elements and nested hierarchies.
String	getItemRefId(MetaItem metaItem) When rendering Items, for Feedback we may want to target messages to sections in the form.
protected List	getListForCollectionType(T modelObject, MetaItem metaItem) Get a List to represent the Collection of values to presented to the UI by #getComponentsForCollectionType(Entity, com.neurosys.content.wicket.pages.panel.TemplatePanel.MetaItem, MarkupContainer)
protected org.apache.wicket.model.IModel	getModelForFieldOrAttribute(T modelObject, MetaItem metaItem) get the value from the Field or Attributes.
Map<String,String>	getResourcePaths()
FileUploadWrapper	getResourceUploader()
protected boolean	getStatelessHint()
protected boolean	isSetValueInSameModel(FacetMeta facetMeta, Object value) While saving if the value should be set back in the same model passed by the Entity (like CompoundPropertyModel or assigned a new Model Also a FacetMeta an explicitly opt-out of being part of CompoundPropertyModel by setting FacetMeta.setAssignIndependentModel(Boolean) to false.
protected List	mergeCollections(List existingValues, List newValues) Algorithm to merge Lists of existing values and new values.
protected void	onBeforeRender()
void	onInitialize()
Object	processItem(T modelObject, MetaItem metaItem, org.apache.wicket.Component coreEntityDataField, User user, Object... contextParams) For each meta item handle processing on submit and derive the value to be submitted/persisted back
T	processSubmit(T entity, org.apache.wicket.markup.html.form.Form<T> form) Intended for processing of the part of the data thats generated by this panel only. Elements belonging to this panel must update the modelObject based on input from the Form.
protected void	reorder(List<MetaItem> items) Re-Order the items of the passed List This implementation does nothing.
void	reset() During Ajax calls a Render Adapter maybe called multiple times.
protected void	save(T entity, MetaItem metaItem, Object value) Save the specific value associated with the MetaItem back into the model Object
void	setResourcePaths(Map<String,String> resourcePaths) Where different File type properties/fields can be stored.
void	setResourceUploader(FileUploadWrapper resourceUploader)

Methods inherited from class com.neurosys.content.wicket.pages.panel.ListViewTemplatePanel

checkAuthorizationToSave, getComponents, getListComponentName, isAuthorized, processItemList

Methods inherited from class com.neurosys.content.wicket.pages.panel.TemplatePanel

addFacetToMetaItems, extractMetaItems, filter, filterClasses, getContainer, getTemplate, iterateAndAddFacetsToPage, setTemplate

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

onComponentTag, onComponentTagBody, renderHead

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

newHeaderPartContainer, renderHeadFromAssociatedMarkupFile

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, 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, onBeginRequest, onConfigure, onDetach, onEndRequest, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, 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

ON_SAVE_EnsureAccessorExistsTransformer

public static final String ON_SAVE_EnsureAccessorExistsTransformer

The FacetMeta Requires a EnsureAccessorExistsTransformer to be called on save(Serializable, MetaItem, Object)
The value of this attribute is expected to be either a EnsureAccessorExistsTransformer or a Boolean value. if its a boolean value it will use the global TemplatePanel.getTemplate().getAccessorExistsTransformer()

See Also:

Constant Field Values

Constructor Detail

EntityDetailsTemplatePanel

public EntityDetailsTemplatePanel(String id,
                                  org.apache.wicket.model.IModel<T> model,
                                  EntityTemplate template,
                                  CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer> defaultRenderAdapter)

Method Detail

onInitialize

public void onInitialize()

Overrides:

onInitialize in class TemplatePanel<EntityTemplate<TemplatePanel>,T extends Serializable>

getComponentForType

public org.apache.wicket.Component getComponentForType(MetaItem metaItem,
                                                       String fieldComponentName,
                                                       org.apache.wicket.model.IModel model,
                                                       org.apache.wicket.MarkupContainer container,
                                                       T modelObject,
                                                       User user)

Specified by:

getComponentForType in interface CustomTemplateRenderAdapter<T extends Serializable,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>

Parameters:

metaItem - as MetaItem

fieldComponentName - as the rendering fieldComponentName or Id (of the component to be created)

model - as MODEL of the value extracted from the original modelObject for the MetaItem. This is a variable that would typically be extracted from the modeObject using the MetaItem, however there is complex logic that can vary and hence is expected to be provided to this method.

container - as CONTAINER_COMPONENT containing the produced component

modelObject - as the core domain Object/Entity

user - as com.neurosys.security.auth.domain.User for any Authorization related needs @nullable true

Returns:

COMPONENT

See Also:

ProductDetailsTemplatePanel#getComponentForType(MetaItem, String, MODEL, CONTAINER_COMPONENT, com.neurosys.products.domain.Product)

extractFieldValue

protected Object extractFieldValue(Object rawValue,
                                   MetaItem metaItemObject)

Converts different type of model field values to a model that is sent to the display

getModelForFieldOrAttribute

protected org.apache.wicket.model.IModel getModelForFieldOrAttribute(T modelObject,
                                                                     MetaItem metaItem)

get the value from the Field or Attributes.
If the both exist then this implementation will give preference to FacetMeta as it is defined by Config in a Template
Special Support for Fields that are Serializable and marked JSON. Auto converts them to JSON format. (TODO: Add Unit Test Case for this)
The output of this method should match the expectation for the particular ContentType in #getComponentForType(com.neurosys.content.wicket.pages.panel.TemplatePanel.MetaItem, String, IModel, MarkupContainer)
If a MetaItem.getFacetMeta() FacetMeta.getCustomItemRenderAdapter() exists then it will skip any conversations as the custom logic is expected to be provided by the adapter itself.

Parameters:

modelObject -

metaItem -

Returns:

IModel

isSetValueInSameModel

protected boolean isSetValueInSameModel(FacetMeta facetMeta,
                                        Object value)

While saving if the value should be set back in the same model passed by the Entity (like CompoundPropertyModel or assigned a new Model
Also a FacetMeta an explicitly opt-out of being part of CompoundPropertyModel by setting FacetMeta.setAssignIndependentModel(Boolean) to false.

Parameters:

facetMeta - as FacetMeta

value - as Object

Returns:

boolean

getComponentsForType

protected Collection<org.apache.wicket.Component> getComponentsForType(T modelObject,
                                                                       MetaItem metaItem,
                                                                       org.apache.wicket.model.IModel model,
                                                                       org.apache.wicket.MarkupContainer container)

Parameters:

modelObject - of the base/container entity

metaItem - for Component

model - for the component

container -

Returns:

See Also:

this#getComponentForType}

getAddToCollectionSectionName

protected String getAddToCollectionSectionName(MetaItem metaItemObject)

The add section which should have a minimum of one "addOption" component can be customized for different scenarios; by type or field name etc. Returns the fragment name. We can customize the fragments based on the level of granularity we need in the type of fragment required. By default this is at a ContentType level. Example: <wicket:fragment wicket:id="addSection_IMG">

getListForCollectionType

protected List getListForCollectionType(T modelObject,
                                        MetaItem metaItem)

Get a List to represent the Collection of values to presented to the UI by #getComponentsForCollectionType(Entity, com.neurosys.content.wicket.pages.panel.TemplatePanel.MetaItem, MarkupContainer)

getComponentsForCollectionType

protected Collection<org.apache.wicket.Component> getComponentsForCollectionType(T modelObject,
                                                                                 MetaItem metaItem,
                                                                                 org.apache.wicket.MarkupContainer container)

getComponents

protected org.apache.wicket.Component[] getComponents(T modelObject,
                                                      org.apache.wicket.markup.html.list.ListItem<MetaItem> item)

Main rendering method; adds components to the container

Specified by:

getComponents in class ListViewTemplatePanel<EntityTemplate<TemplatePanel>,T extends Serializable>

Parameters:

modelObject - as M

item - as ListItem

Returns:

Component that is added to the item eventually @nullable true; if null then it wont be added to the component list

getResourceUploader

public FileUploadWrapper getResourceUploader()

setResourceUploader

public void setResourceUploader(FileUploadWrapper resourceUploader)

getDataRelatedComponents

public <C extends org.apache.wicket.Component> List<C> getDataRelatedComponents(Class<C> type)

Description copied from class: TemplatePanel

All elements added to the dynamic panel maybe added within wrapper elements and nested hierarchies. i.e. not directly attached to the main container component.
An efficient and convenient method of retrieving all elements of the same/similar raw type irrespective of what parent they are attached to.

Specified by:

getDataRelatedComponents in class TemplatePanel<EntityTemplate<TemplatePanel>,T extends Serializable>

Parameters:

type - as Class of Component type

Returns:

reorder

protected void reorder(List<MetaItem> items)

Description copied from class: ListViewTemplatePanel

Re-Order the items of the passed List
This implementation does nothing.

Overrides:

reorder in class ListViewTemplatePanel<EntityTemplate<TemplatePanel>,T extends Serializable>

onBeforeRender

protected void onBeforeRender()

Overrides:

onBeforeRender in class org.apache.wicket.Component

getStatelessHint

protected boolean getStatelessHint()

Overrides:

getStatelessHint in class org.apache.wicket.Component

processItem

public Object processItem(T modelObject,
                          MetaItem metaItem,
                          org.apache.wicket.Component coreEntityDataField,
                          User user,
                          Object... contextParams)
                   throws Exception

For each meta item handle processing on submit and derive the value to be submitted/persisted back

Specified by:

processItem in interface CustomTemplateRenderAdapter<T extends Serializable,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>

Parameters:

modelObject - as the entity

meta - as MetaItem

coreEntityDataField - as Component

user - as User who is logged in

contextParams - as Varargs

Returns:

Object, null or Nothing (nothing). Nothing should not be persisted or used, it implies it should be ignored.

Throws:

Exception

save

protected void save(T entity,
                    MetaItem metaItem,
                    Object value)
             throws Exception

Save the specific value associated with the MetaItem back into the model Object

Throws:

Exception

mergeCollections

protected List mergeCollections(List existingValues,
                                List newValues)

Algorithm to merge Lists of existing values and new values. It iterates over newValues looking for Nothing (nothing) to replace and merge
This Merge process assumes the new list entries are in order and super-impose existing in order

Parameters:

existingValues - as List

newValues - as List

Returns:

List

processSubmit

public T processSubmit(T entity,
                       org.apache.wicket.markup.html.form.Form<T> form)
                throws Exception

Intended for processing of the part of the data thats generated by this panel only.
Elements belonging to this panel must update the modelObject based on input from the Form.

Parameters:

entity; - modelObject that is in a transient state of saving. Data from fields will be set into the modelObject.

form - as Form containing the new values from the form submitted

Throws:

Exception

getResourcePaths

public Map<String,String> getResourcePaths()

setResourcePaths

public void setResourcePaths(Map<String,String> resourcePaths)

Where different File type properties/fields can be stored. A mapping of field/property name to the resource path

getItemRefId

public String getItemRefId(MetaItem metaItem)

Description copied from interface: CustomTemplateRenderAdapter

When rendering Items, for Feedback we may want to target messages to sections in the form. A convention needs to exist to target a particular component generated from a MetaItem

Specified by:

getItemRefId in interface CustomTemplateRenderAdapter<T extends Serializable,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>

Parameters:

metaItem - as MetaItem

Returns:

String

reset

public void reset()

Description copied from interface: CustomTemplateRenderAdapter

During Ajax calls a Render Adapter maybe called multiple times.
Some states may need to be reset.

Specified by:

reset in interface CustomTemplateRenderAdapter<T extends Serializable,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>