desmoj.core.statistic

Class TextSupplier

java.lang.Object

java.util.Observable

desmoj.core.statistic.TextSupplier

public abstract class TextSupplier
extends java.util.Observable

Supplies observers with texts of their interest. It resembles the "observable" part of the observer pattern as described in [Gamm95]. Thus it extends the standard "Observable" class provided by the Java.util package.

Version:

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

Author:

Lorna Slawski based on the class ValueSupplier, 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
TextSupplier(java.lang.String name) Constructs a simple TextSupplier by giving it a name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the named object.
java.lang.String	getQuotedName() Returns the quoted name of the named object.
void	notifyStatistics(java.lang.Object arg) Indicates that this TextSupplier (as an Observable) has changed and notifies all its observers of this change providing the modified text as parameter.
void	rename(java.lang.String newName) Changes the name of the named object.
abstract java.lang.String	text() When using the Pull-Model or the automatic update function this method must be overridden by the user in a way that it provides the text (as a
java.lang.String	toString() Overrides the java.lang.Object's toString method to return the named object's name when given as parameter to a method that expects a string to be passed.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

TextSupplier

public TextSupplier(java.lang.String name)

Constructs a simple TextSupplier by giving it a name.

Method Detail

getName

public java.lang.String getName()

Returns the name of the named object. This is the same name displayed in reports and trace files when this named object is shown in those reports or trace files.

Returns:

java.lang.String : The name of the named object.

getQuotedName

public java.lang.String getQuotedName()

Returns the quoted name of the named object. This is the name displayed in reports and trace files when this named object is shown.

Returns:

java.lang.String : The quoted name of the named object

notifyStatistics

public void notifyStatistics(java.lang.Object arg)

Indicates that this TextSupplier (as an Observable) has changed and notifies all its observers of this change providing the modified text as parameter. This is the "Push-model", thus pushing the String (in the parameter

Parameters:

arg - Object : The Object wrapping the text with which the observers will be updated.

rename

public void rename(java.lang.String newName)

Changes the name of the named object. This might be necessary for an automatically created named object of a user defined model, but should not be used for elements of the framework or basic objects of the user model. Changing names of objects while runtime will confuse any trace output and generally make traces more difficult if not impossible to follow.

Parameters:

newName - java.lang.String : The new name for the named object.

text

public abstract java.lang.String text()

When using the Pull-Model or the automatic update function this method must be overridden by the user in a way that it provides the text (as a

Returns:

String : The String within this method.

toString

public java.lang.String toString()

Overrides the java.lang.Object's toString method to return the named object's name when given as parameter to a method that expects a string to be passed.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String : The named object's name.