Package com.scivicslab.turingworkflow.plugins.report

Class WorkflowInfoSection

java.lang.Object

com.scivicslab.turingworkflow.plugins.report.WorkflowInfoSection

All Implemented Interfaces:

ReportSection

public class WorkflowInfoSection
extends Object
implements ReportSection

Report section for workflow metadata.

Displays workflow file path, name, and optional description. Returns null title to output content directly without a title line.

Since:

2.15.0

Author:

devteam@scivicslab.com

Constructor Summary

Constructors

Constructor	Description
WorkflowInfoSection(String workflowPath, String name, String description)	Creates a workflow info section.

Method Summary

Modifier and Type	Method	Description
String	getContent()	Returns the section content.
String	getTitle()	Returns the section title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkflowInfoSection

public WorkflowInfoSection(String workflowPath,
 String name,
 String description)

Creates a workflow info section.

Parameters:

workflowPath - the workflow file path

name - the workflow name

description - the workflow description (may be null)

Method Details

getTitle

public String getTitle()

Returns the section title.

If null or empty, the section content is output without a title line.

Always returns null because this section embeds its own title within the content output.

Specified by:

getTitle in interface ReportSection

Returns:

the section title, or null for no title

getContent

public String getContent()

Returns the section content.

If null or empty, the section is skipped in the report.

Returns formatted workflow metadata including file path, name, and description (if present). Each field is indented under a [Workflow Info] header.

Specified by:

getContent in interface ReportSection

Returns:

the section content