```
public interface ModelFactory
```
Represents a data source loading/saving/upgrading strategy. The location resides rather on the DataSource side than here while the storage parameters belong here. NB: The ModelFactory knows about DataSource but not vice versa. Creates/upgrades/saves/loads models (instances of SModel) from data sources. NB: the default implementation of the methods added in 3.5 will be dropped at the 2017.3 minor release. Please do not linger to pass on the new API.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`OPTION_CONTENT_ONLY`	Deprecated. String option is not informatory.
`static String`	`OPTION_MODELNAME`	Deprecated. this option is unnecessary.
`static String`	`OPTION_MODULEREF`	Deprecated. not used currently
`static String`	`OPTION_PACKAGE`	Deprecated. not used currently
`static String`	`OPTION_RELPATH`	Deprecated. not in use anymore

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`canCreate(DataSource dataSource, Map<String,String> options)`	Deprecated. rather try calling `create(DataSource, SModelName, ModelLoadingOption...)` method and catching the `ModelCreationException` during creation or use `supports(DataSource)` method to acknowledge whether this data source is supported at all.
`SModel`	`create(DataSource dataSource, Map<String,String> options)`	Deprecated. use more flexible `create(DataSource, SModelName, ModelLoadingOption...)` instead
`default SModel`	`create(DataSource dataSource, SModelName modelName, ModelLoadingOption... options)`	Creates a new model with the supplied `modelName` on the given `DataSource`.
`String`	`getFileExtension()`	Deprecated. Outrageous breaking of the separation location from the loading strategy principle, which is planted in the create, load, etc.
`String`	`getFormatTitle()`	Deprecated. use `getType()` and `ModelFactoryType.getFormatTitle()` instead
`default List<DataSourceType>`	`getPreferredDataSourceTypes()`	Declares a list of preferred data source formats, sorted from the most preferred to the less preferred data source type.
`default ModelFactoryType`	`getType()`	Returns an id which is used to get model factory by id in the `ModelFactoryService`.
`boolean`	`isBinary()`	returns true if plain text is not enough to represent stored data.
`SModel`	`load(DataSource dataSource, Map<String,String> options)`	Deprecated. `Map` is hardly perceivable.
`default SModel`	`load(DataSource dataSource, ModelLoadingOption... options)`	Loads an existing model from the given `DataSource`.
`boolean`	`needsUpgrade(DataSource dataSource)`	Checks if the source content is outdated and needs to be upgraded.
`void`	`save(SModel model, DataSource dataSource)`	Saves the model in the factory-specific format (including conversion when needed).
`default boolean`	`supports(DataSource dataSource)`	Determines whether the provided data source is maintained by this model factory instance.
`void`	`upgrade(DataSource dataSource)`	Loads the model content, and saves it back in the up-to-date format.

- Field Detail
  - OPTION_MODULEREF
```
@Deprecated
static final String OPTION_MODULEREF
```
    Deprecated.
    not used currently
    
    See Also:
    
    Constant Field Values
  - OPTION_PACKAGE
```
@Deprecated
static final String OPTION_PACKAGE
```
    Deprecated.
    not used currently
    
    See Also:
    
    Constant Field Values
  - OPTION_RELPATH
```
@Deprecated
static final String OPTION_RELPATH
```
    Deprecated.
    not in use anymore
    
    See Also:
    
    Constant Field Values
  - OPTION_MODELNAME
```
@Deprecated
static final String OPTION_MODELNAME
```
    Deprecated.
    this option is unnecessary. Use create(DataSource, SModelName, ModelLoadingOption...) instead.
    
    Denotes a model name, used as a key in the Map parameter in the create(DataSource, Map) methods.
    
    See Also:
    
    Constant Field Values
  - OPTION_CONTENT_ONLY
```
@Deprecated
static final String OPTION_CONTENT_ONLY
```
    Deprecated.
    String option is not informatory. Use a ContentOption instead
    
    Boolean value, indicates we don't care to build complete model on load, rather read content as-is, and tread loaded model as mere container for nodes, SModelData-like. We use this mechanism from merge driver and various tools that are going to access nodes from the model but are not going to expose this model anywhere else.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - load
```
@Deprecated
@NotNull
SModel load(@NotNull
            DataSource dataSource,
            @NotNull
            Map<String,String> options)
     throws IOException
```
    Deprecated.
    Map is hardly perceivable. Please use rather load(DataSource, ModelLoadingOption...) instead
    
    Instantiates a model on a given data source. Options can be used to pass additional parameters like stream encoding (usually, the default is utf-8), package name, containing module reference or module relative path of the source.
    
    Returns:
    
    The loaded model
    
    Throws:
    
    UnsupportedDataSourceException - if the data source is not supported
    
    IOException
  - create
```
@Deprecated
@NotNull
SModel create(@NotNull
              DataSource dataSource,
              @NotNull
              Map<String,String> options)
       throws IOException
```
    Deprecated.
    use more flexible create(DataSource, SModelName, ModelLoadingOption...) instead
    
    Creates a new empty model. Implementor must throw UnsupportedDataSourceException if #canCreate returns false.
    
    Parameters:
    
    dataSource - if null then the default data source is created for the supplied model name
    
    options - must content OPTION_MODELNAME mapping.
    
    Throws:
    
    UnsupportedDataSourceException - if the data source is not supported, in other words canCreate(DataSource, Map) returns false
    
    IOException - if the model cannot be created for some other reasons
  - canCreate
```
@Deprecated
boolean canCreate(@NotNull
                  DataSource dataSource,
                  @NotNull
                  Map<String,String> options)
```
    Deprecated.
    rather try calling create(DataSource, SModelName, ModelLoadingOption...) method and catching the ModelCreationException during creation or use supports(DataSource) method to acknowledge whether this data source is supported at all.
    
    Indicates, whether the supplied data source can be used to hold models created by this factory. --------- Currently this method implementations are quite shallow and de facto it does not work at all as the API designer must have suggested. Now the real semantics of this method is whether the data source is supported by the ModelFactory. I suggest to use the honest supports(org.jetbrains.mps.openapi.persistence.DataSource) method and catch the ModelCreationException post factum rather then do the check beforehand. AP ---------
  - supports
```
default boolean supports(@NotNull
                         DataSource dataSource)
```
    Determines whether the provided data source is maintained by this model factory instance. Call it before calling load/create/upgrade methods in order to avoid the UnsupportedDataSourceException.
    
    Returns:
    
    true iff the given data source can be managed by this factory
  - create
```
@NotNull
default SModel create(@NotNull
                      DataSource dataSource,
                      @NotNull
                      SModelName modelName,
                      @NotNull
                      ModelLoadingOption... options)
               throws UnsupportedDataSourceException,
                      ModelCreationException
```
    Creates a new model with the supplied modelName on the given DataSource. Might consider additional options provided in the options varargs. [General rule: options.contain(SomeOption) => SomeOption is on]
    
    Parameters:
    
    dataSource - -- location to create the model in
    
    modelName - -- a new model name (note that it might be constructed easily from full-qualified String)
    
    options - -- custom options
    
    Returns:
    
    newly created model
    
    Throws:
    
    UnsupportedDataSourceException - iff supports(DataSource) returns false
    
    ModelCreationException - iff there was an irrecoverable problem during creation (for instance model file already exists)
    
    See Also:
    
    ModelLoadingOption
  - load
```
@NotNull
default SModel load(@NotNull
                    DataSource dataSource,
                    @NotNull
                    ModelLoadingOption... options)
             throws UnsupportedDataSourceException,
                    ModelLoadException
```
    Loads an existing model from the given DataSource. Might consider additional options provided in the options varargs. [General rule: options.contain(SomeOption) => SomeOption is on]
    
    Parameters:
    
    dataSource - -- location to load model from
    
    options - -- custom options
    
    Returns:
    
    loaded model
    
    Throws:
    
    UnsupportedDataSourceException - iff supports(DataSource) returns false
    
    ModelLoadException - iff there was an irrecoverable load problem (for instance format was broken or unrecognized)
    
    See Also:
    
    ModelLoadingOption
  - needsUpgrade
```
boolean needsUpgrade(@NotNull
                     DataSource dataSource)
              throws IOException
```
    Checks if the source content is outdated and needs to be upgraded.
    
    Throws:
    
    UnsupportedDataSourceException - if the data source is not supported
    
    IOException
  - upgrade
```
void upgrade(@NotNull
             DataSource dataSource)
      throws IOException
```
    Loads the model content, and saves it back in the up-to-date format.
    
    Throws:
    
    UnsupportedDataSourceException - if the data source is not supported
    
    IOException
  - save
```
void save(@NotNull
          SModel model,
          @NotNull
          DataSource dataSource)
   throws UnsupportedDataSourceException,
          ModelSaveException,
          IOException
```
    Saves the model in the factory-specific format (including conversion when needed).
    
    Throws:
    
    UnsupportedDataSourceException - if the data source is not supported
    
    ModelSaveException
    
    IOException
  - isBinary
```
boolean isBinary()
```
    returns true if plain text is not enough to represent stored data. // @deprecated The contract is not clear ("not enough" means what exactly?). We would rather turn this into some marker interface than have it here
  - getFileExtension
```
@Deprecated
@Nullable
String getFileExtension()
```
    Deprecated.
    Outrageous breaking of the separation location from the loading strategy principle, which is planted in the create, load, etc. methods. The location notion is hidden in DataSource and there is absolutely no need to expose it. In order to work out the currently running scenarios we set up special DataSourceFactory <-> ModelFactory relations which are exposed through the DataSourceFactoryRuleService, ModelFactoryService and getPreferredDataSourceTypes().
    
    Returns:
    
    the file extension this factory is registered on null if for instance model factory is associated rather with a group of files than one file.
  - getFormatTitle
```
@NotNull
@Deprecated
String getFormatTitle()
```
    Deprecated.
    use getType() and ModelFactoryType.getFormatTitle() instead
    
    User-readable title of the storage format.
  - getType
```
@NotNull
default ModelFactoryType getType()
```
    Returns an id which is used to get model factory by id in the ModelFactoryService.
    
    Returns:
    
    model factory unique identification entity
  - getPreferredDataSourceTypes
```
@NotNull
default List<DataSourceType> getPreferredDataSourceTypes()
```
    Declares a list of preferred data source formats, sorted from the most preferred to the less preferred data source type.
    
    Returns:
    
    a list of data source kinds which might be considered when MPS meets a data source location and needs to choose a model factory which is likely to support the content of the data source. For instance if we have data source types associated with file names (e.g. prefix or suffix) we are able to establish a file name pattern association with a specific model factory. For example each model file which ends with '.mps_binary' suffix would be associated with the corresponding data source type which in turn would be associated with 'MyBinaryModelFactory'.

Interface ModelFactory

Field Summary

Method Summary

Field Detail

OPTION_MODULEREF

OPTION_PACKAGE

OPTION_RELPATH

OPTION_MODELNAME

OPTION_CONTENT_ONLY

Method Detail

load

create

canCreate

supports

create

load

needsUpgrade

upgrade

save

isBinary

getFileExtension

getFormatTitle

getType

getPreferredDataSourceTypes