com.neurosys.template.wicket.itemadapters

Class JSONGridRenderAdapter

java.lang.Object

com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

com.neurosys.template.wicket.itemadapters.JSONGridRenderAdapter

All Implemented Interfaces:

Serializable

public class JSONGridRenderAdapter
extends CustomItemComponentRenderAdapter

A CustomItemComponentRenderAdapter that supports rows and columns to support JSON Maps

The corresponding HTML fragment in the EntityDetailsTemplatePanel type should be like:

 			<table class="grid" wicket:id="input">
				<thead><tr><th class="tuple_head" wicket:id="tupleColName"></th><wicket:container wicket:id="colNames"><th wicket:id="colDisplayName"></th></wicket:container></tr></thead>
				<tbody>
					<tr wicket:id="rows">
						<td class="tuple_head" wicket:id="tupleDisplayName"></td>
						<td wicket:id="cols"><div wicket:id="core"></div></td>
					</tr>
				</tbody>				
			</table>
  

It aligns the core fields on the X-Axis (column wise) and the tuples row wise.

The configuration backing this grid, would be:

• Model : The model is expected to be a JSON 2D Map, 1D Map or a JSON Array. A 1D map simply contains the key-value pairs straight up, an array for a Tuple has no keys within the tuple.
• tupleFields : Defines the secondary axis (Y), which are the rows backing the grid. Each row (tuple) is a collection of columns (coreFields value).
  If a tuple field is a FacetMeta#getAttribute(String)), for key , then it assumes the core JSON is itself the tuple. This is useful for JSON's that are single tuples and do not need a key to represent the tuple itself.
  If a tuple field is a FacetMeta.isCollectionType(), then it assumes the tuple is a JSON Array. In this case the coreFields, FacetMeta.getName() is the index within the array and hence is expect3ed to be an integer.
• coreFields : Defines the primary axis (X). These constitute the core fields that will capture the values for any given tuple.

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

CustomItemComponentRenderAdapter.ContextualTwoWayTransformer

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIB_SINGLE_TYPE_JSON FacetMeta.getAttribute(String), if for this key is true then it will treat the JSON as a single tuple.

Fields inherited from class com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

authorizationModule, modelTransformer

Constructor Summary

Constructors

Constructor and Description
JSONGridRenderAdapter()
JSONGridRenderAdapter(JSONGridRenderAdapter t)

Method Summary

Modifier and Type	Method and Description
org.apache.wicket.Component	getComponent(String componentId, MetaItem metaItem, org.apache.wicket.model.IModel defaultInputModel, Object modelObject, User user) Some fields/attribute may require display of options for selection or Auto-Suggest etc..
List<FacetMeta>	getCoreFields() These are the fields that define the core data to be captured. For example in a class, for every student.
Map<String,org.apache.commons.collections.Transformer>	getCoreFieldTransformers() An optional Map of Transformer for each field in coreFields by FacetMeta.getName() Any mapping with null key implies applying that Transformer to all cells in the grid, if no override exists for it.
CustomTemplateRenderAdapter<Object,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>	getFieldRenderAdapter() Optional CustomTemplateRenderAdapter to render fields in the grip.
String	getTupleColName() An HTML friendly name for the tuple column
List<ISection>	getTupleFields() These are the fields that define the group of the primary fields, that belong to the secondary field. The ISection.getName() define the keys in a JSON / Map and the ISection.getDisplayName() the display tuple name For example in a class, for every student.
Object	processSubmit(MetaItem metaItem, org.apache.wicket.Component fieldEntityComponent, Object value, User user) Call on submit of component.
void	setCoreFields(List<FacetMeta> coreFields) These are the fields that define the core data to be captured. For example in a class, for every student.
void	setCoreFieldTransformers(Map<String,org.apache.commons.collections.Transformer> coreFieldTransformers) An optional Map of Transformer for each field in coreFields by FacetMeta.getName() Any mapping with null key implies applying that Transformer to all cells in the grid, if no override exists for it.
void	setFieldRenderAdapter(CustomTemplateRenderAdapter<Object,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer> fieldRenderAdapter) Optional CustomTemplateRenderAdapter to render fields in the grip.
void	setTupleColName(String tupleColName) An HTML friendly name for the tuple column
void	setTupleFields(List<ISection> tupleFields) These are the fields that define the group of the primary fields, that belong to the secondary field. The ISection.getName() define the keys in a JSON / Map and the ISection.getDisplayName() the display tuple name For example in a class, for every student.

Methods inherited from class com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

filter, getDataList, getLookup, getModelTransformer, markComponentReadOnly, setModelTransformer, translateCurrentSelectionModel

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIB_SINGLE_TYPE_JSON

public static final String ATTRIB_SINGLE_TYPE_JSON

FacetMeta.getAttribute(String), if for this key is true then it will treat the JSON as a single tuple. Example: {"a":"123", "b":".."}

See Also:

Constant Field Values

Constructor Detail

JSONGridRenderAdapter

public JSONGridRenderAdapter()

JSONGridRenderAdapter

public JSONGridRenderAdapter(JSONGridRenderAdapter t)

Method Detail

getComponent

public org.apache.wicket.Component getComponent(String componentId,
                                                MetaItem metaItem,
                                                org.apache.wicket.model.IModel defaultInputModel,
                                                Object modelObject,
                                                User user)

Description copied from class: CustomItemComponentRenderAdapter

Some fields/attribute may require display of options for selection or Auto-Suggest etc..

Providing rendering option for lookup for that field/attribute. The base class returns a Hidden field, which can be overriden by any derived adapter.
If no mapping exists, then null will be returned.
Base class implementation returns HiddenField

Overrides:

getComponent in class CustomItemComponentRenderAdapter

Parameters:

componentId - as Sting id for the Component

metaItem - as MetaItem meta data for rendering logic

defaultInputModel - is the current data defined in a IModel for the MetaItem. The resultant model in the returned Component may NOT be same as the one passed to the inner component, hence always use the derived one. This is because there maybe a mismatch in the form of core/raw data and one required for final presentation. For example the input maybe a Comma Separated list of Strings, however for presentation in a List box we may convert the Model to a ListModel.

modelObject - as Object, that represents the main Entity (overall context)

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

Returns:

Component @nullable true

processSubmit

public Object processSubmit(MetaItem metaItem,
                            org.apache.wicket.Component fieldEntityComponent,
                            Object value,
                            User user)

Call on submit of component. Should ideally also update the model behind input Component fieldEntityComponent
If CustomItemComponentRenderAdapter.modelTransformer is a TwoWayTransformer then this method can be skipped.

Overrides:

processSubmit in class CustomItemComponentRenderAdapter

Parameters:

metaItem - as MetaItem

fieldEntityComponent - as Component, the same component that the RenderAdapter created in CustomItemComponentRenderAdapter.getComponent(String, MetaItem, IModel, Object, User)

value - as Object

user - as User

Returns:

getCoreFields

public List<FacetMeta> getCoreFields()

These are the fields that define the core data to be captured.
For example in a class, for every student. Their subjects are the core fields and the student names them selves are tuples.

setCoreFields

public void setCoreFields(List<FacetMeta> coreFields)

These are the fields that define the core data to be captured.
For example in a class, for every student. Their subjects are the core fields and the student names them selves are tuples.

getTupleFields

public List<ISection> getTupleFields()

These are the fields that define the group of the primary fields, that belong to the secondary field.
The ISection.getName() define the keys in a JSON / Map and the ISection.getDisplayName() the display tuple name
For example in a class, for every student. Their subjects are the core fields and the student names them selves are tuples.

setTupleFields

public void setTupleFields(List<ISection> tupleFields)

These are the fields that define the group of the primary fields, that belong to the secondary field.
The ISection.getName() define the keys in a JSON / Map and the ISection.getDisplayName() the display tuple name
For example in a class, for every student. Their subjects are the core fields and the student names them selves are tuples.

getFieldRenderAdapter

public CustomTemplateRenderAdapter<Object,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer> getFieldRenderAdapter()

Optional CustomTemplateRenderAdapter to render fields in the grip.

Default value:

DefaultWicketTemplateRenderAdapter.getInstance()

setFieldRenderAdapter

public void setFieldRenderAdapter(CustomTemplateRenderAdapter<Object,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer> fieldRenderAdapter)

Optional CustomTemplateRenderAdapter to render fields in the grip.

Default value:

DefaultWicketTemplateRenderAdapter.getInstance()

getTupleColName

public String getTupleColName()

An HTML friendly name for the tuple column

setTupleColName

public void setTupleColName(String tupleColName)

An HTML friendly name for the tuple column

getCoreFieldTransformers

public Map<String,org.apache.commons.collections.Transformer> getCoreFieldTransformers()

An optional Map of Transformer for each field in coreFields by FacetMeta.getName()
Any mapping with null key implies applying that Transformer to all cells in the grid, if no override exists for it.

setCoreFieldTransformers

public void setCoreFieldTransformers(Map<String,org.apache.commons.collections.Transformer> coreFieldTransformers)

An optional Map of Transformer for each field in coreFields by FacetMeta.getName()
Any mapping with null key implies applying that Transformer to all cells in the grid, if no override exists for it.