Package jetbrains.mps.smodel.persistence.def

Class ModelPersistence

java.lang.Object

jetbrains.mps.smodel.persistence.def.ModelPersistence

public class ModelPersistence
extends Object

ModelPersistence handles all XML persistence versions supported by current MPS installation. The range of supported versions is [FIRST_SUPPORTED_VERSION, LAST_VERSION]. MPS must be able to read any of these persistence versions and write the last one.

The "previous" persistence version being writable is not a must, but it is better to support it to have less moments when we accidentally need to convert between persistence versions. E.g. to be able to fix model before migration from previous version and save it in old persistence, or to merge two non-migrated branches without converting persistence.

It is supposed that only one or two persistence versions are supported: the last persistence used by previous MPS version (to read and migrate project created in the previous version, and, sometimes, a new persistence introduced in current version. NOTE this is not mandatory, we can support more than two versions.

We can't support full functionality on all created persistences as the change in persistence is actually made because of change in SModel. So, we can't actual SModel to a very old persistence or even read all the information from old persistence into a new SModel. The good thing about that is that we can "partially" support very old persistence versions where we might need such a support. See VCSPersistenceSupport for an example.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelPersistence.HeaderOnlyHandler

Field Summary

Fields

Modifier and Type	Field	Description
static int	FIRST_SUPPORTED_VERSION
static int	LAST_VERSION
static String	MODEL
static String	MODEL_UID
static String	NAME
static String	PERSISTENCE
static String	PERSISTENCE_VERSION
static String	REF
static String	VALUE

Constructor Summary

Constructors

Constructor	Description
ModelPersistence()

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	calculateHashes(String content)
static List<LineContent>	getLineToContentMap(String content)
static SModelData	getModelData(InputStream input)
static IModelPersistence	getPersistence(int version)
static void	index(byte[] data, IndexAwareModelFactory.Callback newConsumer)	Deprecated. use index(InputStream, Callback) instead
static void	index(InputStream data, IndexAwareModelFactory.Callback newConsumer)
static boolean	isSupported(int version)
static SModelHeader	loadDescriptor(StreamDataSource source)
static SModelHeader	loadDescriptor(InputSource source)
static String	modelToString(SModel model)
static DefaultSModel	readModel(String content, boolean interfaceOnly)
static ModelLoadResult	readModel(SModelHeader header, StreamDataSource dataSource, ModelLoadingState state)
static DefaultSModel	readModel(StreamDataSource source, boolean interfaceOnly)
static org.jdom.Document	saveModel(SModel sourceModel)	Serialize model into xml, conformant to actual model's persistence version, if any, or current persistence version otherwise.
static DefaultSModel	saveModel(SModel model, StreamDataSource source, int persistenceVersion)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODEL

public static final String MODEL

See Also:

Constant Field Values

REF

public static final String REF

See Also:

Constant Field Values

MODEL_UID

public static final String MODEL_UID

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

PERSISTENCE

public static final String PERSISTENCE

See Also:

Constant Field Values

PERSISTENCE_VERSION

public static final String PERSISTENCE_VERSION

See Also:

Constant Field Values

FIRST_SUPPORTED_VERSION

public static final int FIRST_SUPPORTED_VERSION

See Also:

Constant Field Values

LAST_VERSION

public static final int LAST_VERSION

See Also:

Constant Field Values

Constructor Detail

ModelPersistence

public ModelPersistence()

Method Detail

isSupported

public static boolean isSupported(int version)

getPersistence

@Nullable
public static IModelPersistence getPersistence(int version)

loadDescriptor

@NotNull
public static SModelHeader loadDescriptor(InputSource source)
                                   throws ModelReadException

Throws:

ModelReadException

loadDescriptor

@NotNull
public static SModelHeader loadDescriptor(StreamDataSource source)
                                   throws ModelReadException

Throws:

ModelReadException

readModel

@NotNull
public static ModelLoadResult readModel(@NotNull
                                        SModelHeader header,
                                        @NotNull
                                        StreamDataSource dataSource,
                                        ModelLoadingState state)
                                 throws ModelReadException

Throws:

ModelReadException

getLineToContentMap

@Nullable
public static List<LineContent> getLineToContentMap(String content)
                                             throws ModelReadException

Throws:

ModelReadException

saveModel

public static DefaultSModel saveModel(@NotNull
                                      SModel model,
                                      @NotNull
                                      StreamDataSource source,
                                      int persistenceVersion)
                               throws IOException

Throws:

IOException

saveModel

@NotNull
public static org.jdom.Document saveModel(@NotNull
                                          SModel sourceModel)

Serialize model into xml, conformant to actual model's persistence version, if any, or current persistence version otherwise. The method doesn't update persistence version of the model (as it used to do)

calculateHashes

public static Map<String,String> calculateHashes(String content)
                                                throws ModelReadException

Throws:

ModelReadException

readModel

@NotNull
public static DefaultSModel readModel(@NotNull
                                      StreamDataSource source,
                                      boolean interfaceOnly)
                               throws ModelReadException

Throws:

ModelReadException

readModel

@NotNull
public static DefaultSModel readModel(@NotNull
                                      String content,
                                      boolean interfaceOnly)
                               throws ModelReadException

Throws:

ModelReadException

modelToString

@NotNull
public static String modelToString(@NotNull
                                   SModel model)

index

@Deprecated
public static void index(byte[] data,
                         IndexAwareModelFactory.Callback newConsumer)
                  throws IOException

Deprecated.

use index(InputStream, Callback) instead

Throws:

IOException

index

public static void index(InputStream data,
                         IndexAwareModelFactory.Callback newConsumer)
                  throws IOException

Throws:

IOException

getModelData

public static SModelData getModelData(@NotNull
                                      InputStream input)
                               throws IOException

Throws:

IOException