Functions
Function Name Description Implemented by
getMigrationEffortPointsForFile Takes a FileModel as a parameter and returns an int containing the effort estimate for this file. org.jboss.windup.reporting.freemarker.GetEffortForFile
iterableToList Turns the given Iterable into a List. org.jboss.windup.reporting.freemarker.IterableToListMethod
generateGUID Generates a unique identifier as a String. org.jboss.windup.reporting.freemarker.GenerateGUIDMethod
getAllFreeMarkerDirectives This method takes no parameters, and returns a List of hashes containing a 'name', 'class', and 'description' field. org.jboss.windup.reporting.freemarker.GetAllFreeMarkerDirectivesMethod
projectModelToApplicationIndex Takes a parameter of type ProjectModel and returns the associated ApplicationReportIndexModel. org.jboss.windup.reporting.freemarker.ProjectModelToApplicationIndexMethod
getProblemSummaries Returns a summary of all classification and hints found during analysis in the form of a List. org.jboss.windup.reporting.freemarker.problemsummary.GetProblemSummariesMethod
projectModelToSha1 Takes a parameter of type ProjectModel and returns the associated ApplicationReportIndexModel. org.jboss.windup.rules.apps.java.reporting.freemarker.ProjectModelToSha1
getEffortDetailsForProjectTraversal Takes a ProjectModel as a parameter and returns Map where the key is the effort level and the value is the number of incidents at that particular level of effort. org.jboss.windup.reporting.freemarker.GetEffortDetailsForProjectTraversalMethod
effortPointsToCssClass Converts from effort points to a CSS class org.jboss.windup.reporting.freemarker.EffortPointsToCssClass
isRulePhase Returns true if the passed in object is an instance of RulePhase. org.jboss.windup.reporting.freemarker.IsRulePhaseMethod
getEffortDescriptionForPoints Given a number of points, return a short textual description (eg, Trivial or Complex). org.jboss.windup.reporting.freemarker.GetEffortDescriptionForPoints
getProjectTraversal Gets a ProjectModelTraversal for the given ProjectModel. An optional parameter specifies the traversal strategy ('only_once', 'all' or 'shared'). org.jboss.windup.reporting.freemarker.GetProjectTraversalMethod
formatRule Takes a Rule as a paremeter and formats it into multiple rows for display. org.jboss.windup.reporting.ruleexecution.FormatRule
getClassificationForFile Takes a FileModel as a parameter and returns an Iterable containing the classification for this file. org.jboss.windup.reporting.freemarker.GetClassificationForFile
getEffortCountForProjectByIssueCategory Parameters are (GraphRewrite, ProjectModelTraversal, [recursive]) and returns Map where the key is the Severity and the value is the number of incidents of that severity. org.jboss.windup.reporting.freemarker.GetEffortCountForProjectByIssueCategoryMethod
findFilesNotClassifiedOrHinted Takes an Iterable as a parameter and returns the files that have neither ClassificationModels nor InlineHintModels associated with them. org.jboss.windup.rules.apps.java.reporting.freemarker.FindFilesNotClassifiedOrHinted
sortDependencyArchivesByPathAscending Takes an Iterable and returns them, ordered alphabetically. org.jboss.windup.rules.apps.java.reporting.freemarker.SortDependencyArchivesByPathMethod
getWindupBrandName Returns the name to use in place of the project name. org.jboss.windup.reporting.freemarker.GetWindupBrandNameMethod
sortApplicationsList Sorts the given list of ApplicationReportModel's by it's root filename or, for VIRTUAL apps, by the name. org.jboss.windup.reporting.freemarker.SortApplicationsListMethod
getPrettyPathForFile Takes a FileModel as a parameter and either the qualified name (if it is a Java file) or the path within the file's project. org.jboss.windup.rules.apps.java.reporting.freemarker.filepath.GetPrettyPathForFile
markdownToHtml Converts from an input string in Markdown format to an output string in HTML format org.jboss.windup.reporting.freemarker.MarkdownToHtmlMethod
groupHints Takes an Iterable of Hints and returns map that groups hint messages to number of occurences org.jboss.windup.rules.apps.java.reporting.freemarker.GroupHintsByFile
getArchiveSHA1ToPathMapper Gets an instance of a mapper for converting from the SHA1 hash of an archive to a List of file paths. org.jboss.windup.reporting.freemarker.GetArchiveSHA1ToPathsMapperMethod
getRuleExecutionResults Takes a parameter of type AbstractRuleProvider and returns a List containing metadata related to the current Red Hat Application Migration Toolkit execution. org.jboss.windup.reporting.ruleexecution.GetRuleExecutionResults
sortProjectTraversalsByPathAscending Takes an Iterable and returns them, ordered alphabetically. org.jboss.windup.reporting.freemarker.SortProjectTraversalsByPathMethod
fileModelToSourceReport Takes a FileModel as a parameter, and returns the related SourceReportModel (or null if none is available). org.jboss.windup.reporting.freemarker.FileModelToSourceReportModelMethod
isReportableFile Takes a FileModel and a set of tags to include and exclude as parameters, and whether or not this file should appear in overview reports org.jboss.windup.reporting.freemarker.IsReportableFile
sortDependencyGroupArchivesByPathAscending Takes an Iterable and returns them, ordered alphabetically. org.jboss.windup.rules.apps.java.reporting.freemarker.SortDependencyGroupArchiveByPathMethod
getPrettyPathForFileWithExtensions Takes a FileModel as a parameter and either the qualified name (if it is a Java file) or the path within the file's project. org.jboss.windup.rules.apps.java.reporting.freemarker.filepath.GetPrettyPathForFileWithExtensions
getTechnologyTagsForProjectTraversal Takes a ProjectModel as a parameter and returns an Iterable containing the technology tags for this project (and all subprojects). org.jboss.windup.reporting.freemarker.GetTechnologyTagsForProject
getTagsFromFileClassificationsAndHints Takes a FileModel as a parameter and returns an Set containing the tags from the classifications associated with the provided this file. org.jboss.windup.reporting.freemarker.GetTagsFromFileClassificationsAndHints
iterableHasContent Takes an Iterable as a parameter and checks to see whether items exist in the Iterable. org.jboss.windup.rules.apps.java.reporting.freemarker.IterableHasContent
projectModelToOrganizations Takes a parameter of type ProjectModel and returns the associated OrganizationModels. org.jboss.windup.reporting.freemarker.ProjectModelToOrganizationsMethod
getAllRuleProviders Takes no parameters and returns a List containing all loaded Rule Providers. org.jboss.windup.reporting.ruleexecution.GetAllRuleProviders
getAllFreeMarkerMethods This method takes no parameters, and returns a List of hashes containing a 'name', 'description', and 'class' field. org.jboss.windup.reporting.freemarker.GetAllFreeMarkerMethodsMethod
sortProjectsByPathAscending Takes an Iterable and returns them, ordered alphabetically. org.jboss.windup.reporting.freemarker.SortProjectsByPathMethod
sortFilesByPathAscending Takes an Iterable or Iterable and returns them, ordered alphabetically. org.jboss.windup.reporting.freemarker.SortFilesByPathMethod
getTechnologyTagsForFile Takes a FileModel as a parameter and returns an Iterable containing the technology tags for this file. org.jboss.windup.reporting.freemarker.GetTechnologyTagsForFile
findSourceFilesByClassName Finds all JavaSourceFileModels for the given fully qualified class name org.jboss.windup.rules.apps.java.reporting.freemarker.FindSourceFilesByClassNameMethod
Directives
Directive Name Directive Class Description
render_link org.jboss.windup.rules.apps.java.reporting.freemarker.RenderLinkDirective Takes the following parameters: FileModel (a FileModel) (Implemented by: org.jboss.windup.rules.apps.java.reporting.freemarker.RenderLinkDirective)
render_pie org.jboss.windup.rules.apps.java.reporting.freemarker.RenderApplicationPieChartDirective Renders a pie chart. Takes the following parameters: project (a ProjectModel), recursive (Boolean), and elementid (HTML ID of the element in which to render). (Implemented by: org.jboss.windup.rules.apps.java.reporting.freemarker.RenderApplicationPieChartDirective)
write_to_disk org.jboss.windup.reporting.freemarker.WriteToDiskDirective Writes the contents of the directive to disk (Implemented by: org.jboss.windup.reporting.freemarker.WriteToDiskDirective)
render_rule_link org.jboss.windup.reporting.freemarker.RenderRuleLinkDirective Renders a link to the Rule with the specified ID in the Rule Provider report. (Implemented by: org.jboss.windup.reporting.freemarker.RenderRuleLinkDirective)
FreeMarker version used: 2.3.26-incubating