desmoj.core.report

Class ModelReporter

java.lang.Object

desmoj.core.report.Reporter

desmoj.core.report.ModelReporter

public class ModelReporter
extends Reporter

The Reporter for a model. Carries references to all Reportables and submodels of the Model it reports about. This enables it to produce a vector containing the reportable's reporters ordered by group-ID. It also takes care to retrieve the submodel's reporters recursively.

Version:

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

Author:

Tim Lechler 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.

Constructor Summary

Constructors

Constructor and Description
ModelReporter(Model model) Creates a reporter for the given model.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getEntries() The ModelReporter returns the description of the model.
java.util.List<Reporter>	getReporters() Returns a list of view of all reportable's reporters ordered by group-ID.

Methods inherited from class desmoj.core.report.Reporter

getColumnTitles, getDescription, getGroupID, getHeading, getModel, getNumOfSlaveQueues, getReportable, isContinuingReporter, isEqual, isLarger, isOtherGroup, isSameGroup, isTwoRowReporter, makeAdditionalColorEntryIfHTMLColorChartIsGenerated, numColumns

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelReporter

public ModelReporter(Model model)

Creates a reporter for the given model. This special reporter retrieves all other reporters associated to the reportable objects registered at the model. These are collected in a vector, ordered by group-ID to be sent to the report output when a report is required.

Parameters:

model - Model : The model to report about.

Method Detail

getEntries

public java.lang.String[] getEntries()

The ModelReporter returns the description of the model.

Specified by:

getEntries in class Reporter

Returns:

java.lang.String[] : Array containing the data for reporting

getReporters

public java.util.List<Reporter> getReporters()

Returns a list of view of all reportable's reporters ordered by group-ID.

Returns:

java.util.List : The vector containing the reporters associated to the modelreporter