Module omix.api

Package omix.plugin.data

Interface FileDataSourceHandlerInterface

All Superinterfaces:

DataSourceHandlerInterface

public interface FileDataSourceHandlerInterface
extends DataSourceHandlerInterface

Since:

Omix 1.8.5

Author:

Dr. Peter Droste

Method Summary

Modifier and Type	Method	Description
String	getDescription(String suffix)	Returns a textual description of the file format displayed in the file dialogs. Example:
String[]	getSuffixes()	Returns an array of all supported file suffixes.
DataSourceInterface	readDataSource(String suffix, URLConnection urlConnection, DataInputUtilities utilities)
void	writeDataSource(DataSourceInterface dataSource, String suffix, URLConnection urlConnection, DataOutputUtilities utilities)

Methods inherited from interface omix.plugin.data.DataSourceHandlerInterface

canReadDataSources, canWriteDataSources, deserialize, getDescription, getDisplayName, getIcon, getIdentifier, serialize

Method Details

getSuffixes

String[] getSuffixes()

Returns an array of all supported file suffixes. Example: new String[]{"xml", "fml", "doc"}

Returns:

all supported suffixes

getDescription

String getDescription(String suffix)

Returns a textual description of the file format displayed in the file dialogs.
Example:

public String getDescription(String suffix){
if("fml".equals(suffix)){
return tr("13CFlux 2.0 Network");
}
else return null;
}

Parameters:

suffix - file format suffix

Returns:

description

readDataSource

DataSourceInterface readDataSource(String suffix, URLConnection urlConnection, DataInputUtilities utilities) throws IOException

Throws:

IOException

writeDataSource

void writeDataSource(DataSourceInterface dataSource, String suffix, URLConnection urlConnection, DataOutputUtilities utilities) throws IOException

Throws:

IOException