Public:BWmeta service/Transformers

From YaddaWiki

Service details
Name	BWmeta
Code location (relative to SVN root)	projects/dir/bwmeta-core
Javadoc
Contact person	Jakub Jurkiewicz
edit BWmeta format Data Model BWMeta Model Design principles 1.0.5 example 1.2.0 example 2.0.0 example Feature requests Linked Open Data Hierarchys Book Journal BWmeta usage in YADDA Java mapping Rich text in Java mapping Transformers data sources Conventions and constants Contents and attachments Internationalization Tutorial How to convert to Dublic Core? Categorizations

Background and motivation

As of 2010Q4, three versions of BWmeta format and at least three Java models of BWmeta are used in YADDA. See here for details. Serialization and deserialization is implemented for the following pairs:

	Repo	DL	Y	…
1.0.5
1.2.0
2.0.0

There are also converters between selected models:

• Y ↔ DL

Serialization of Y model to BWmeta 1.0.5 is therefore possible through the following chain of transformations:

• Y model → DL model → BWmeta 1.0.5

Conversion from DL model to Repo model is possible through:

• DL model → BWmeta 1.0.5 → Repo model

Unfortunately, many mutually-incompatible transformation interfaces are present. It is difficult to understand which transformations are possible, how to combine them, which classes should be used for that end and how to instantiate the classes.

A unified interface to all the transformations would be very helpful.

Unified interface (under construction)

Four different transformer types are present: readers, writers and model converters and format converters. Each type has a corresponding interface:

• IMetadataReader<T> deserializes an object of type T from a String or a Reader
• IMetadataWriter<T> serializes an object of type T to a String or a Writer
• IMetadataModelConverter<S, T> converts an object of type S to an object of type T
• IMetadataFormatConverter

MetadataTransformerFactory maintains a list of available "atomic" transformers and is able to combine the atomic transformers into more complex ones.

Public constructors provided by MetadataTransformerFactory:

• MetadataTransformerFactory(List<IMetadataReaders>, List<IMetadataWriters>, List<IMetadataModelConverters>, List<IMetadataFormatConverters>) -- builds a MetadataTransformerFactory from given lists of atomic transformers,
• MetadataTransformerFactory(MetadataTransformerFactory, List<IMetadataReaders>, List<IMetadataWriters>, List<IMetadataModelConverters>, List<IMetadataFormatConverters>) -- creates a new MetadataTransformerFactory from an existing one, which contains joined lists of atomic transformers.

Public methods of MetadataTransformerFactory, that return return transformer built from atomic transformers given in object constructor:

• <T> IMetadataReader<T> getReader(MetadataModel<T>, MetadataFormat)
• <T> IMetadataWriter<T> getWriter(MetadataModel<T>, MetadataFormat)
• <S, T> IMetadataModelConverter<S, T> getModelConverter(MetadataModel<S>, MetadataModel<T>)
• IMetadataFormatConverter getFormatConverter(MetadataFormat, MetadataFormat)

MetadataTransformerFactory also contains a set of static methods compose(), that return a complex transformer built from two given transformers:

• IMetadataReader compose(IMetadataFormatConverter, IMetadataReader)
• IMetadataReader compose(IMetadataReader, IMetadataModelConverter)
• IMetadataWriter compose(IMetadataWriter, IMetadataFormatConverter)
• IMetadataWriter compose(IMetadataModelConverter, IMetadataWriter)
• IMetadataFormatConverter compose(IMetadataFormatConverter, IMetadataFormatConverter)
• IMetadataFormatConverter compose(IMetadataReader, IMetadataWriter)
• IMetadataModelConverter compose(IMetadataModelConverter, IMetadataModelConverter)
• IMetadataModelConverter compose(IMetadataWriter, IMetadataReader)