Package jmri.jmrit.audio

Class DefaultAudioSourceManager

java.lang.Object

jmri.jmrit.audio.DefaultAudioSourceManager

All Implemented Interfaces:

AudioManager, AudioSourceManager, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeProvider, Manager<Audio>

public class DefaultAudioSourceManager
extends Object
implements AudioSourceManager

The default AudioSourceManager.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Manager

Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity

Field Summary

Fields inherited from interface jmri.AudioManager

MAX_BUFFERS, MAX_LISTENERS, MAX_SOURCES

Fields inherited from interface jmri.Manager

ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_GLOBAL_VARIABLES, LOGIXNG_MODULES, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, PROPERTY_BEANS, PROPERTY_CAN_DELETE, PROPERTY_DISPLAY_LIST_NAME, PROPERTY_DO_DELETE, PROPERTY_DO_NOT_DELETE, PROPERTY_LENGTH, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Constructor Summary

Constructors

Constructor	Description
DefaultAudioSourceManager()

Method Summary

Modifier and Type	Method	Description
void	addDataListener(Manager.ManagerDataListener<Audio> e)	Register a Manager.ManagerDataListener to hear about adding or removing items from the list of NamedBeans.
void	addPropertyChangeListener(PropertyChangeListener listener)	Add a PropertyChangeListener to the listener list.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)	Add a PropertyChangeListener for a specific property.
void	addVetoableChangeListener(VetoableChangeListener listener)	Add a VetoableChangeListener to the listener list.
void	addVetoableChangeListener(String propertyName, VetoableChangeListener listener)	Add a VetoableChangeListener for a specific property.
void	cleanup()	Perform any clean-up operations
void	deleteBean(Audio n, String property)	Method for a UI to delete a bean.
void	deregister(Audio n)	Forget a NamedBean Object created outside the manager.
void	dispose()	Free resources when no longer used.
AudioFactory	getActiveAudioFactory()	Returns the currently active AudioFactory object.
Audio	getAudio(String name)	Get an existing Audio or return null if it doesn't exists.
String	getBeanTypeHandled(boolean plural)	Get the user-readable name of the type of NamedBean handled by this manager.
Audio	getBySystemName(String systemName)	Get the Audio with the given system name or return null if no instance already exists.
Audio	getByUserName(String userName)	Get the Audio with the given user name or return null if no instance already exists.
SystemConnectionMemo	getMemo()	Get the system connection for this manager.
Audio	getNamedBean(String name)	Locate an existing instance based on a name.
Class<Audio>	getNamedBeanClass()	Get the class of NamedBean supported by this Manager.
SortedSet<Audio>	getNamedBeanSet()	Provide an unmodifiable SortedSet of NamedBeans in system-name order.
SortedSet<Audio>	getNamedBeanSet(char subType)	Get the specified Audio sub-type NamedBeans.
int	getObjectCount()	Get the count of managed objects.
PropertyChangeListener[]	getPropertyChangeListeners()	Get all PropertyChangeListeners currently attached to this object.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName)	Get all PropertyChangeListeners currently listening to changes to the specified property.
String	getSystemPrefix()	Provide access to the system prefix string.
VetoableChangeListener[]	getVetoableChangeListeners()	Get all VetoableChangeListeners currently attached to this object.
VetoableChangeListener[]	getVetoableChangeListeners(String propertyName)	Get all VetoableChangeListeners currently listening to changes to the specified property.
int	getXMLOrder()	Determine the order that types should be written when storing panel files.
void	init()	Perform any initialisation operations
boolean	isInitialised()	Determine if this AudioManager is initialised
Audio	newAudio(String systemName, String userName)	Return an Audio with the specified system and user names.
Audio	provideAudio(String name)	Get the Audio with the user name, then system name if needed; if that fails, create a new Audio.
void	register(Audio n)	Remember a NamedBean Object created outside the manager.
void	removeDataListener(Manager.ManagerDataListener<Audio> e)	Unregister a previously-added Manager.ManagerDataListener.
void	removePropertyChangeListener(PropertyChangeListener listener)	Remove the specified listener from this object.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)	Remove the specified listener of the specified property from this object.
void	removeVetoableChangeListener(VetoableChangeListener listener)	Remove the specified listener from this object.
void	removeVetoableChangeListener(String propertyName, VetoableChangeListener listener)	Remove the specified listener of the specified property from this object.
void	setPropertyChangesSilenced(String propertyName, boolean silenced)	Suppress sending PropertyChangeEvents for the named property.
char	typeLetter()

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Manager

getBeanTypeHandled, getEntryToolTip, getKnownBeanProperties, getSubSystemNamePrefix, getSystemNamePrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, setDataListenerMute, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat

Constructor Details

DefaultAudioSourceManager

public DefaultAudioSourceManager()

Method Details

provideAudio

public Audio provideAudio(String name)
                   throws AudioException

Get the Audio with the user name, then system name if needed; if that fails, create a new Audio. If the name is a valid system name, it will be used for the new Audio. Otherwise, the makeSystemName method will attempt to turn it into a valid system name.

Specified by:

provideAudio in interface AudioManager

Parameters:

name - User name or system name to match, or which can be promoted to system name

Returns:

Never null under normal circumstances

Throws:

AudioException - if error occurs during creation

getAudio

public Audio getAudio(String name)

Get an existing Audio or return null if it doesn't exists. Locates via user name, then system name if needed.

Specified by:

getAudio in interface AudioManager

Parameters:

name - User name or system name to match

Returns:

null if no match found

getBySystemName

public Audio getBySystemName(String systemName)

Get the Audio with the given system name or return null if no instance already exists.

Specified by:

getBySystemName in interface AudioManager

Specified by:

getBySystemName in interface Manager<Audio>

Parameters:

systemName - Audio object system name (such as IAS1 or IAB4)

Returns:

requested Audio object or null if none exists

getByUserName

public Audio getByUserName(String userName)

Get the Audio with the given user name or return null if no instance already exists.

Specified by:

getByUserName in interface AudioManager

Specified by:

getByUserName in interface Manager<Audio>

Parameters:

userName - Audio object user name

Returns:

requested Audio object or null if none exists

newAudio

public Audio newAudio(String systemName,
 String userName)
               throws AudioException

Return an Audio with the specified system and user names. Note that two calls with the same arguments will get the same instance; there is only one Audio object representing a given physical Audio and therefore only one with a specific system or user name.

This will always return a valid object reference; a new object will be created if necessary. In that case:

• If a null reference is given for user name, no user name will be associated with the Audio object created; a valid system name must be provided
• If both names are provided, the system name defines the hardware access of the desired Audio, and the user address is associated with it. The system name must be valid.

Note that it is possible to make an inconsistent request if both addresses are provided, but the given values are associated with different objects. This is a problem, and we don't have a good solution except to issue warnings. This will mostly happen if you're creating Audio objects when you should be looking them up.

Specified by:

newAudio in interface AudioManager

Parameters:

systemName - Audio object system name (such as IAS1 or IAB4)

userName - Audio object user name

Returns:

requested Audio object (never null)

Throws:

AudioException - if error occurs during creation

getActiveAudioFactory

public AudioFactory getActiveAudioFactory()

Returns the currently active AudioFactory object.

An Audio factory is responsible for the creation of implementation specific audio objects.

Specified by:

getActiveAudioFactory in interface AudioManager

Returns:

current active AudioFactory object

getNamedBeanSet

public SortedSet<Audio> getNamedBeanSet(char subType)

Get the specified Audio sub-type NamedBeans.

Specified by:

getNamedBeanSet in interface AudioManager

Parameters:

subType - sub-type to retrieve

Returns:

Unmodifiable access to a SortedSet of NamedBeans for the specified Audio sub-type .

init

public void init()

Perform any initialisation operations

Specified by:

init in interface AudioManager

cleanup

public void cleanup()

Perform any clean-up operations

Specified by:

cleanup in interface AudioManager

isInitialised

public boolean isInitialised()

Determine if this AudioManager is initialised

Specified by:

isInitialised in interface AudioManager

Returns:

true if initialised

getMemo

public SystemConnectionMemo getMemo()

Get the system connection for this manager.

Specified by:

getMemo in interface Manager<Audio>

Returns:

the system connection for this manager

getSystemPrefix

public String getSystemPrefix()

Provide access to the system prefix string. This was previously called the "System letter"

Specified by:

getSystemPrefix in interface Manager<Audio>

Returns:

the system prefix

typeLetter

public char typeLetter()

Specified by:

typeLetter in interface Manager<Audio>

Returns:

The type letter for a specific implementation

getNamedBeanClass

public Class<Audio> getNamedBeanClass()

Get the class of NamedBean supported by this Manager. This should be the generic class used in the Manager's class declaration.

Specified by:

getNamedBeanClass in interface Manager<Audio>

Returns:

the class supported by this Manager.

dispose

public void dispose()

Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.

Specified by:

dispose in interface Manager<Audio>

getObjectCount

public int getObjectCount()

Get the count of managed objects.

Specified by:

getObjectCount in interface Manager<Audio>

Returns:

the number of managed objects

getNamedBeanSet

public SortedSet<Audio> getNamedBeanSet()

Provide an unmodifiable SortedSet of NamedBeans in system-name order.

Note: This is the fastest of the accessors, and is the only long-term form.

Note: This is a live set; the contents are kept up to date

Note that this method only returns audio sources.

Specified by:

getNamedBeanSet in interface Manager<Audio>

Returns:

Unmodifiable access to a SortedSet of NamedBeans

getNamedBean

public Audio getNamedBean(String name)

Locate an existing instance based on a name.

Specified by:

getNamedBean in interface Manager<Audio>

Parameters:

name - User Name or System Name of the required NamedBean

Returns:

requested NamedBean object or null if none exists

deleteBean

public void deleteBean(Audio n,
 String property)
                throws PropertyVetoException

Method for a UI to delete a bean.

The UI should first request a "CanDelete", this will return a list of locations (and descriptions) where the bean is in use via throwing a VetoException, then if that comes back clear, or the user agrees with the actions, then a "DoDelete" can be called which inform the listeners to delete the bean, then it will be deregistered and disposed of.

If a property name of "DoNotDelete" is thrown back in the VetoException then the delete process should be aborted.

Specified by:

deleteBean in interface Manager<Audio>

Parameters:

n - The NamedBean to be deleted

property - The programmatic name of the request. "CanDelete" will enquire with all listeners if the item can be deleted. "DoDelete" tells the listener to delete the item

Throws:

PropertyVetoException - If the recipients wishes the delete to be aborted (see above)

register

public void register(Audio n)

Remember a NamedBean Object created outside the manager.

The non-system-specific SignalHeadManagers use this method extensively.

Specified by:

register in interface Manager<Audio>

Parameters:

n - the bean

deregister

public void deregister(Audio n)

Forget a NamedBean Object created outside the manager.

The non-system-specific RouteManager uses this method.

Specified by:

deregister in interface Manager<Audio>

Parameters:

n - the bean

getXMLOrder

public int getXMLOrder()

Determine the order that types should be written when storing panel files. Uses one of the constants defined in this class.

Yes, that's an overly-centralized methodology, but it works for now.

Specified by:

getXMLOrder in interface Manager<Audio>

Returns:

write order for this Manager; larger is later.

getBeanTypeHandled

public String getBeanTypeHandled(boolean plural)

Get the user-readable name of the type of NamedBean handled by this manager.

For instance, in the code where we are dealing with just a bean and a message that needs to be passed to the user or in a log.

Specified by:

getBeanTypeHandled in interface Manager<Audio>

Parameters:

plural - true to return plural form of the type; false to return singular form

Returns:

a string of the bean type that the manager handles, eg Turnout, Sensor etc

addDataListener

public void addDataListener(Manager.ManagerDataListener<Audio> e)

Register a Manager.ManagerDataListener to hear about adding or removing items from the list of NamedBeans.

Specified by:

addDataListener in interface Manager<Audio>

Parameters:

e - the data listener to add

removeDataListener

public void removeDataListener(Manager.ManagerDataListener<Audio> e)

Unregister a previously-added Manager.ManagerDataListener.

Specified by:

removeDataListener in interface Manager<Audio>

Parameters:

e - the data listener to remove

See Also:

• Manager.addDataListener(ManagerDataListener)

setPropertyChangesSilenced

public void setPropertyChangesSilenced(String propertyName,
 boolean silenced)

Suppress sending PropertyChangeEvents for the named property.

Stopping the suppression of sending change events may send a PropertyChangeEvent if the property changed while silenced, but otherwise should not fire a PropertyChangeEvent.

Specified by:

setPropertyChangesSilenced in interface SilenceablePropertyChangeProvider

Parameters:

propertyName - the name of the property to mute

silenced - true if events are to be suppressed; false otherwise

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list.

Specified by:

addPropertyChangeListener in interface PropertyChangeProvider

Parameters:

listener - The PropertyChangeListener to be added

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

Add a PropertyChangeListener for a specific property.

Specified by:

addPropertyChangeListener in interface PropertyChangeProvider

Parameters:

propertyName - The name of the property to listen on.

listener - The PropertyChangeListener to be added

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

Get all PropertyChangeListeners currently attached to this object.

Specified by:

getPropertyChangeListeners in interface PropertyChangeProvider

Returns:

An array of PropertyChangeListeners.

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

Get all PropertyChangeListeners currently listening to changes to the specified property.

Specified by:

getPropertyChangeListeners in interface PropertyChangeProvider

Parameters:

propertyName - the name of the property of interest

Returns:

an array of PropertyChangeListeners

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove the specified listener from this object.

Specified by:

removePropertyChangeListener in interface PropertyChangeProvider

Parameters:

listener - The PropertyChangeListener to remove.

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

Remove the specified listener of the specified property from this object.

Specified by:

removePropertyChangeListener in interface PropertyChangeProvider

Parameters:

propertyName - The name of the property to stop listening to.

listener - The PropertyChangeListener to remove.

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)

Add a VetoableChangeListener to the listener list.

Specified by:

addVetoableChangeListener in interface VetoableChangeProvider

Parameters:

listener - The VetoableChangeListener to be added

addVetoableChangeListener

public void addVetoableChangeListener(String propertyName,
 VetoableChangeListener listener)

Add a VetoableChangeListener for a specific property.

Specified by:

addVetoableChangeListener in interface VetoableChangeProvider

Parameters:

propertyName - The name of the property to listen on.

listener - The VetoableChangeListener to be added

getVetoableChangeListeners

public VetoableChangeListener[] getVetoableChangeListeners()

Get all VetoableChangeListeners currently attached to this object.

Specified by:

getVetoableChangeListeners in interface VetoableChangeProvider

Returns:

An array of VetoableChangeListeners.

getVetoableChangeListeners

public VetoableChangeListener[] getVetoableChangeListeners(String propertyName)

Get all VetoableChangeListeners currently listening to changes to the specified property.

Specified by:

getVetoableChangeListeners in interface VetoableChangeProvider

Parameters:

propertyName - The name of the property of interest

Returns:

An array of VetoableChangeListeners.

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)

Remove the specified listener from this object.

Specified by:

removeVetoableChangeListener in interface VetoableChangeProvider

Parameters:

listener - The VetoableChangeListener to remove.

removeVetoableChangeListener

public void removeVetoableChangeListener(String propertyName,
 VetoableChangeListener listener)

Remove the specified listener of the specified property from this object.

Specified by:

removeVetoableChangeListener in interface VetoableChangeProvider

Parameters:

propertyName - The name of the property to stop listening to.

listener - The VetoableChangeListener to remove.