org.wicketstuff.kendo.ui.repeater.DataProviderBehavior Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.wicketstuff.kendo.ui.repeater;

import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.apache.wicket.Component;
import org.apache.wicket.markup.repeater.data.IDataProvider;
import org.apache.wicket.request.IRequestParameters;
import org.wicketstuff.jquery.core.behavior.AjaxCallbackBehavior;
import org.wicketstuff.jquery.core.renderer.ITextRenderer;
import org.wicketstuff.jquery.core.template.IJQueryTemplate;
import org.wicketstuff.jquery.core.utils.ListUtils;

import com.github.openjson.JSONArray;
import com.github.openjson.JSONObject;

/**
 * Provides the {@link IDataProvider} data source {@link AjaxCallbackBehavior}
 *
 * @param  the type of the model object
 * @author Sebastien Briquet - sebfz1
 */
public class DataProviderBehavior extends AjaxCallbackBehavior
{
	private static final long serialVersionUID = 1L;

	private final IDataProvider provider;
	private final ITextRenderer renderer;
	private final IJQueryTemplate template;

	/**
	 * Constructor
	 *
	 * @param provider the {@link IDataProvider}
	 * @param renderer the {@link ITextRenderer}
	 */
	public DataProviderBehavior(final IDataProvider provider, ITextRenderer renderer)
	{
		this(provider, renderer, null);
	}

	/**
	 * Constructor
	 *
	 * @param provider the {@link IDataProvider}
	 * @param renderer the {@link ITextRenderer}
	 * @param template the {@link IJQueryTemplate}
	 */
	public DataProviderBehavior(final IDataProvider provider, ITextRenderer renderer, IJQueryTemplate template)
	{
		this.provider = provider;
		this.renderer = renderer;
		this.template = template;
	}

	/**
	 * Gets the property set that should be appended to the JSON response.

	 * The value corresponding to the property is retrieved from the {@link ITextRenderer#getText(Object, String)}
	 *
	 * @return the property list
	 */
	protected List getProperties()
	{
		if (this.template != null)
		{
			return ListUtils.exclude(this.template.getTextProperties(), this.renderer.getFields()); // #198
		}

		return Collections.emptyList();
	}

	@Override
	protected String getResponse(IRequestParameters parameters)
	{
		final int first = parameters.getParameterValue("skip").toInt(0);
		final int count = parameters.getParameterValue("take").toInt(Short.MAX_VALUE);

		final long size = this.provider.size();
		final Iterator iterator = this.provider.iterator(first, count);

		// builds JSON result //
		final JSONObject payload = new JSONObject();
		payload.put("__count", size);

		final JSONArray results = new JSONArray();
		payload.put("results", results);

		if (iterator != null)
		{
			while (iterator.hasNext())
			{
				final T object = iterator.next();

				// ITextRenderer //
				final JSONObject result = this.renderer.render(object);

				for (String property : this.getProperties())
				{
					result.put(property, this.renderer.getText(object, property));
				}

				results.put(result);
			}
		}

		return payload.toString();
	}

	@Override
	public void detach(Component component)
	{
		super.detach(component);

		this.provider.detach();
	}
}