com.kuka.roboticsAPI.persistenceModel
Interface IDataSource

All Known Subinterfaces:

IApplicationDataSource, ISaveableApplicationDataSource

All Known Implementing Classes:

XmlApplicationDataSource

public interface IDataSource

Generic data source interface.

Each data source must implement this interface. The persistence engine handles the life cycle for the data source using the defined methods. The life cycle managed by a persistence engine looks like this:
1. Call parameterless constructor of the implementing class.:
2. Call setContext()
3. Call setParameters()
4. Call open()
Call close() when persistence engine gets disposed.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Method Summary

void	close() Closes the data source.
RoboticsAPIContext	getContext() Gets the context for this data source.
String	getName() Gets the name of this data source.
boolean	isOpen() Indicates if this data source is opened.
boolean	isReadOnly() Indicates if this data source is read only.
void	open() Opens the data source.
void	setContext(RoboticsAPIContext context) Sets the context for this data source.
void	setParameters(com.kuka.common.ParameterSet parameters) Initializes the data source with a set of parameters.

Method Detail

open

void open()

Opens the data source. 'setAttributes' will be called before 'open'.

Usually should be uses to connect to the real data source (database, file etc.)

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

close

void close()

Closes the data source.

Closes the connection to the real data source.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

setParameters

void setParameters(com.kuka.common.ParameterSet parameters)

Initializes the data source with a set of parameters. The context must be set before this method is called.

Parameters:

parameters - The parameters of the data source.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

isReadOnly

boolean isReadOnly()

Indicates if this data source is read only.

Returns:

True if this data source is read only.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

isOpen

boolean isOpen()

Indicates if this data source is opened.

Returns:

True if this data source is opened.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getName

String getName()

Gets the name of this data source.

Returns:

The name of this data source.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

setContext

void setContext(RoboticsAPIContext context)

Sets the context for this data source.

Parameters:

context - The context for this data source.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getContext

RoboticsAPIContext getContext()

Gets the context for this data source.

Returns:

The context for this data source.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.