ScreenFieldAnnotationLoader.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.EntityDefinition;
import org.openlegacy.annotations.screen.AnnotationConstants;
import org.openlegacy.annotations.screen.ScreenField;
import org.openlegacy.definitions.support.SimpleDateFieldTypeDefinition;
import org.openlegacy.definitions.support.SimpleNumericFieldTypeDefinition;
import org.openlegacy.definitions.support.SimplePasswordFieldTypeDefinition;
import org.openlegacy.definitions.support.SimpleTextFieldTypeDefinition;
import org.openlegacy.exceptions.RegistryException;
import org.openlegacy.terminal.definitions.ScreenPartEntityDefinition;
import org.openlegacy.terminal.definitions.SimpleScreenFieldDefinition;
import org.openlegacy.terminal.services.ScreenEntitiesRegistry;
import org.openlegacy.terminal.support.SimpleTerminalPosition;
import org.openlegacy.utils.StringUtil;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

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

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class ScreenFieldAnnotationLoader extends AbstractFieldAnnotationLoader {

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

	@SuppressWarnings({ "unchecked", "rawtypes" })
	public void load(EntitiesRegistry entitiesRegistry, Field field, Annotation annotation, Class<?> containingClass) {
		ScreenEntitiesRegistry screenEntitiesRegistry = (ScreenEntitiesRegistry)entitiesRegistry;

		ScreenField fieldAnnotation = (ScreenField)annotation;

		SimpleTerminalPosition position = SimpleTerminalPosition.newInstance(fieldAnnotation.row(), fieldAnnotation.column());
		String fieldName = field.getName();
		SimpleScreenFieldDefinition screenFieldDefinition = new SimpleScreenFieldDefinition(fieldName,
				fieldAnnotation.fieldType());
		screenFieldDefinition.setPosition(position);

		if (fieldAnnotation.endColumn() == 0) {
			screenFieldDefinition.setLength(0);
		} else {
			screenFieldDefinition.setLength(fieldAnnotation.endColumn() - fieldAnnotation.column() + 1);
		}

		if (fieldAnnotation.endRow() > 0) {
			if (fieldAnnotation.endRow() <= fieldAnnotation.row()) {
				throw (new RegistryException(MessageFormat.format(
						"End row must be greater then row for field {0}. (can be removed for same row)", field.getName())));
			}
			if (fieldAnnotation.endColumn() == 0) {
				throw (new RegistryException(MessageFormat.format(
						"End column must be defined for multiple rows in field {0}. (can be removed for same row)",
						field.getName())));
			}

			screenFieldDefinition.setEndPosition(SimpleTerminalPosition.newInstance(fieldAnnotation.endRow(),
					fieldAnnotation.endColumn()));

			screenFieldDefinition.setRectangle(fieldAnnotation.rectangle());
		}

		if (fieldAnnotation.labelColumn() > 0) {
			SimpleTerminalPosition labelPosition = SimpleTerminalPosition.newInstance(fieldAnnotation.row(),
					fieldAnnotation.labelColumn());
			screenFieldDefinition.setLabelPosition(labelPosition);
		}

		screenFieldDefinition.setEditable(fieldAnnotation.editable());
		screenFieldDefinition.setPassword(fieldAnnotation.password());
		screenFieldDefinition.setRightToLeft(fieldAnnotation.rightToLeft());

		if (fieldAnnotation.displayName().equals(AnnotationConstants.NULL)) {
			screenFieldDefinition.setDisplayName(StringUtil.toDisplayName(fieldName));
		} else {
			screenFieldDefinition.setDisplayName(fieldAnnotation.displayName());
		}

		screenFieldDefinition.setSampleValue(fieldAnnotation.sampleValue());
		screenFieldDefinition.setJavaType(field.getType());

		screenFieldDefinition.setHelpText(fieldAnnotation.helpText());
		screenFieldDefinition.setKey(fieldAnnotation.key());

		setupFieldType(field, screenFieldDefinition);

		EntityDefinition screenEntityDefinition = screenEntitiesRegistry.get(containingClass);
		// look in screen entities
		if (screenEntityDefinition != null) {
			screenEntityDefinition.getFieldsDefinitions().put(fieldName, screenFieldDefinition);
		} else {
			// look in screen entities parts
			ScreenPartEntityDefinition screenPart = screenEntitiesRegistry.getPart(containingClass);
			if (screenPart != null) {
				fieldName = MessageFormat.format("{0}.{1}", screenPart.getPartName(), fieldName);
				screenFieldDefinition.setName(fieldName);
				screenPart.getFieldsDefinitions().put(fieldName, screenFieldDefinition);
			}

		}

	}

	private static void setupFieldType(Field field, SimpleScreenFieldDefinition screenFieldDefinition) {
		// set number type definition - may be overridden by ScreenNumericFieldAnnotationLoader to fill in specific numeric
		// properties
		if (Number.class.isAssignableFrom(field.getType())) {
			screenFieldDefinition.setFieldTypeDefinition(new SimpleNumericFieldTypeDefinition());
		}
		// set date type definition - may be overridden by ScreenDateFieldAnnotationLoader to fill in specific date properties
		else if (Date.class.isAssignableFrom(field.getType())) {
			screenFieldDefinition.setFieldTypeDefinition(new SimpleDateFieldTypeDefinition());
		} else if (screenFieldDefinition.isPassword()) {
			screenFieldDefinition.setFieldTypeDefinition(new SimplePasswordFieldTypeDefinition());
		} else {
			// set a default type definition
			screenFieldDefinition.setFieldTypeDefinition(new SimpleTextFieldTypeDefinition());
		}
	}

}