jmri.implementation
Class AbstractReporter

java.lang.Object
  jmri.implementation.AbstractNamedBean
      jmri.implementation.AbstractReporter

All Implemented Interfaces:

Serializable, NamedBean, Reporter

Direct Known Subclasses:

JMRIClientReporter, LnReporter, RfidReporter, RpsReporter

public abstract class AbstractReporter
extends AbstractNamedBean
implements Reporter, Serializable

Abstract base for the Reporter interface.

Implements the parameter binding support.

Note that we consider it an error for there to be more than one object that corresponds to a particular physical Reporter on the layout. Description: Abstract class providing the basic logic of the Reporter interface

Author:

Bob Jacobsen Copyright (C) 2001, Matthew Harris Copyright (C) 2011

See Also:

Serialized Form

Field Summary

Fields inherited from class jmri.implementation.AbstractNamedBean

mSystemName, mUserName

Fields inherited from interface jmri.NamedBean

INCONSISTENT, UNKNOWN

Constructor Summary

AbstractReporter(String systemName)

AbstractReporter(String systemName, String userName)

Method Summary

Object	getCurrentReport() Query the current report.
Object	getLastReport() Query the last report.
void	setReport(Object r) Provide a general method for updating the report.

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, getComment, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyKeys, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setUserName, updateListenerRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Reporter

getState

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, dispose, getComment, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyKeys, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setState, setUserName, updateListenerRef

Constructor Detail

AbstractReporter

public AbstractReporter(String systemName)

AbstractReporter

public AbstractReporter(String systemName,
                        String userName)

Method Detail

getCurrentReport

public Object getCurrentReport()

Description copied from interface: Reporter

Query the current report. If there is no current report available (e.g. the reporting hardware says no information is currently available) this will return a null object.

Specified by:

getCurrentReport in interface Reporter

getLastReport

public Object getLastReport()

Description copied from interface: Reporter

Query the last report. This will return a value even if there's no current report available. If there is a current report, both this and the current report will be equal. If nothing has ever been reported, this will return a null object.

Specified by:

getLastReport in interface Reporter

setReport

public void setReport(Object r)

Provide a general method for updating the report.

Specified by:

setReport in interface Reporter