kieker.tools.trace.analysis.repository.DescriptionRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tools Show documentation
Kieker: Application Performance Monitoring and Dynamic Software Analysis
The newest version!
/***************************************************************************
 * Copyright 2022 Kieker Project (http://kieker-monitoring.net)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ***************************************************************************/

package kieker.tools.trace.analysis.repository;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import kieker.analysis.IProjectContext;
import kieker.analysis.plugin.annotation.Property;
import kieker.analysis.repository.AbstractRepository;
import kieker.analysis.repository.annotation.Repository;
import kieker.common.configuration.Configuration;

/**
 * Implementation of a description repository which stores descriptions for names.
 *
 * @author Holger Knoche
 *
 * @since 1.6
 * @deprecated since 2.0.0
 */
@Repository(name = "Description repository",
		description = "Stores descriptions for names",
		configuration = {
			@Property(name = DescriptionRepository.CONFIG_PROPERTY_NAME_DESCRIPTION_FILE_NAME, defaultValue = "")
		})
@Deprecated
public class DescriptionRepository extends AbstractRepository {

	/**
	 * Name of the configuration property that contains the file name of the description file.
	 */
	public static final String CONFIG_PROPERTY_NAME_DESCRIPTION_FILE_NAME = "descriptionFileName";

	private static final char DELIMITER = '=';

	private static final String ENCODING = "UTF-8";

	private final ConcurrentMap descriptionMap;

	/**
	 * Creates a new description repository using the given configuration.
	 *
	 * @param configuration
	 *            The configuration to use
	 * @param projectContext
	 *            The project context for this plugin.
	 *
	 * @throws IOException
	 *             If an I/O error occurs during initialization
	 */
	public DescriptionRepository(final Configuration configuration, final IProjectContext projectContext) throws IOException {
		this(configuration, DescriptionRepository.readDataFromFile(configuration.getStringProperty(CONFIG_PROPERTY_NAME_DESCRIPTION_FILE_NAME)), projectContext);
	}

	/**
	 * Creates a new description repository using the given data.
	 *
	 * @param configuration
	 *            The configuration to use
	 * @param descriptionData
	 *            The description data to use
	 * @param projectContext
	 *            The project context to use.
	 */
	public DescriptionRepository(final Configuration configuration, final DescriptionRepositoryData descriptionData, final IProjectContext projectContext) {
		super(configuration, projectContext);

		this.descriptionMap = descriptionData.getDescriptionMap();
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Configuration getCurrentConfiguration() {
		return this.configuration;
	}

	/**
	 * Returns the description map (node id -> description) contained in this repository.
	 *
	 * @return See above
	 */
	public Map getDescriptionMap() {
		return Collections.unmodifiableMap(this.descriptionMap);
	}

	private static String[] splitLine(final String inputLine) {
		final int delimiterIndex = inputLine.indexOf(DELIMITER);
		if (delimiterIndex < 0) {
			return null; // FindBugs doesn't like it (PZLA_PREFER_ZERO_LENGTH_ARRAYS)
		}

		final String[] returnValue = new String[2];
		returnValue[0] = inputLine.substring(0, delimiterIndex);
		returnValue[1] = inputLine.substring(delimiterIndex + 1);

		return returnValue;
	}

	/**
	 * Initializes a new description repository from the given file.
	 *
	 * @param fileName
	 *            The name of the file to use.
	 * @param projectContext
	 *            The project context to use.
	 * @return The initialized description repository
	 *
	 * @throws IOException
	 *             If an I/O error occurs
	 */
	public static DescriptionRepository createFromFile(final String fileName, final IProjectContext projectContext) throws IOException {
		final Configuration configuration = new Configuration();
		configuration.setProperty(CONFIG_PROPERTY_NAME_DESCRIPTION_FILE_NAME, fileName);
		return new DescriptionRepository(configuration, DescriptionRepository.readDataFromFile(fileName), projectContext);
	}

	private static DescriptionRepositoryData readDataFromFile(final String fileName) throws IOException {
		try (BufferedReader reader = new BufferedReader(new InputStreamReader(Files.newInputStream(Paths.get(fileName)), ENCODING))) {
			final ConcurrentMap descriptionMap = new ConcurrentHashMap<>();

			while (true) {
				final String currentLine = reader.readLine();
				if (currentLine == null) {
					break;
				}

				final String[] parts = DescriptionRepository.splitLine(currentLine);
				if (parts == null) {
					continue;
				}

				final String key = parts[0];
				final String description = parts[1];
				descriptionMap.put(key, description);
			}
			return new DescriptionRepositoryData(descriptionMap);
		}
	}

	/**
	 * This class groups the data required for a {@link DescriptionRepository}.
	 *
	 * @author Holger Knoche
	 *
	 * @since 1.6
	 */
	public static class DescriptionRepositoryData {

		private final ConcurrentMap descriptionMap;

		/**
		 * Creates a new data object using the given description map.
		 *
		 * @param descriptionMap
		 *            The description map (node id, see {@link kieker.tools.trace.analysis.filter.visualization.graph.AbstractGraphElement#getIdentifier()} ->
		 *            description) to use
		 */
		public DescriptionRepositoryData(final ConcurrentMap descriptionMap) {
			this.descriptionMap = descriptionMap;
		}

		ConcurrentMap getDescriptionMap() { // NOPMD package for outer class
			return this.descriptionMap;
		}

	}
}