ScreenTableAnnotationLoader.java

/*******************************************************************************
 * Copyright (c) 2012 OpenLegacy Inc.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     OpenLegacy Inc. - initial API and implementation
 *******************************************************************************/
package org.openlegacy.loaders.support;

import org.openlegacy.EntitiesRegistry;
import org.openlegacy.annotations.screen.ScreenColumn;
import org.openlegacy.annotations.screen.ScreenTable;
import org.openlegacy.exceptions.RegistryException;
import org.openlegacy.terminal.definitions.SimpleScreenColumnDefinition;
import org.openlegacy.terminal.definitions.SimpleScreenTableDefinition;
import org.openlegacy.terminal.services.ScreenEntitiesRegistry;
import org.openlegacy.utils.ReflectionUtil;
import org.openlegacy.utils.StringUtil;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.ReflectionUtils.FieldCallback;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.text.MessageFormat;
import java.util.Collections;

@Component
@Order(3)
public class ScreenTableAnnotationLoader extends AbstractClassAnnotationLoader {

	public boolean match(Annotation annotation) {
		return annotation.annotationType() == ScreenTable.class;
	}

	@SuppressWarnings("rawtypes")
	public void load(EntitiesRegistry entitiesRegistry, Annotation annotation, Class<?> containingClass) {

		ScreenEntitiesRegistry screenEntitiesRegistry = (ScreenEntitiesRegistry)entitiesRegistry;
		ScreenTable screenTableAnnotation = (ScreenTable)annotation;

		SimpleScreenTableDefinition tableDefinition = new SimpleScreenTableDefinition(containingClass);
		tableDefinition.setStartRow(screenTableAnnotation.startRow());
		tableDefinition.setEndRow(screenTableAnnotation.endRow());
		tableDefinition.setScrollable(screenTableAnnotation.scrollable());
		tableDefinition.setRowsGap(screenTableAnnotation.rowGaps());

		tableDefinition.setNextScreenAction(ReflectionUtil.newInstance(screenTableAnnotation.nextScreenAction()));
		tableDefinition.setPreviousScreenAction(ReflectionUtil.newInstance(screenTableAnnotation.previousScreenAction()));

		String name = screenTableAnnotation.name().length() > 0 ? screenTableAnnotation.name()
				: StringUtil.toJavaFieldName(containingClass.getSimpleName());
		tableDefinition.setTableEntityName(name);

		tableDefinition.setTableCollector(screenTableAnnotation.tableCollector());
		collectColumnsMetadata(containingClass, tableDefinition);
		screenEntitiesRegistry.addTable(tableDefinition);

	}

	private static void collectColumnsMetadata(final Class<?> rowClass, final SimpleScreenTableDefinition tableDefinition) {
		ReflectionUtils.doWithFields(rowClass, new FieldCallback() {

			public void doWith(Field field) {

				if (!field.isAnnotationPresent(ScreenColumn.class)) {
					return;
				}
				ScreenColumn screenColumnAnnotation = field.getAnnotation(ScreenColumn.class);

				SimpleScreenColumnDefinition columnDefinition = new SimpleScreenColumnDefinition(field.getName());
				columnDefinition.setStartColumn(screenColumnAnnotation.startColumn());
				columnDefinition.setEndColumn(screenColumnAnnotation.endColumn());
				columnDefinition.setRowsOffset(screenColumnAnnotation.rowsOffset());
				columnDefinition.setKey(screenColumnAnnotation.key());
				columnDefinition.setEditable(screenColumnAnnotation.editable());
				String displayName = screenColumnAnnotation.displayName().length() > 0 ? screenColumnAnnotation.displayName()
						: StringUtil.toDisplayName(field.getName());
				columnDefinition.setDisplayName(displayName);
				columnDefinition.setSampleValue(screenColumnAnnotation.sampleValue());

				columnDefinition.setSelectionField(screenColumnAnnotation.selectionField());
				if (columnDefinition.isSelectionField()) {
					columnDefinition.setEditable(true);
				}

				columnDefinition.setHelpText(screenColumnAnnotation.helpText());

				if (columnDefinition.isKey() && columnDefinition.isSelectionField()) {
					throw (new RegistryException(MessageFormat.format(
							"A column cannot be defined as both selection and key field. Class: {0}, Column: {1}", rowClass,
							columnDefinition.getName())));
				}

				tableDefinition.getColumnDefinitions().add(columnDefinition);

				if (screenColumnAnnotation.mainDisplayField()) {
					if (tableDefinition.getMainDisplayField() != null) {
						throw (new RegistryException(MessageFormat.format(
								"More then one main display field defined for class:{0}", rowClass)));
					}
					tableDefinition.setMainDisplayField(field.getName());
				}

			}
		});
		Collections.sort(tableDefinition.getColumnDefinitions());
	}
}