Package xal.app.launcher

Class HostConfiguration

java.lang.Object

xal.app.launcher.HostConfiguration

All Implemented Interfaces:

xal.tools.data.DataListener

public class HostConfiguration
extends Object
implements xal.tools.data.DataListener

host configuration

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATA_LABEL	the data adaptor label used for reading and writing this instance
protected List<HostSetting>	HOST_SETTINGS	host settings

Constructor Summary

Constructors

Constructor	Description
HostConfiguration()	Empty Constructor

Method Summary

Modifier and Type	Method	Description
String	dataLabel()	dataLabel() provides the name used to identify the class in an external data source.
List<String>	getCommands()	get the commands
List<String>	getCommands(String host, List<String> executable)	generate a host command based on a local executable expression by substituting the host for %h and the executable for %e
List<HostSetting>	getEnabledHosts()	Get the hosts which are enabled
List<HostSetting>	getHostSettings()	Get the list of host settings
boolean	isHostRequired()	determine if a host is required for a command
void	preConfigure()	preconfigure when initializing without a document file
void	refreshEnabledHosts()	Refresh the list of enabled hosts
void	setCommands(List<String> commands)	set the commands
void	update(xal.tools.data.DataAdaptor adaptor)	Instructs the receiver to update its data based on the given adaptor.
void	write(xal.tools.data.DataAdaptor adaptor)	Instructs the receiver to write its data to the adaptor for external storage.

Methods inherited from class java.lang.Object

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

Field Detail

DATA_LABEL

public static final String DATA_LABEL

the data adaptor label used for reading and writing this instance

See Also:

Constant Field Values

HOST_SETTINGS

protected final List<HostSetting> HOST_SETTINGS

host settings

Constructor Detail

HostConfiguration

public HostConfiguration()

Empty Constructor

Method Detail

getCommands

public List<String> getCommands()

get the commands

setCommands

public void setCommands(List<String> commands)

set the commands

isHostRequired

public boolean isHostRequired()

determine if a host is required for a command

getCommands

public List<String> getCommands(String host,
                                List<String> executable)

generate a host command based on a local executable expression by substituting the host for %h and the executable for %e

getHostSettings

public List<HostSetting> getHostSettings()

Get the list of host settings

Returns:

host settings

getEnabledHosts

public List<HostSetting> getEnabledHosts()

Get the hosts which are enabled

Returns:

list of enabled hosts

refreshEnabledHosts

public void refreshEnabledHosts()

Refresh the list of enabled hosts

preConfigure

public void preConfigure()

preconfigure when initializing without a document file

dataLabel

public String dataLabel()

dataLabel() provides the name used to identify the class in an external data source.

Specified by:

dataLabel in interface xal.tools.data.DataListener

Returns:

The tag for this data node.

update

public void update(xal.tools.data.DataAdaptor adaptor)

Instructs the receiver to update its data based on the given adaptor.

Specified by:

update in interface xal.tools.data.DataListener

Parameters:

adaptor - The data adaptor corresponding to this object's data node.

write

public void write(xal.tools.data.DataAdaptor adaptor)

Instructs the receiver to write its data to the adaptor for external storage.

Specified by:

write in interface xal.tools.data.DataListener

Parameters:

adaptor - The data adaptor corresponding to this object's data node.