Module omix.api

Package omix.plugin.data

Interface DataSourceHandlerInterface

All Known Subinterfaces:

FileDataSourceHandlerInterface, OrdinaryDataSourceHandlerInterface

public interface DataSourceHandlerInterface

Since:

Omix 1.8.5

Author:

Dr. Peter Droste

Method Summary

Modifier and Type	Method	Description
boolean	canReadDataSources()
boolean	canWriteDataSources()
DataSourceInterface	deserialize(TypeSerializationHandlerInterface.AbstractSerialization serialization, VersionNumber version, DataInputUtilities utilities)	Deserializes an instance of DataSourceInterface according the given instance of TypeSerializationHandlerInterface.AbstractSerialization. Omix iterates the list of installed TypeSerializationHandlers ordered by time of installation.
String	getDescription()
String	getDisplayName()
QIcon	getIcon()
String	getIdentifier()
TypeSerializationHandlerInterface.AbstractSerialization	serialize(DataSourceInterface dataSource)	Serializes an instance of DataSourceInterface. Omix iterates the list of installed TypeSerializationHandlers ordered by time of installation.

Method Details

canReadDataSources

boolean canReadDataSources()

canWriteDataSources

boolean canWriteDataSources()

getDisplayName

String getDisplayName()

getDescription

String getDescription()

getIcon

QIcon getIcon()

getIdentifier

String getIdentifier()

serialize

TypeSerializationHandlerInterface.AbstractSerialization serialize(DataSourceInterface dataSource) throws Exception

Serializes an instance of DataSourceInterface.
Omix iterates the list of installed TypeSerializationHandlers ordered by time of installation. The first handler supporting the specific class is used for value serialization. All other supporting handlers are skipped.

Parameters:

dataSource - to be serialized

Returns:

instance of AbstractSerialization

Throws:

Exception - can be thrown to declare an internal error.

deserialize

DataSourceInterface deserialize(TypeSerializationHandlerInterface.AbstractSerialization serialization, VersionNumber version, DataInputUtilities utilities) throws Exception

Deserializes an instance of DataSourceInterface according the given instance of TypeSerializationHandlerInterface.AbstractSerialization.
Omix iterates the list of installed TypeSerializationHandlers ordered by time of installation. The first handler supporting the specific class is used for value deserialization. All other supporting handlers are skipped.

Parameters:

serialization - corresponds to the serialization result from serialize(DataSourceInterface).

version - the version number of the plugin installed in Omix when the object was serialized.
In this way, the implementation can change and keep compartibility.

utilities - input utilities

Returns:

the deserialized object

Throws:

Exception - can be thrown to declare an internal error.