pl.edu.agh.cast.data.converter
Interface IConverter

All Known Implementing Classes:

AbstractConverter, GDM2SchemaConverter

public interface IConverter

An interface of a data set converter.

Converters allow for transforming one or more (input) data sets of specified type into a new (output) data set of specified type. Information about input entries and output type are encapsulated in converter specification.

Author:

AGH CAST Team

See Also:

ConverterSpecification

Method Summary

<T extends IDataSet<? extends IElement>> T	convert(List<? extends IDataSet<? extends IElement>> dataSets) Converts given input data sets into a new output data set.
<T extends IDataSet<? extends IElement>> T	convert(MultiMap<ConverterInputEntry,? extends IDataSet<? extends IElement>> dataSets) Converts given input data sets into a new output data set.
ConverterSpecification	getSpecification() Returns the converter specification.

Method Detail

getSpecification

ConverterSpecification getSpecification()

Returns the converter specification.

Returns:

the converter specification

convert

<T extends IDataSet<? extends IElement>> T convert(MultiMap<ConverterInputEntry,? extends IDataSet<? extends IElement>> dataSets)
                                               throws ConverterException

Converts given input data sets into a new output data set.

Type Parameters:

T - the type of conversion output data set

Parameters:

dataSets - a map of data sets indexed by the input entries returned by the #getInputEntries() method

Returns:

an instance of a data set of the same type as returned by the #getOutputType() method

Throws:

ConverterException - if the input data sets do not conform to the input entry specification or a data set conversion failed

convert

<T extends IDataSet<? extends IElement>> T convert(List<? extends IDataSet<? extends IElement>> dataSets)
                                               throws ConverterException

Converts given input data sets into a new output data set.

Type Parameters:

T - the type of conversion output data set

Parameters:

dataSets - a list of data sets

Returns:

an instance of a data set of the same type as returned by the #getOutputType() method

Throws:

ConverterException - if the input data sets do not conform to the input entry specification or a data set conversion failed