• Home
• info.mikaelsvensson.devtools
• analysis
• 1.2.1
• source code
• AbstractAnalyzer.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

info.mikaelsvensson.devtools.analysis.shared.AbstractAnalyzer Maven / Gradle / Ivy

/*
 * Copyright 2014 Mikael Svensson
 *
 *    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 info.mikaelsvensson.devtools.analysis.shared;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Option;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.text.StrSubstitutor;

import java.io.File;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;

@CliOptions(opts = {
        @CliOptionConfig(
                argsDescription = "output report file path",
                description = "file name for the report",
                required = true,
                longName = AbstractAnalyzer.OPT_REPORT_FILE_NAME,
                numArgs = 1,
                name = "rfn"),
        @CliOptionConfig(
                argsDescription = "input log files",
                description = "list of log files to analyze",
                required = true,
                longName = AbstractAnalyzer.OPT_FILES,
                numArgs = OptionUtil.UNLIMITED,
                name = "f")
})
public abstract class AbstractAnalyzer {
    protected static final String FILE_PATH_GROUPER_DESCRIPTION = "optional string (none|merged|merge_by_folder) which, if present, affects which files are covered by each generated report ('none' = each log file processed individually, 'merge_all' = all log files will be used to generate a single report, 'merge_by_folder' = log files from the same folder will be processed together).";
    static final String OPT_REPORT_FILE_NAME = "report-file-name";
    static final String OPT_FILES = "files";

    protected void run(String[] args, Option... commandLineOptions) throws Exception
    {
        run(args, OptionUtil.getInstance().getCliHelp(this), commandLineOptions);
    }
    protected void run(String[] args, String usageHelp, Option... commandLineOptions) throws Exception
    {
        List options = OptionUtil.getInstance().getOptions(this);
        if (commandLineOptions != null && commandLineOptions.length > 0) {
            options.addAll(Arrays.asList(commandLineOptions));
        }

        final CommandLine commandLine = CommandLineUtil.parseArgs(args, usageHelp, this.getClass(), options.toArray(new Option[options.size()]));

        String reportFileName = commandLine.getOptionValue(OPT_REPORT_FILE_NAME);
        String[] files = commandLine.getOptionValues(OPT_FILES);
        runImpl(commandLine, files, reportFileName);
    }

    protected abstract void runImpl(CommandLine commandLine, String[] files, String reportFileName) throws Exception;

    public static String getFormattedString(String pattern, File patternArgumentSourceFile) {
        // LinkedHashMap since the values should be returned in the order of insertion (for backwards compatibility)
        final LinkedHashMap values = new LinkedHashMap();
        values.put("logFileName", patternArgumentSourceFile.getName());
        values.put("logFileNameWithoutExt", StringUtils.substringBeforeLast(patternArgumentSourceFile.getName(), "."));
        values.put("logFilePath", StringUtils.substringBeforeLast(patternArgumentSourceFile.getAbsolutePath(), "."));
        values.put("logFilePathWithoutExt", StringUtils.substringBeforeLast(patternArgumentSourceFile.getAbsolutePath(), "."));
        values.put("parentName", patternArgumentSourceFile.getParentFile().getName());
        values.put("parentPath", patternArgumentSourceFile.getParentFile().getAbsolutePath());

        // Add numeric "key" for each "parameter" (for backwards compability)
        int i = 0;
        for (Object value : values.values().toArray()) {
            values.put(String.valueOf(i++), value);
        }

        // Use {key} format instead of ${key}, thus providing backwards compatibility with previously used MessageFormat.
        return StrSubstitutor.replace(pattern, values, "{", "}");
    }
}