|
TANGO Database API | |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--fr.esrf.TangoApi.Connection | +--fr.esrf.TangoApi.Database
Class Description: This class is the main class for TANGO database API. The TANGO database is implemented as a TANGO device server. To access it, the user has the CORBA interface command_inout(). This expects and returns all parameters as ascii strings thereby making the database laborious to use for retreing device properties and information. In order to simplify this access, a high-level API has been implemented which hides the low-level formatting necessary to convert the command_inout() return values into binary values and all CORBA aspects of the TANGO. All data types are native java types e.g. simple types an arrays.
Constructor Summary | |
Database()
Database access constructor. |
|
Database(java.lang.String host,
java.lang.String port)
Database access constructor. |
Method Summary | |
void |
add_device(DbDevInfo devinfo)
Add/update a device to the database |
void |
add_device(java.lang.String devname,
java.lang.String classname,
java.lang.String servname)
Add/update a device to the database |
void |
add_server(java.lang.String servname,
DbDevInfo[] devinfos)
Add a group of devices to the database. |
void |
delete_class_attribute_property(java.lang.String name,
DbDatum[] properties)
Delete a list of properties for the specified object. |
void |
delete_class_attribute_property(java.lang.String name,
java.lang.String propname)
Delete a property for the specified object. |
void |
delete_class_attribute_property(java.lang.String name,
java.lang.String[] propnames)
Delete a list of properties for the specified object. |
void |
delete_class_property(java.lang.String name,
DbDatum[] properties)
Delete a list of properties for the specified object. |
void |
delete_class_property(java.lang.String name,
java.lang.String propname)
Delete a property for the specified object. |
void |
delete_class_property(java.lang.String name,
java.lang.String[] propnames)
Delete a list of properties for the specified object. |
void |
delete_device_attribute_property(java.lang.String name,
DbDatum[] properties)
Delete a list of properties for the specified object. |
void |
delete_device_attribute_property(java.lang.String name,
java.lang.String propname)
Delete a property for the specified object. |
void |
delete_device_attribute_property(java.lang.String name,
java.lang.String[] propnames)
Delete a list of properties for the specified object. |
void |
delete_device_property(java.lang.String name,
DbDatum[] properties)
Delete a list of properties for the specified object. |
void |
delete_device_property(java.lang.String name,
java.lang.String propname)
Delete a property for the specified object. |
void |
delete_device_property(java.lang.String name,
java.lang.String[] propnames)
Delete a list of properties for the specified object. |
void |
delete_device(java.lang.String devname)
Delete the device of the specified name from the database |
void |
delete_property(java.lang.String name,
DbDatum[] properties)
Delete a list of properties for the specified object. |
void |
delete_property(java.lang.String name,
java.lang.String propname)
Delete a property for the specified object. |
void |
delete_property(java.lang.String name,
java.lang.String[] propnames)
Delete a list of properties for the specified object. |
void |
delete_server(java.lang.String devname)
Delete the device server and its associated devices from the database. |
void |
export_device(DbDevExportInfo devinfo)
Update the export info fort this device in the database. |
void |
export_server(java.lang.String devname,
DbDevExportInfo[] devinfos)
Add a group of devices to the database. |
DbDatum[] |
get_class_attribute_property(java.lang.String name,
DbDatum[] properties)
Query the database for a list of class attribute properties for the pecified object. |
DbDatum |
get_class_attribute_property(java.lang.String name,
java.lang.String propname)
Query the database for a class attribute property for the pecified object. |
DbDatum[] |
get_class_attribute_property(java.lang.String name,
java.lang.String[] propnames)
Query the database for a list of class attribute properties for the pecified object. |
java.lang.String[] |
get_class_property_list(java.lang.String classname,
java.lang.String wildcard)
Query the database for a list of class properties for the pecified object. |
DbDatum[] |
get_class_property(java.lang.String name,
DbDatum[] properties)
Query the database for a list of class properties for the pecified object. |
DbDatum |
get_class_property(java.lang.String name,
java.lang.String propname)
Query the database for a class property for the pecified object. |
DbDatum[] |
get_class_property(java.lang.String name,
java.lang.String[] propnames)
Query the database for a list of class properties for the pecified object. |
java.lang.String[] |
get_device_alias(java.lang.String devname)
Query the database for a list of aliases for the specified device. |
DbDatum[] |
get_device_attribute_property(java.lang.String name,
DbDatum[] properties)
Query the database for a list of device attribute properties for the pecified object. |
DbDatum |
get_device_attribute_property(java.lang.String name,
java.lang.String propname)
Query the database for device attribute property for the pecified object. |
DbDatum[] |
get_device_attribute_property(java.lang.String name,
java.lang.String[] propnames)
Query the database for a list of device attribute properties for the pecified object. |
java.lang.String[] |
get_device_class_list(java.lang.String servname)
Query the database for server devices and classes. |
java.lang.String[] |
get_device_domain(java.lang.String wildcard)
Query the database for a list of device domain names witch match the wildcard provided. |
java.lang.String[] |
get_device_family(java.lang.String wildcard)
Query the database for a list of device family names witch match the wildcard provided. |
java.lang.String[] |
get_device_member(java.lang.String wildcard)
Query the database for a list of device member names witch match the wildcard provided. |
java.lang.String[] |
get_device_name(java.lang.String servname,
java.lang.String classname)
Query the database for a list of devices served by the specified server and of the specified class. |
java.lang.String[] |
get_device_property_list(java.lang.String devname,
java.lang.String wildcard)
Query the database for a list of device properties for the pecified object. |
DbDatum[] |
get_device_property(java.lang.String name,
DbDatum[] properties)
Query the database for a list of device properties for the pecified object. |
DbDatum |
get_device_property(java.lang.String name,
java.lang.String propname)
Query the database for a device property for the pecified object. |
DbDatum[] |
get_device_property(java.lang.String name,
java.lang.String[] propnames)
Query the database for a list of device properties for the pecified object. |
java.lang.String[] |
get_host_list()
Query the database for a list of host registred. |
java.lang.String[] |
get_host_list(java.lang.String wildcard)
Query the database for a list of host registred. |
java.lang.String[] |
get_host_server_list(java.lang.String hostname)
Query the database for a list of servers registred on the specified host. |
java.lang.String |
get_info()
Query the database for general info about the table in the database. |
DbDatum[] |
get_property(java.lang.String name,
DbDatum[] properties)
Query the database for a list of object (i.e. |
DbDatum |
get_property(java.lang.String name,
java.lang.String propname)
Query the database for an object (i.e. |
DbDatum[] |
get_property(java.lang.String name,
java.lang.String[] propnames)
Query the database for a list of object (i.e. |
DbServInfo |
get_server_info(java.lang.String servname)
Query the database for server information. |
java.lang.String[] |
get_server_list()
Query the database for a list of servers registred in the database. |
java.lang.String[] |
get_server_list(java.lang.String wildcard)
Query the database for a list of servers registred in the database. |
DbDevImportInfo |
import_device(java.lang.String devname)
Query the database for the export info of the specified device. |
void |
put_class_attribute_property(java.lang.String name,
DbDatum[] properties)
Insert or update a list of properties for the specified class attribute. |
void |
put_class_property(java.lang.String name,
DbDatum[] properties)
Insert or update a list of properties for the specified class. |
void |
put_device_attribute_property(java.lang.String name,
DbDatum[] properties)
Insert or update a list of properties for the specified device attribute. |
void |
put_device_property(java.lang.String name,
DbDatum[] properties)
Insert or update a list of properties for the specified device The property names and their values are specified by the DbDatum array. |
void |
put_property(java.lang.String name,
DbDatum[] properties)
Insert or update a list of properties for the specified object The property names and their values are specified by the DbDatum array. |
void |
put_server_info(DbServInfo info)
Add/update server information in databse. |
void |
unexport_device(java.lang.String devname)
Mark the specified server as unexported in the database. |
void |
unexport_server(java.lang.String devname)
Mark all devices exported for this device server as unexported. |
Methods inherited from class fr.esrf.TangoApi.Connection |
command_inout,
command_inout,
command_list_query,
get_name,
get_tango_host,
get_timeout,
info,
ping,
set_timeout |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public Database() throws fr.esrf.Tango.DevFailed
public Database(java.lang.String host, java.lang.String port) throws fr.esrf.Tango.DevFailed
host
- host where database is running.port
- port for database connection.Method Detail |
public java.lang.String get_info() throws fr.esrf.Tango.DevFailed
public java.lang.String[] get_host_list() throws fr.esrf.Tango.DevFailed
public java.lang.String[] get_host_list(java.lang.String wildcard) throws fr.esrf.Tango.DevFailed
wildcard
- Wildcard char is '*' and matches wildvcard characters.public java.lang.String[] get_server_list() throws fr.esrf.Tango.DevFailed
public java.lang.String[] get_server_list(java.lang.String wildcard) throws fr.esrf.Tango.DevFailed
wildcard
- Wildcard char is '*' and matches wildvcard characters.public java.lang.String[] get_host_server_list(java.lang.String hostname) throws fr.esrf.Tango.DevFailed
hostname
- the specified host name.public DbServInfo get_server_info(java.lang.String servname) throws fr.esrf.Tango.DevFailed
servname
- The specified server name.public void put_server_info(DbServInfo info) throws fr.esrf.Tango.DevFailed
info
- Server information for the specified server
in a DbServinfo object.public void add_device(DbDevInfo devinfo) throws fr.esrf.Tango.DevFailed
devinfo
- The device name, class and server specified in object.public void add_device(java.lang.String devname, java.lang.String classname, java.lang.String servname) throws fr.esrf.Tango.DevFailed
devname
- The device nameclassnmame
- The class.servname
- The server name.public void delete_device(java.lang.String devname) throws fr.esrf.Tango.DevFailed
devname
- The device name.public DbDevImportInfo import_device(java.lang.String devname) throws fr.esrf.Tango.DevFailed
devname
- The device name.public void unexport_device(java.lang.String devname) throws fr.esrf.Tango.DevFailed
devname
- The device name.public void export_device(DbDevExportInfo devinfo) throws fr.esrf.Tango.DevFailed
devinfo
- Device information to export.public java.lang.String[] get_device_class_list(java.lang.String servname) throws fr.esrf.Tango.DevFailed
servname
- The specified server name.public java.lang.String[] get_device_name(java.lang.String servname, java.lang.String classname) throws fr.esrf.Tango.DevFailed
servname
- The server name.clasname
- The class namepublic java.lang.String[] get_device_alias(java.lang.String devname) throws fr.esrf.Tango.DevFailed
devvname
- The server name.public java.lang.String[] get_device_domain(java.lang.String wildcard) throws fr.esrf.Tango.DevFailed
wildcard
- Wildcard char is '*' and matches wildvcard characters.public java.lang.String[] get_device_family(java.lang.String wildcard) throws fr.esrf.Tango.DevFailed
wildcard
- Wildcard char is '*' and matches wildvcard characters.public java.lang.String[] get_device_member(java.lang.String wildcard) throws fr.esrf.Tango.DevFailed
wildcard
- Wildcard char is '*' and matches wildvcard characters.public void add_server(java.lang.String servname, DbDevInfo[] devinfos) throws fr.esrf.Tango.DevFailed
servname
- Server name for these devices.devinfo
- Devices and server information.public void delete_server(java.lang.String devname) throws fr.esrf.Tango.DevFailed
devname
- the device name.public void export_server(java.lang.String devname, DbDevExportInfo[] devinfos) throws fr.esrf.Tango.DevFailed
servname
- server name for these devices.devinfo
- Devices and server information.public void unexport_server(java.lang.String devname) throws fr.esrf.Tango.DevFailed
devname
- the device name.public DbDatum[] get_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- Object name.propnames
- list of property names.public DbDatum get_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- Object name.propname
- list of property names.public DbDatum[] get_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Object name.properties
- list of property DbDatum objects.public void put_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Object name.properties
- Properties names and values array.public void delete_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- Object name.propnames
- Property names.public void delete_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- Object name.propname
- Property names.public void delete_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Object name.properties
- Property DbDatum objects.public java.lang.String[] get_class_property_list(java.lang.String classname, java.lang.String wildcard) throws fr.esrf.Tango.DevFailed
classname
- device name.wildcard
- propertie's wildcard (* matches any charactere).public java.lang.String[] get_device_property_list(java.lang.String devname, java.lang.String wildcard) throws fr.esrf.Tango.DevFailed
devname
- device name.wildcard
- propertie's wildcard (* matches any charactere).public DbDatum[] get_device_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- device name.propnames
- list of property names.public DbDatum get_device_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- device name.propname
- property name.public DbDatum[] get_device_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- device name.properties
- list of property DbDatum objects.public void put_device_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- device name.properties
- Properties names and values array.public void delete_device_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- Device name.propnames
- Property names.public void delete_device_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- Device name.propname
- Property name.public void delete_device_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Device name.properties
- Property DbDatum objects.public DbDatum[] get_device_attribute_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- device name.propnames
- list of property names.public DbDatum get_device_attribute_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- device name.propname
- property name.public DbDatum[] get_device_attribute_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- device name.properties
- list of property DbDatum objects.public void put_device_attribute_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- device name.properties
- Properties names and values array.public void delete_device_attribute_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- Device name.propnames
- Property names.public void delete_device_attribute_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- Device name.propname
- Property name.public void delete_device_attribute_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Device name.properties
- Property DbDatum objects.public DbDatum[] get_class_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- Class name.propnames
- list of property names.public DbDatum get_class_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- Class name.propname
- list of property names.public DbDatum[] get_class_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Class name.properties
- list of property DbDatum objects.public void put_class_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Class name.properties
- Properties names and values array.public void delete_class_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- Class name.propnames
- Property names.public void delete_class_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- Class name.propname
- Property name.public void delete_class_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Class name.properties
- Property DbDatum objects.public DbDatum[] get_class_attribute_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- Class name.propnames
- list of property names.public DbDatum get_class_attribute_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- Class name.propname
- property name.public DbDatum[] get_class_attribute_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Class name.properties
- list of property DbDatum objects.public void put_class_attribute_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Class name.properties
- Properties names and values array.public void delete_class_attribute_property(java.lang.String name, java.lang.String[] propnames) throws fr.esrf.Tango.DevFailed
name
- Class name.propnames
- Property names.public void delete_class_attribute_property(java.lang.String name, java.lang.String propname) throws fr.esrf.Tango.DevFailed
name
- Class name.propname
- Property names.public void delete_class_attribute_property(java.lang.String name, DbDatum[] properties) throws fr.esrf.Tango.DevFailed
name
- Class name.properties
- Property DbDatum objects.
|
TANGO Database API | |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |