DefaultScreenEntityDefinitionsBuilder.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.designtime.terminal.analyzer.support;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openlegacy.designtime.analyzer.SnapshotsAnalyzerContext;
import org.openlegacy.designtime.analyzer.TextTranslator;
import org.openlegacy.designtime.terminal.analyzer.BestEntityNameFieldComparator;
import org.openlegacy.designtime.terminal.analyzer.ScreenEntityDefinitionsBuilder;
import org.openlegacy.designtime.terminal.analyzer.ScreenFact;
import org.openlegacy.designtime.terminal.analyzer.ScreenFactProcessor;
import org.openlegacy.designtime.terminal.model.ScreenEntityDesigntimeDefinition;
import org.openlegacy.terminal.TerminalField;
import org.openlegacy.terminal.TerminalFieldsSplitter;
import org.openlegacy.terminal.TerminalSnapshot;
import org.openlegacy.terminal.definitions.ScreenFieldDefinition;
import org.openlegacy.utils.StringUtil;

import java.text.MessageFormat;
import java.util.Collections;
import java.util.List;

import javax.inject.Inject;

public class DefaultScreenEntityDefinitionsBuilder implements ScreenEntityDefinitionsBuilder {

	private final static Log logger = LogFactory.getLog(DefaultScreenEntityDefinitionsBuilder.class);

	private List<ScreenFactProcessor> screenFactProcessors;

	@Inject
	private BestEntityNameFieldComparator bestEntityNameFieldComparator;

	@Inject
	private TerminalFieldsSplitter terminalFieldsSplitter;

	@Inject
	private TextTranslator textTranslator;

	@Inject
	private ScreenEntityDefinitionsBuilderUtils screenEntityDefinitionsBuilderUtils;

	public void selectPotentialScreenEntityName(
			SnapshotsAnalyzerContext<TerminalSnapshot, ScreenEntityDesigntimeDefinition> snapshotsAnalyzerContext,
			ScreenEntityDesigntimeDefinition screenEntityDefinition, List<TerminalField> possibleFields) {

		String bestMatchEntityName = null;
		TerminalField bestMatchEntityField = null;

		if (possibleFields.size() > 1) {
			possibleFields = terminalFieldsSplitter.splitFields(possibleFields);
			Collections.sort(possibleFields, bestEntityNameFieldComparator);
		}

		if (possibleFields.size() > 0) {
			bestMatchEntityField = possibleFields.get(0);
			String text = bestMatchEntityField.getValue();
			String translatedText = textTranslator.translate(text);
			if (!translatedText.equals(text)) {
				screenEntityDefinition.setDisplayName(text);
			}
			bestMatchEntityName = StringUtil.toClassName(translatedText);
		}

		String existingEntityName = screenEntityDefinition.getEntityName();

		if (existingEntityName == null) {
			snapshotsAnalyzerContext.addEntityDefinition(bestMatchEntityName, screenEntityDefinition);
			if (bestMatchEntityName != null) {
				logger.info(MessageFormat.format("New potential screen entity add: {0}", bestMatchEntityName));
			} else {
				logger.info("New potential screen entity without title added");
			}

			// add the field which the entity name is based on as one of the identifiers
			if (bestMatchEntityField != null) {
				// add identifier without verifying existence - split fields don't exists on the snapshot
				screenEntityDefinitionsBuilderUtils.addIdentifier(screenEntityDefinition, bestMatchEntityField, false);
			} else {
				if (logger.isDebugEnabled()) {
					logger.debug("Added a screen without a initial title identifier");
				}
			}
		} else {
			logger.error(MessageFormat.format("Ignoring potential screen entity name {0}. Name already present:{1}",
					bestMatchEntityName, existingEntityName));
		}

	}

	public ScreenFieldDefinition addField(ScreenEntityDesigntimeDefinition screenEntityDefinition, TerminalField field,
			TerminalField labelField) {
		return screenEntityDefinitionsBuilderUtils.addField(screenEntityDefinition, field, labelField);
	}

	public void processFact(ScreenEntityDesigntimeDefinition screenEntityDefinition, ScreenFact screenFact) {
		for (ScreenFactProcessor screenFactProcessor : screenFactProcessors) {
			if (screenFactProcessor.accept(screenFact)) {
				screenFactProcessor.process(screenEntityDefinition, screenFact);
			}
		}
	}

	public void setScreenFactProcessors(List<ScreenFactProcessor> screenFactProcessors) {
		this.screenFactProcessors = screenFactProcessors;
	}
}