org.eclipse.sphinx.emf.resource

Interface IModelConverter

All Known Implementing Classes:

AbstractModelConverter

public interface IModelConverter

A converter which can be used to serialize and deserialize between in-memory instances created with one (often the latest) version of a metamodel and XML resources corresponding to another (typically older) version of the same metamodel.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_RESOURCE_VERSION_DESCRIPTOR Deprecated. Use ExtendedResource.OPTION_RESOURCE_VERSION_DESCRIPTOR instead.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtraAttributesToSavedRootElement(org.eclipse.emf.ecore.xmi.impl.XMLString rootElement, java.util.Map<?,?> options) Provides a hook for adding additional attributes to the model root element during the save operation for specified resource.
org.xml.sax.InputSource	convertLoad(org.eclipse.emf.ecore.xmi.XMLResource resource, java.io.InputStream inputStream, java.util.Map<?,?> options) Creates an InputSource from given InputStream during the load operation for specified resource.
void	convertSave(org.eclipse.emf.ecore.xmi.impl.XMLString xml, int flushThreshold, org.eclipse.emf.common.util.URI uri, java.io.OutputStream outputStream, java.lang.String encoding, org.eclipse.emf.ecore.xmi.XMLHelper helper, java.util.Map<?,?> options) During a save operation, writes to given OutputStream with specified encoding the content of given XMLString, using the XMLHelper.
void	dispose()
IMetaModelDescriptor	getMetaModelVersionDescriptor()
IMetaModelDescriptor	getResourceVersionDescriptor()
boolean	isLoadConverterFor(org.eclipse.emf.ecore.xmi.XMLResource resource, java.util.Map<?,?> options) During a load operation, returns true if this converter applies to given XMLResource, taking into account that the in memory meta-model defines given descriptor.
boolean	isSaveConverterFor(org.eclipse.emf.ecore.xmi.XMLResource resource, java.util.Map<?,?> options) During a save operation, returns true if this converter applies to given XMLResource.

Field Detail

OPTION_RESOURCE_VERSION_DESCRIPTOR

@Deprecated
static final java.lang.String OPTION_RESOURCE_VERSION_DESCRIPTOR

Deprecated. Use ExtendedResource.OPTION_RESOURCE_VERSION_DESCRIPTOR instead.

See Also:

Constant Field Values

Method Detail

getMetaModelVersionDescriptor

IMetaModelDescriptor getMetaModelVersionDescriptor()

Returns:

The meta-model descriptor corresponding the currently used meta-model version.

Since:

0.7.0

getResourceVersionDescriptor

IMetaModelDescriptor getResourceVersionDescriptor()

Returns:

The meta-model descriptor owning the namespace that must be used during save operation for the XML output writing.

Since:

0.7.0

isLoadConverterFor

boolean isLoadConverterFor(org.eclipse.emf.ecore.xmi.XMLResource resource,
                         java.util.Map<?,?> options)

During a load operation, returns true if this converter applies to given XMLResource, taking into account that the in memory meta-model defines given descriptor.

Parameters:

resource - The resource that might eventually be converted.

options - The load options.

Returns:

False otherwise.

Since:

0.7.0

isSaveConverterFor

boolean isSaveConverterFor(org.eclipse.emf.ecore.xmi.XMLResource resource,
                         java.util.Map<?,?> options)

During a save operation, returns true if this converter applies to given XMLResource.

Parameters:

resource - The resource that might eventually be converted.

options - The save options.

Returns:

False otherwise.

convertLoad

org.xml.sax.InputSource convertLoad(org.eclipse.emf.ecore.xmi.XMLResource resource,
                                  java.io.InputStream inputStream,
                                  java.util.Map<?,?> options)
                                    throws java.io.IOException

Creates an InputSource from given InputStream during the load operation for specified resource.

Parameters:

resource - The resource being loaded.

inputStream - The InputStream being read from.

options - The load options.

Returns:

An InputSource that may be later processed by the parser.

Throws:

java.io.IOException

convertSave

void convertSave(org.eclipse.emf.ecore.xmi.impl.XMLString xml,
               int flushThreshold,
               org.eclipse.emf.common.util.URI uri,
               java.io.OutputStream outputStream,
               java.lang.String encoding,
               org.eclipse.emf.ecore.xmi.XMLHelper helper,
               java.util.Map<?,?> options)
                 throws java.io.IOException

During a save operation, writes to given OutputStream with specified encoding the content of given XMLString, using the XMLHelper.

Parameters:

xml - The XML content to be converted.

flushThreshold - The number of bytes to write before the outputStream is flushed.

uri - The URI to which the converted XML content will be written.

outputStream - The stream into which the converted XML data will be written.

encoding - The encoding to use in the outputStream.

helper - The XMLHelper.

options - The save options.

Throws:

java.io.IOException

See Also:

PipedOutputStream

addExtraAttributesToSavedRootElement

void addExtraAttributesToSavedRootElement(org.eclipse.emf.ecore.xmi.impl.XMLString rootElement,
                                        java.util.Map<?,?> options)

Provides a hook for adding additional attributes to the model root element during the save operation for specified resource.

Parameters:

rootElement - The XMLString to write to, using doc.addAttribute.

options - The save options.

See Also:

XMLResource.getDefaultSaveOptions()

dispose

void dispose()