desmoj.core.statistic

Class TextHistogram

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.TextHistogram

All Implemented Interfaces:

java.util.Observer

public class TextHistogram
extends Reportable
implements java.util.Observer

The TextHistogram class is providing a statistic analysis about text values. Given Strings are counted and the report will show the amount of every given text. If the given parameter is a null pointer it will not be counted.

Version:

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

Author:

Lorna Slawski, based on the classes Histogram and ValueStatistics from Soenke Claassen, based on DESMO-C from Thomas Schniewind, 1998 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
TextHistogram(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a TextHistogram object that will NOT be connected to a TextSupplier.
TextHistogram(Model ownerModel, java.lang.String name, TextSupplier textSup, boolean showInReport, boolean showInTrace) Constructor for a TextHistogram object that will be connected to a TextSupplier.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this TextHistogram.
java.lang.String	getLastString() Returns the last observed String of this TextHistogram object.
java.lang.String	getLeastFrequentedString() Returns the String with the least number of entries.
java.lang.String	getMostFrequentedString() Returns the String with the largest number of entries.
int	getNumberOfStringsObserved() Returns the number of Strings observed.
long	getObservationsOfString(java.lang.String obsStr) Returns the number of observations for the given String.
java.lang.String[]	getStringsObserved() Returns an array of Strings observed.
void	reset() Resets this TextHistogram object by deleting all observed Strings.
void	update() Updates this TextHistogram object by fetching the actual value of the TextSupplier and processing it.
void	update(java.util.Observable o, java.lang.Object arg) Implementation of the virtual update(Observable, Object) method of the Observer interface.
void	update(java.lang.String updateStr) Updates this TextHistogram object with the String value given as parameter.

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, resetAt, setCorrespondingSchedulable, setDescription, setReporter

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TextHistogram

public TextHistogram(Model ownerModel,
                     java.lang.String name,
                     boolean showInReport,
                     boolean showInTrace)

Constructor for a TextHistogram object that will NOT be connected to a TextSupplier.

Parameters:

ownerModel - Model : The model this TextHistogram is associated to.

name - java.lang.String : The name of this TextHistogram object.

showInReport - boolean : Flag for showing the report about this Histogram.

showInTrace - boolean : Flag for showing the trace output of this Histogram.

TextHistogram

public TextHistogram(Model ownerModel,
                     java.lang.String name,
                     TextSupplier textSup,
                     boolean showInReport,
                     boolean showInTrace)

Constructor for a TextHistogram object that will be connected to a TextSupplier.

Parameters:

ownerModel - Model : The model this TextHistogram is associated to.

name - java.lang.String : The name of this TextHistogram object.

textValSup - TextSupplier : The TextSupplier providing the String for this TextHistogram. The given TextValueSupplier will be observed by this TextHistogram object.

showInReport - boolean : Flag for showing the report about this TextHistogram.

showInTrace - boolean : Flag for showing the trace output of this TextHistogram.

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this TextHistogram.

Returns:

desmoj.report.TextHistogramReporter : The Reporter for this TextHistogram.

getLastString

public java.lang.String getLastString()

Returns the last observed String of this TextHistogram object.

Returns:

java.lang.String : The last String observed so far.

getLeastFrequentedString

public java.lang.String getLeastFrequentedString()

Returns the String with the least number of entries. Several Strings are separated by a comma. If there are no entries yet an empty String ("") is being returned.

Returns:

java.lang.String: The String with the least number of entries.

getMostFrequentedString

public java.lang.String getMostFrequentedString()

Returns the String with the largest number of entries. Several Strings are separated by a comma. If there are no entries yet an empty String ("") is being returned.

Returns:

java.lang.String: The String with the highest number of entries.

getNumberOfStringsObserved

public int getNumberOfStringsObserved()

Returns the number of Strings observed.

Returns:

int : The number of Strings which have been observed.

getObservationsOfString

public long getObservationsOfString(java.lang.String obsStr)

Returns the number of observations for the given String.

Parameters:

obsStr - java.lang.String: The String of which want to get the number of observations made for.

Returns:

long : The number of observations for the given String.

getStringsObserved

public java.lang.String[] getStringsObserved()

Returns an array of Strings observed.

Returns:

java.lang.String[] : The array of Strings observed.

reset

public void reset()

Resets this TextHistogram object by deleting all observed Strings.

Overrides:

reset in class Reportable

update

public void update()

Updates this TextHistogram object by fetching the actual value of the TextSupplier and processing it. If the actual value is a null pointer it will not be counted and an error is given out in the error report. The TextSupplier is passed in the constructor of this TextHistogram object. This update() method complies with the one described in DESMO, see [Page91].

update

public void update(java.lang.String updateStr)

Updates this TextHistogram object with the String value given as parameter. If the parameter is a null pointer it will not be counted and an error is given out in the error report. In some cases it might be more convenient to pass the String value this TextHistogram will be updated with directly within the update(String updateStr) method instead of going via the TextSupplier.

Parameters:

updateStr - String : The String with which this TextHistogram will be updated.

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Implementation of the virtual update(Observable, Object) method of the Observer interface. This method will be called automatically from an Observable object within its notifyObservers() method.
If no Object (anull value) is passed as arg, the actual value of the TextSupplier will be fetched with the text() method of the TextSupplier. Otherwise it is expected that the actual text is passed in the Object arg. If the the actual value is a null pointer it will not be counted and an error is given out in the error report.

Specified by:

update in interface java.util.Observer

Parameters:

o - java.util.Observable : The Observable calling this method within its own notifyObservers() method.

arg - Object : The Object with which this Statistic Object is updated. Normally a String which is added to the statistics or null when there is an actual text to be given with the text() method.