DataDescriptionEntryContainerImpl.java

/src/main/java/io/proleap/cobol/asg/metamodel/data/datadescription/impl/DataDescriptionEntryContainerImpl.java

https://github.com/uwol/proleap-cobol-parser · Java · 479 lines · 308 code · 95 blank · 76 comment · 71 complexity · e242731dad62de1106247bec969b5bc9 MD5 · raw file

/*
 * Copyright (C) 2017, Ulrich Wolffgang <ulrich.wolffgang@proleap.io>
 * All rights reserved.
 *
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

package io.proleap.cobol.asg.metamodel.data.datadescription.impl;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.antlr.v4.runtime.ParserRuleContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.proleap.cobol.CobolParser.DataAlignedClauseContext;
import io.proleap.cobol.CobolParser.DataBlankWhenZeroClauseContext;
import io.proleap.cobol.CobolParser.DataCommonOwnLocalClauseContext;
import io.proleap.cobol.CobolParser.DataDescriptionEntryContext;
import io.proleap.cobol.CobolParser.DataDescriptionEntryExecSqlContext;
import io.proleap.cobol.CobolParser.DataDescriptionEntryFormat1Context;
import io.proleap.cobol.CobolParser.DataDescriptionEntryFormat2Context;
import io.proleap.cobol.CobolParser.DataDescriptionEntryFormat3Context;
import io.proleap.cobol.CobolParser.DataExternalClauseContext;
import io.proleap.cobol.CobolParser.DataGlobalClauseContext;
import io.proleap.cobol.CobolParser.DataIntegerStringClauseContext;
import io.proleap.cobol.CobolParser.DataJustifiedClauseContext;
import io.proleap.cobol.CobolParser.DataOccursClauseContext;
import io.proleap.cobol.CobolParser.DataPictureClauseContext;
import io.proleap.cobol.CobolParser.DataReceivedByClauseContext;
import io.proleap.cobol.CobolParser.DataRecordAreaClauseContext;
import io.proleap.cobol.CobolParser.DataRedefinesClauseContext;
import io.proleap.cobol.CobolParser.DataSignClauseContext;
import io.proleap.cobol.CobolParser.DataSynchronizedClauseContext;
import io.proleap.cobol.CobolParser.DataThreadLocalClauseContext;
import io.proleap.cobol.CobolParser.DataTypeClauseContext;
import io.proleap.cobol.CobolParser.DataTypeDefClauseContext;
import io.proleap.cobol.CobolParser.DataUsageClauseContext;
import io.proleap.cobol.CobolParser.DataUsingClauseContext;
import io.proleap.cobol.CobolParser.DataValueClauseContext;
import io.proleap.cobol.CobolParser.DataWithLowerBoundsClauseContext;
import io.proleap.cobol.asg.metamodel.ProgramUnit;
import io.proleap.cobol.asg.metamodel.data.datadescription.DataDescriptionEntriesSymbolTableEntry;
import io.proleap.cobol.asg.metamodel.data.datadescription.DataDescriptionEntry;
import io.proleap.cobol.asg.metamodel.data.datadescription.DataDescriptionEntryCondition;
import io.proleap.cobol.asg.metamodel.data.datadescription.DataDescriptionEntryContainer;
import io.proleap.cobol.asg.metamodel.data.datadescription.DataDescriptionEntryExecSql;
import io.proleap.cobol.asg.metamodel.data.datadescription.DataDescriptionEntryGroup;
import io.proleap.cobol.asg.metamodel.data.datadescription.DataDescriptionEntryRename;
import io.proleap.cobol.asg.metamodel.impl.CobolDivisionElementImpl;
import io.proleap.cobol.asg.util.AsgStringUtils;
import io.proleap.cobol.asg.util.TagUtils;
import io.proleap.cobol.preprocessor.CobolPreprocessor;

public abstract class DataDescriptionEntryContainerImpl extends CobolDivisionElementImpl
		implements DataDescriptionEntryContainer {

	private final static Logger LOG = LoggerFactory.getLogger(DataDescriptionEntryContainerImpl.class);

	protected List<DataDescriptionEntry> dataDescriptionEntries = new ArrayList<DataDescriptionEntry>();

	protected Map<String, DataDescriptionEntriesSymbolTableEntry> dataDescriptionEntriesSymbolTable = new HashMap<String, DataDescriptionEntriesSymbolTableEntry>();

	public DataDescriptionEntryContainerImpl(final ProgramUnit programUnit, final ParserRuleContext ctx) {
		super(programUnit, ctx);
	}

	@Override
	public DataDescriptionEntryCondition addDataDescriptionEntryCondition(
			final DataDescriptionEntryFormat3Context ctx) {
		DataDescriptionEntryCondition result = (DataDescriptionEntryCondition) getASGElement(ctx);

		if (result == null) {
			final String name = determineName(ctx);
			result = new DataDescriptionEntryConditionImpl(name, this, programUnit, ctx);

			result.setLevelNumber(DataDescriptionEntry.LEVEL_NUMBER_CONDITION);
			result.addValueClause(ctx.dataValueClause());

			registerASGElement(result);

			dataDescriptionEntries.add(result);
			assureDataDescriptionEntriesSymbolTableEntry(name).addDataDescriptionEntry(result);
		}

		return result;
	}

	@Override
	public DataDescriptionEntryExecSql addDataDescriptionEntryExecSql(final DataDescriptionEntryExecSqlContext ctx) {
		DataDescriptionEntryExecSql result = (DataDescriptionEntryExecSql) getASGElement(ctx);

		if (result == null) {
			result = new DataDescriptionEntryExecSqlImpl(this, programUnit, ctx);

			final String execSqlText = TagUtils.getUntaggedText(ctx.EXECSQLLINE(), CobolPreprocessor.EXEC_SQL_TAG,
					CobolPreprocessor.EXEC_END_TAG);
			result.setExecSqlText(execSqlText);

			registerASGElement(result);

			dataDescriptionEntries.add(result);
		}

		return result;
	}

	@Override
	public DataDescriptionEntryGroup addDataDescriptionEntryGroup(final DataDescriptionEntryFormat1Context ctx) {
		DataDescriptionEntryGroup result = (DataDescriptionEntryGroup) getASGElement(ctx);

		if (result == null) {
			final String name = determineName(ctx);
			result = new DataDescriptionEntryGroupImpl(name, this, programUnit, ctx);

			/*
			 * level number
			 */
			final Integer levelNumber;

			if (ctx.LEVEL_NUMBER_77() != null) {
				levelNumber = DataDescriptionEntry.LEVEL_NUMBER_SCALAR;
			} else if (ctx.INTEGERLITERAL() != null) {
				levelNumber = AsgStringUtils.parseInteger(ctx.INTEGERLITERAL().getText());
			} else {
				levelNumber = null;
			}

			result.setLevelNumber(levelNumber);

			/*
			 * filler
			 */
			if (ctx.FILLER() != null) {
				result.setFiller(true);
				result.setFillerNumber(compilationUnit.incrementFillerCounter());
			}

			/*
			 * aligned clause
			 */
			final List<DataAlignedClauseContext> dataAlignedClauseContexts = ctx.dataAlignedClause();

			if (!dataAlignedClauseContexts.isEmpty()) {
				final DataAlignedClauseContext dataAlignedClauseContext = dataAlignedClauseContexts.get(0);
				result.addAlignedClause(dataAlignedClauseContext);
			}

			/*
			 * blank when zero clause
			 */
			final List<DataBlankWhenZeroClauseContext> dataBlankWhenZeroClauseContexts = ctx.dataBlankWhenZeroClause();

			if (!dataBlankWhenZeroClauseContexts.isEmpty()) {
				final DataBlankWhenZeroClauseContext dataBlankWhenZeroClauseContext = dataBlankWhenZeroClauseContexts
						.get(0);
				result.addBlankWhenZeroClause(dataBlankWhenZeroClauseContext);
			}

			/*
			 * common own local clause
			 */
			final List<DataCommonOwnLocalClauseContext> dataCommonOwnLocalClauseContexts = ctx
					.dataCommonOwnLocalClause();

			if (!dataCommonOwnLocalClauseContexts.isEmpty()) {
				final DataCommonOwnLocalClauseContext dataCommonOwnLocalClauseContext = dataCommonOwnLocalClauseContexts
						.get(0);
				result.addCommonOwnLocalClause(dataCommonOwnLocalClauseContext);
			}

			/*
			 * external clause
			 */
			final List<DataExternalClauseContext> dataExternalClauseContexts = ctx.dataExternalClause();

			if (!dataExternalClauseContexts.isEmpty()) {
				final DataExternalClauseContext dataExternalClauseContext = dataExternalClauseContexts.get(0);
				result.addExternalClause(dataExternalClauseContext);
			}

			/*
			 * global clause
			 */
			final List<DataGlobalClauseContext> dataGlobalClauseContexts = ctx.dataGlobalClause();

			if (!dataGlobalClauseContexts.isEmpty()) {
				final DataGlobalClauseContext dataGlobalClauseContext = dataGlobalClauseContexts.get(0);
				result.addGlobalClause(dataGlobalClauseContext);
			}

			/*
			 * data integer string clause
			 */
			final List<DataIntegerStringClauseContext> dataIntegerStringClauseContexts = ctx.dataIntegerStringClause();

			if (!dataIntegerStringClauseContexts.isEmpty()) {
				final DataIntegerStringClauseContext dataIntegerStringClauseContext = dataIntegerStringClauseContexts
						.get(0);
				result.addIntegerStringClause(dataIntegerStringClauseContext);
			}

			/*
			 * justified clause
			 */
			final List<DataJustifiedClauseContext> dataJustifiedClauseContexts = ctx.dataJustifiedClause();

			if (!dataJustifiedClauseContexts.isEmpty()) {
				final DataJustifiedClauseContext dataJustifiedClauseContext = dataJustifiedClauseContexts.get(0);
				result.addJustifiedClause(dataJustifiedClauseContext);
			}

			/*
			 * occurs clause
			 */
			final List<DataOccursClauseContext> dataOccursClauseContexts = ctx.dataOccursClause();

			for (final DataOccursClauseContext dataOccursClauseContext : dataOccursClauseContexts) {
				result.addOccursClause(dataOccursClauseContext);
			}

			/*
			 * picture clause
			 */
			final List<DataPictureClauseContext> dataPictureClauseContexts = ctx.dataPictureClause();

			if (!dataPictureClauseContexts.isEmpty()) {
				final DataPictureClauseContext dataPictureClauseContext = ctx.dataPictureClause().get(0);
				result.addPictureClause(dataPictureClauseContext);
			}

			/*
			 * received by clause
			 */
			final List<DataReceivedByClauseContext> dataReceivedByClauseContexts = ctx.dataReceivedByClause();

			if (!dataReceivedByClauseContexts.isEmpty()) {
				final DataReceivedByClauseContext dataReceivedByClauseContext = dataReceivedByClauseContexts.get(0);
				result.addReceivedByClause(dataReceivedByClauseContext);
			}

			/*
			 * record area clause
			 */
			final List<DataRecordAreaClauseContext> dataRecordAreaClauseContexts = ctx.dataRecordAreaClause();

			if (!dataRecordAreaClauseContexts.isEmpty()) {
				final DataRecordAreaClauseContext dataRecordAreaClauseContext = dataRecordAreaClauseContexts.get(0);
				result.addRecordAreaClause(dataRecordAreaClauseContext);
			}

			/*
			 * redefines clause
			 */
			final List<DataRedefinesClauseContext> dataRedefinesClauseContexts = ctx.dataRedefinesClause();

			if (!dataRedefinesClauseContexts.isEmpty()) {
				final DataRedefinesClauseContext dataRedefinesClauseContext = dataRedefinesClauseContexts.get(0);
				result.addRedefinesClause(dataRedefinesClauseContext);
			}

			/*
			 * sign clause
			 */
			final List<DataSignClauseContext> dataSignClauseContexts = ctx.dataSignClause();

			if (!dataSignClauseContexts.isEmpty()) {
				final DataSignClauseContext dataSignClauseContext = dataSignClauseContexts.get(0);
				result.addSignClause(dataSignClauseContext);
			}

			/*
			 * synchronized
			 */
			final List<DataSynchronizedClauseContext> dataSynchronizedClauseContexts = ctx.dataSynchronizedClause();

			if (!dataSynchronizedClauseContexts.isEmpty()) {
				final DataSynchronizedClauseContext dataSynchronizedClauseContext = dataSynchronizedClauseContexts
						.get(0);
				result.addSynchronizedClause(dataSynchronizedClauseContext);
			}

			/*
			 * thread local
			 */
			final List<DataThreadLocalClauseContext> dataThreadLocalClauseContexts = ctx.dataThreadLocalClause();

			if (!dataThreadLocalClauseContexts.isEmpty()) {
				final DataThreadLocalClauseContext dataThreadLocalClauseContext = dataThreadLocalClauseContexts.get(0);
				result.addThreadLocalClause(dataThreadLocalClauseContext);
			}

			/*
			 * time type
			 */
			final List<DataTypeClauseContext> dataTypeClauseContexts = ctx.dataTypeClause();

			if (!dataTypeClauseContexts.isEmpty()) {
				final DataTypeClauseContext dataTypeClauseContext = dataTypeClauseContexts.get(0);
				result.addTypeClause(dataTypeClauseContext);
			}

			/*
			 * type def
			 */
			final List<DataTypeDefClauseContext> dataTypeDefClauseContexts = ctx.dataTypeDefClause();

			if (!dataTypeDefClauseContexts.isEmpty()) {
				final DataTypeDefClauseContext dataTypeDefClauseContext = dataTypeDefClauseContexts.get(0);
				result.addTypeDefClause(dataTypeDefClauseContext);
			}

			/*
			 * usage
			 */
			final List<DataUsageClauseContext> dataUsageClauseContexts = ctx.dataUsageClause();

			if (!dataUsageClauseContexts.isEmpty()) {
				final DataUsageClauseContext dataUsageClauseContext = dataUsageClauseContexts.get(0);
				result.addUsageClause(dataUsageClauseContext);
			}

			/*
			 * using
			 */
			final List<DataUsingClauseContext> dataUsingClauseContexts = ctx.dataUsingClause();

			if (!dataUsingClauseContexts.isEmpty()) {
				final DataUsingClauseContext dataUsingClauseContext = dataUsingClauseContexts.get(0);
				result.addUsingClause(dataUsingClauseContext);
			}

			/*
			 * value
			 */
			final List<DataValueClauseContext> dataValueClauseContexts = ctx.dataValueClause();

			if (!dataValueClauseContexts.isEmpty()) {
				final DataValueClauseContext dataValueClauseContext = dataValueClauseContexts.get(0);
				result.addValueClause(dataValueClauseContext);
			}

			/*
			 * with lower bounds
			 */
			final List<DataWithLowerBoundsClauseContext> dataWithLowerBoundsClauseContexts = ctx
					.dataWithLowerBoundsClause();

			if (!dataWithLowerBoundsClauseContexts.isEmpty()) {
				final DataWithLowerBoundsClauseContext dataWithLowerBoundsClauseContext = dataWithLowerBoundsClauseContexts
						.get(0);
				result.addWithLowerBoundClause(dataWithLowerBoundsClauseContext);
			}

			registerASGElement(result);

			dataDescriptionEntries.add(result);
			assureDataDescriptionEntriesSymbolTableEntry(name).addDataDescriptionEntry(result);
		}

		return result;
	}

	@Override
	public DataDescriptionEntryRename addDataDescriptionEntryRename(final DataDescriptionEntryFormat2Context ctx) {
		DataDescriptionEntryRename result = (DataDescriptionEntryRename) getASGElement(ctx);

		if (result == null) {
			final String name = determineName(ctx);
			result = new DataDescriptionEntryRenameImpl(name, this, programUnit, ctx);

			result.setLevelNumber(DataDescriptionEntry.LEVEL_NUMBER_RENAME);
			result.addRenamesClause(ctx.dataRenamesClause());

			registerASGElement(result);

			dataDescriptionEntries.add(result);
			assureDataDescriptionEntriesSymbolTableEntry(name).addDataDescriptionEntry(result);
		}

		return result;
	}

	protected DataDescriptionEntriesSymbolTableEntry assureDataDescriptionEntriesSymbolTableEntry(final String name) {
		DataDescriptionEntriesSymbolTableEntry dataDescriptionEntriesSymbolTableEntry = dataDescriptionEntriesSymbolTable
				.get(getSymbol(name));

		if (dataDescriptionEntriesSymbolTableEntry == null) {
			dataDescriptionEntriesSymbolTableEntry = new DataDescriptionEntriesSymbolTableEntryImpl();
			dataDescriptionEntriesSymbolTable.put(getSymbol(name), dataDescriptionEntriesSymbolTableEntry);
		}

		return dataDescriptionEntriesSymbolTableEntry;
	}

	@Override
	public DataDescriptionEntry createDataDescriptionEntry(
			final DataDescriptionEntryGroup currentDataDescriptionEntryGroup, final DataDescriptionEntryContext ctx) {
		final DataDescriptionEntry result;

		if (ctx.dataDescriptionEntryFormat1() != null) {
			result = addDataDescriptionEntryGroup(ctx.dataDescriptionEntryFormat1());
		} else if (ctx.dataDescriptionEntryFormat2() != null) {
			result = addDataDescriptionEntryRename(ctx.dataDescriptionEntryFormat2());
		} else if (ctx.dataDescriptionEntryFormat3() != null) {
			result = addDataDescriptionEntryCondition(ctx.dataDescriptionEntryFormat3());
		} else if (ctx.dataDescriptionEntryExecSql() != null) {
			result = addDataDescriptionEntryExecSql(ctx.dataDescriptionEntryExecSql());
		} else {
			LOG.warn("unknown data description entry {}", ctx);
			result = null;
		}

		if (currentDataDescriptionEntryGroup != null && result != null) {
			groupDataDescriptionEntry(currentDataDescriptionEntryGroup, result);
		}

		return result;
	}

	@Override
	public List<DataDescriptionEntry> getDataDescriptionEntries() {
		return dataDescriptionEntries;
	}

	@Override
	public List<DataDescriptionEntry> getDataDescriptionEntries(final String name) {
		return dataDescriptionEntriesSymbolTable.get(getSymbol(name)) == null ? new ArrayList<>()
				: dataDescriptionEntriesSymbolTable.get(getSymbol(name)).getDataDescriptionEntries();
	}

	@Override
	public DataDescriptionEntry getDataDescriptionEntry(final String name) {
		return dataDescriptionEntriesSymbolTable.get(getSymbol(name)) == null ? null
				: dataDescriptionEntriesSymbolTable.get(getSymbol(name)).getDataDescriptionEntry();
	}

	@Override
	public List<DataDescriptionEntry> getRootDataDescriptionEntries() {
		final List<DataDescriptionEntry> result = new ArrayList<DataDescriptionEntry>();

		for (final DataDescriptionEntry dataDescriptionEntry : dataDescriptionEntries) {
			if (dataDescriptionEntry.getParentDataDescriptionEntryGroup() == null) {
				result.add(dataDescriptionEntry);
			}
		}

		return result;
	}

	protected void groupDataDescriptionEntry(final DataDescriptionEntryGroup currentDataDescriptionEntryGroup,
			final DataDescriptionEntry dataDescriptionEntry) {
		final Integer currentLevelNumber = currentDataDescriptionEntryGroup.getLevelNumber();
		final Integer levelNumber = dataDescriptionEntry.getLevelNumber();

		if (!isGroupableLevelNumber(levelNumber)) {
		} else if (levelNumber > currentLevelNumber) {
			currentDataDescriptionEntryGroup.addDataDescriptionEntry(dataDescriptionEntry);
			dataDescriptionEntry.setParentDataDescriptionEntryGroup(currentDataDescriptionEntryGroup);
		} else {
			final DataDescriptionEntryGroup currentParentDataDescriptionEntryGroup = currentDataDescriptionEntryGroup
					.getParentDataDescriptionEntryGroup();

			if (currentParentDataDescriptionEntryGroup != null) {
				groupDataDescriptionEntry(currentParentDataDescriptionEntryGroup, dataDescriptionEntry);
			}
		}
	}

	protected boolean isGroupableLevelNumber(final Integer levelNumber) {
		final boolean result = levelNumber != null && DataDescriptionEntry.LEVEL_NUMBER_SCALAR != levelNumber
				&& DataDescriptionEntry.LEVEL_NUMBER_RENAME != levelNumber;
		return result;
	}
}
Tech Fingerprint

Alerts (4)

'ArrayList<' Maintainability Info: Method parameters and return types should generally use interface types (e.g., List<T>, Set<T>, Map<T, K>) instead of concrete implementation types (e.g., ArrayList<T>, HashMap<T, K>). This improves flexibility and hides implementation details.
64
'HashMap<' Maintainability Info: Method parameters and return types should generally use interface types (e.g., List<T>, Set<T>, Map<T, K>) instead of concrete implementation types (e.g., ArrayList<T>, HashMap<T, K>). This improves flexibility and hides implementation details.
66
Complexity hotspot; lines 475 to 476 (total complexity: 5)
475 476