Reporter (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.report.Reporter

Direct Known Subclasses:

AccumulateReporter, AggregateReporter, BerthReporter, BinReporter, BlockReporter, BoolStatisticReporter, CondQueueReporter, CountReporter, DataListHistogramReporter, DistributionReporter, EntrepotReporter, FlexReporterBuilder.FlexReporter, HistogramAccumulateReporter, HistogramReporter, ModelReporter, ProcessQueueReporter, QueueReporter, RegressionReporter, ResourceReporter, SmartReporter, StandardReporter, StockReporter, TableReporter, TallyReporter, TextHistogramReporter, TimeSeriesReporter, TransportReporter, WaitQueueReporter, WorkStationReporter, YardReporter
```
public abstract class Reporter
extends java.lang.Object
```
Declares the basic methods needed for reporter to be able to print reports about a model component. Since individual components need individual reports each component has to specify a special reporter to print its data. Derive from this class to implement the reporter for the specific Reportable class.

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.

See Also:

Reportable

Constructor Summary

Constructors
Constructor and Description
`Reporter(Reportable informationSource)` Creates a reporter for the given reportable information source.
`Reporter(Schedulable source)` Creates a reporter for the given Schedulable information source.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getColumnTitles()` Returns an array of Strings each containing the title for the corresponding entry in array `entries[]`.
`java.lang.String`	`getDescription()` Get an optional description of this Reporter's Reportable to be included in the report.
`abstract java.lang.String[]`	`getEntries()` Returns an array of strings each containing the data for the corresponding column in array `columns[]`.
`int`	`getGroupID()` Returns the ID of the group this reporter belongs to.
`java.lang.String`	`getHeading()` Returns the heading for the group this reporter belongs to.
`Model`	`getModel()` Returns the Model that the Reportable belongs to that this reporter produces a report about.
`int`	`getNumOfSlaveQueues()`
`Reportable`	`getReportable()` Returns the reportable object that this reporter contains informations about.
`boolean`	`isContinuingReporter()`
`static boolean`	`isEqual(Reporter a, Reporter b)` Compares the ID's of the two given reporters and returns `true` if both have the same ID, `false` if their ID's are different.
`static boolean`	`isLarger(Reporter a, Reporter b)` Compares the ID's of the two given reporters and returns `true` if reporter 'a' has a higher ID than reporter 'b', `false` if not.
`static boolean`	`isOtherGroup(Reporter a, Reporter b)` Compares the ID's of the two given reporters and returns `true` if reporter 'a' belongs to a different group of ID's than reporter 'b', `false` if not.
`static boolean`	`isSameGroup(Reporter a, Reporter b)` Compares the ID's of the two given reporters and returns `true` if reporter 'a' belongs to the same group of ID's as reporter 'b', `false` if not.
`boolean`	`isTwoRowReporter()`
`boolean`	`makeAdditionalColorEntryIfHTMLColorChartIsGenerated()`
`int`	`numColumns()` Returns the number of columns or data this reporter is containing.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Reporter
```
public Reporter(Reportable informationSource)
```
    Creates a reporter for the given reportable information source.
    
    Parameters:
    
    informationSource - desmoj.core.simulator.Reportable : The source of information to report about
  - Reporter
```
public Reporter(Schedulable source)
```
    Creates a reporter for the given Schedulable information source. This Schedulable must have a corresponding Reportable assigned via setCorrespondingReportable(Reportable).
    
    Parameters:
    
    Schedulable - desmoj.core.simulator.Schedulable : The Schedulable to report about
- Method Detail
  - getColumnTitles
```
public java.lang.String[] getColumnTitles()
```
    Returns an array of Strings each containing the title for the corresponding entry in array entries[].
    
    Returns:
    
    java.lang.String[] : Array containing column titles
  - getEntries
```
public abstract java.lang.String[] getEntries()
```
    Returns an array of strings each containing the data for the corresponding column in array columns[]. Implement this method the an array of the same length as the columntitles is produced containing the data at the point of time this method is called by someone else to produce up-to-date information.
    
    Returns:
    
    java.lang.String[] : Array containing the data for reporting
  - getGroupID
```
public int getGroupID()
```
    Returns the ID of the group this reporter belongs to. The group-ID is used to give reporters a key to be ordered by. This allows reporters of the same group to be printed together in one table in a report file.
    
    Returns:
    
    int : The reporter's group ID
  - getHeading
```
public java.lang.String getHeading()
```
    Returns the heading for the group this reporter belongs to. This can easily be used as a heading in the reporter to introduce a new group of reporters.
    
    Returns:
    
    java.lang.String : The group heading for this group of reporters
  - getModel
```
public Model getModel()
```
    Returns the Model that the Reportable belongs to that this reporter produces a report about.
    
    Returns:
    
    Model : The Model the reporter's reportable belongs to
  - getReportable
```
public Reportable getReportable()
```
    Returns the reportable object that this reporter contains informations about.
    
    Returns:
    
    desmoj.core.simulator.Reportable : The reportable this reporter carries information about
  - isEqual
```
public static boolean isEqual(Reporter a,
                              Reporter b)
```
    Compares the ID's of the two given reporters and returns true if both have the same ID, false if their ID's are different.
    
    Parameters:
    
    a - desmoj.report.Reporter : comparand a
    
    b - desmoj.report.Reporter : comparand b
    
    Returns:
    
    boolean : Is true if both reporter's ID's are the same, false if not
  - isLarger
```
public static boolean isLarger(Reporter a,
                               Reporter b)
```
    Compares the ID's of the two given reporters and returns true if reporter 'a' has a higher ID than reporter 'b', false if not.
    
    Parameters:
    
    a - desmoj.report.Reporter : comparand a
    
    b - desmoj.report.Reporter : comparand b
    
    Returns:
    
    boolean : Is true if reporter 'a' has a higher ID than reporter 'b', false if not
  - isOtherGroup
```
public static boolean isOtherGroup(Reporter a,
                                   Reporter b)
```
    Compares the ID's of the two given reporters and returns true if reporter 'a' belongs to a different group of ID's than reporter 'b', false if not.
    
    Parameters:
    
    a - desmoj.report.Reporter : comparand a
    
    b - desmoj.report.Reporter : comparand b
    
    Returns:
    
    boolean : Is true if reporter 'a' has an ID belonging to a different group than reporter 'b', false if not
  - isSameGroup
```
public static boolean isSameGroup(Reporter a,
                                  Reporter b)
```
    Compares the ID's of the two given reporters and returns true if reporter 'a' belongs to the same group of ID's as reporter 'b', false if not.
    
    Parameters:
    
    a - desmoj.report.Reporter : comparand a
    
    b - desmoj.report.Reporter : comparand b
    
    Returns:
    
    boolean : Is true if reporter 'a' has an ID belonging to the same group as reporter 'b', false if not
  - numColumns
```
public int numColumns()
```
    Returns the number of columns or data this reporter is containing.
    
    Returns:
    
    int : The number of columns/data this reporter is containing
  - getDescription
```
public java.lang.String getDescription()
```
    Get an optional description of this Reporter's Reportable to be included in the report. Default is null.
    
    Returns:
    
    String : Description
  - isContinuingReporter
```
public boolean isContinuingReporter()
```
  - isTwoRowReporter
```
public boolean isTwoRowReporter()
```
  - getNumOfSlaveQueues
```
public int getNumOfSlaveQueues()
```
  - makeAdditionalColorEntryIfHTMLColorChartIsGenerated
```
public boolean makeAdditionalColorEntryIfHTMLColorChartIsGenerated()
```

Class Reporter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Reporter

Reporter

Method Detail

getColumnTitles

getEntries

getGroupID

getHeading

getModel

getReportable

isEqual

isLarger

isOtherGroup

isSameGroup

numColumns

getDescription

isContinuingReporter

isTwoRowReporter

getNumOfSlaveQueues

makeAdditionalColorEntryIfHTMLColorChartIsGenerated