SharedItemsDataModel.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); <br>
 * you may not use this file except in compliance with the License.<br>
 * You may obtain a copy of the License at the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <p>
 * Unless required by applicable law or agreed to in writing,<br>
 * software distributed under the License is distributed on an "AS IS" BASIS, <br>
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
 * See the License for the specific language governing permissions and <br>
 * limitations under the License.
 * <p>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.modules.portfolio.ui;

import java.util.List;
import java.util.Locale;

import org.olat.core.commons.persistence.SortKey;
import org.olat.core.gui.components.form.flexible.impl.elements.table.DefaultFlexiTableDataModel;
import org.olat.core.gui.components.form.flexible.impl.elements.table.FlexiSortableColumnDef;
import org.olat.core.gui.components.form.flexible.impl.elements.table.FlexiTableColumnModel;
import org.olat.core.gui.components.form.flexible.impl.elements.table.SortableFlexiTableDataModel;
import org.olat.core.gui.components.form.flexible.impl.elements.table.SortableFlexiTableModelDelegate;
import org.olat.modules.portfolio.model.SharedItemRow;

/**
 * 
 * Initial date: 15.06.2016<br>
 * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
 *
 */
public class SharedItemsDataModel extends DefaultFlexiTableDataModel<SharedItemRow>
	implements SortableFlexiTableDataModel<SharedItemRow> {
	
	private final Locale locale;
	
	public SharedItemsDataModel(FlexiTableColumnModel columnModel, Locale locale) {
		super(columnModel);
		this.locale = locale;
	}

	@Override
	public void sort(SortKey orderBy) {
		if(orderBy != null) {
			List<SharedItemRow> views = new SharedItemsSorterDelegate(orderBy, this, locale).sort();
			super.setObjects(views);
		}
	}

	@Override
	public Object getValueAt(int row, int col) {
		SharedItemRow itemRow = getObject(row);
		return getValueAt(itemRow, col);
	}	
	
	@Override
	public Object getValueAt(SharedItemRow itemRow, int col) {
		if(col >= 0 && col < ShareItemCols.values().length) {
			switch(ShareItemCols.values()[col]) {
				case username: return itemRow.getIdentityName();
				case binderKey: return itemRow.getBinderKey();
				case binderName: return itemRow.getBinderTitle();
				case courseName: return itemRow.getEntryDisplayName();
				case openSections: return itemRow.getNumOfOpenSections();
				case selectSections: return itemRow;
				case grading: return itemRow.getAssessmentEntry();
				case lastModified: return itemRow.getLastModified();
				case recentLaunch: return itemRow.getRecentLaunch();
			}
		}
		
		int propPos = col - SharedItemsController.USER_PROPS_OFFSET;
		return itemRow.getIdentityProp(propPos);
	}
	
	@Override
	public SharedItemsDataModel createCopyWithEmptyList() {
		return new SharedItemsDataModel(getTableColumnModel(), locale);
	}

	public enum ShareItemCols implements FlexiSortableColumnDef {
		username("table.user.login"),
		binderKey("table.header.key"),
		binderName("table.header.title"),
		courseName("table.header.course"),
		openSections("table.header.open.sections"),
		selectSections("table.header.select.sections"),
		grading("table.header.grading"),
		lastModified("table.header.lastUpdate"),
		recentLaunch("table.header.recentLaunch");
		
		private final String i18nKey;
		
		private ShareItemCols(String i18nKey) {
			this.i18nKey = i18nKey;
		}
		
		@Override
		public String i18nHeaderKey() {
			return i18nKey;
		}

		@Override
		public boolean sortable() {
			return true;
		}

		@Override
		public String sortKey() {
			return name();
		}
	}
	
	
	public static class SharedItemsSorterDelegate extends SortableFlexiTableModelDelegate<SharedItemRow> {
		
		public SharedItemsSorterDelegate(SortKey orderBy, SharedItemsDataModel model, Locale locale) {
			super(orderBy, model, locale);
		}
	}
}