desmoj.extensions.chaining.report

Class FlexReporterBuilder

java.lang.Object

desmoj.extensions.chaining.report.FlexReporterBuilder

public class FlexReporterBuilder
extends java.lang.Object

The FlexReporterBuilder is a helper class for constructing FlexReporterBuilder.FlexReporters which are special Reporters whose content (i.e. the cells that may displayed in multiple rows) is defined dynamically.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Malte Unkrig 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FlexReporterBuilder.Cell Represents a cell that will be drawn in a report
class	FlexReporterBuilder.FlexReporter A flexible reporter that allows multiple rows with individual formatted cells.
class	FlexReporterBuilder.HeadingCell A cell that should be visually displayed as a heading cell in the report.
class	FlexReporterBuilder.Row Represents a row that will be drawn in the report.

Constructor Summary

Constructors

Constructor and Description
FlexReporterBuilder(java.lang.String groupHeading, int groupId) Constructs a new FlexReporterBuilder with the given group heading and group id.

Method Summary

Modifier and Type	Method and Description
FlexReporterBuilder.FlexReporter	build() Builds a FlexReporter from all the rows and cells that have been added to this builder
FlexReporterBuilder	closeRow() Closes the row currently under construction
FlexReporterBuilder.Row	openRow() Opens a new row for constructrion

Methods inherited from class java.lang.Object

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

Constructor Detail

FlexReporterBuilder

public FlexReporterBuilder(java.lang.String groupHeading,
                           int groupId)

Constructs a new FlexReporterBuilder with the given group heading and group id.

Parameters:

groupHeading - The group heading that will be used when the FlexReporter is built with this builder

groupId - The group id that will be used when the FlexReporter is built with this builder

Method Detail

build

public FlexReporterBuilder.FlexReporter build()

Builds a FlexReporter from all the rows and cells that have been added to this builder

Returns:

The newly build FlexReporter

closeRow

public FlexReporterBuilder closeRow()

Closes the row currently under construction

Returns:

The FlexReporterBuilder for chaining

openRow

public FlexReporterBuilder.Row openRow()

Opens a new row for constructrion

Returns:

the new row for chaining