Package jetbrains.mps.persistence

Class PersistenceRegistry

java.lang.Object

org.jetbrains.mps.openapi.persistence.PersistenceFacade

jetbrains.mps.persistence.PersistenceRegistry

All Implemented Interfaces:

CoreComponent

public class PersistenceRegistry
extends PersistenceFacade
implements CoreComponent

evgeny, 10/23/12

Nested Class Summary

Nested classes/interfaces inherited from class org.jetbrains.mps.openapi.persistence.PersistenceFacade

PersistenceFacade.IncorrectModelReferenceFormatException, PersistenceFacade.IncorrectNodeIdFormatException

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_MODEL_ROOT
static String	JAVA_CLASSES_ROOT
static String	OBSOLETE_MODEL_ROOT

Fields inherited from class org.jetbrains.mps.openapi.persistence.PersistenceFacade

INSTANCE

Constructor Summary

Constructors

Constructor	Description
PersistenceRegistry(ModelFactoryService modelFactoryService, DataSourceFactoryRuleService dsRegistry)

Method Summary

Modifier and Type	Method	Description
void	addFindUsagesParticipant(FindUsagesParticipant participant)
void	addNavigationParticipant(NavigationParticipant participant)
String	asString(SModelId modelId)	Serialize counterpart for PersistenceFacade.createModelId(String), persistence-ready presentation of a model identifier.
String	asString(SModelReference modelRef)	Serialize counterpart for PersistenceFacade.createModelReference(String), persistence-ready presentation of a model reference
String	asString(SNodeReference nodeRef)	Serialize counterpart for PersistenceFacade.createNodeReference(String), persistence-ready presentation of a node reference.
String	asString(SModuleId moduleId)
String	asString(SModuleReference reference)	Serialize counterpart for PersistenceFacade.createModuleReference(String).
SModelId	createModelId(String text)	Creates an SModelId from a given text identifier.
SModelReference	createModelReference(String text)	Creates an SModelReference from a given text identifier.
SModelReference	createModelReference(SModuleReference module, SModelId modelId, String modelName)	Creates an SModelReference in a module with a given model id and model name.
SModelReference	createModelReference(SModuleReference module, SModelId modelId, SModelName modelName)	Creates an SModelReference in a module with a given model id and model name.
SModuleId	createModuleId(String text)
SModuleReference	createModuleReference(String text)
SModuleReference	createModuleReference(SModuleId moduleId, String moduleName)
SNodeId	createNodeId(String nodeIdString)	Creates an SNodeId from a given text identifier.
SNodeReference	createNodeReference(String text)
void	disableFastFindUsages()
void	dispose()
void	enableFastFindUsages()
ModelFactory	getDefaultModelFactory()	Deprecated.
Set<FindUsagesParticipant>	getFindUsagesParticipants()	Find usages participants speed-up usages search by indexing the content.
static PersistenceRegistry	getInstance()	Deprecated.
ModelFactory	getModelFactory(String extension)	Deprecated.
ModelFactory	getModelFactory(DataSourceType dataSourceType)
ModelFactory	getModelFactory(ModelFactoryType type)
ModelRootFactory	getModelRootFactory(String type)	Retrieves the factory associated with the given type
Set<NavigationParticipant>	getNavigationParticipants()	Navigation participants speed-up building Go to lists by indexing the available targets.
Iterable<String>	getTypeIds()	Retrieves all registered types of model roots FIXME shall rename to smth more meaningful (to reflect it's about model roots)
void	init()
boolean	isFastSearch()
void	removeFindUsagesParticipant(FindUsagesParticipant participant)
void	removeNavigationParticipant(NavigationParticipant participant)
void	setModelIdFactory(String type, SModelIdFactory factory)	Registers the factory with the model id type, overwriting potential earlier registration.
void	setModelRootFactory(String type, ModelRootFactory factory)	Registers the factory with the given type, overwriting potential earlier registration.
void	setNodeIdFactory(String type, SNodeIdFactory factory)	Registers the factory with the node id type, overwriting potential earlier registration.

Methods inherited from class org.jetbrains.mps.openapi.persistence.PersistenceFacade

asString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MODEL_ROOT

public static final String DEFAULT_MODEL_ROOT

See Also:

Constant Field Values

OBSOLETE_MODEL_ROOT

public static final String OBSOLETE_MODEL_ROOT

See Also:

Constant Field Values

JAVA_CLASSES_ROOT

public static final String JAVA_CLASSES_ROOT

See Also:

Constant Field Values

Constructor Detail

PersistenceRegistry

public PersistenceRegistry(ModelFactoryService modelFactoryService,
                           DataSourceFactoryRuleService dsRegistry)

Method Detail

getInstance

@Deprecated
public static PersistenceRegistry getInstance()

Deprecated.

access the component using ComponentHost#findComponent(PersitenceFacade.class)

getModelRootFactory

public ModelRootFactory getModelRootFactory(@NotNull
                                            String type)

Description copied from class: PersistenceFacade

Retrieves the factory associated with the given type

Specified by:

getModelRootFactory in class PersistenceFacade

setModelRootFactory

public void setModelRootFactory(@NotNull
                                String type,
                                @Nullable
                                ModelRootFactory factory)

Description copied from class: PersistenceFacade

Registers the factory with the given type, overwriting potential earlier registration.

Specified by:

setModelRootFactory in class PersistenceFacade

factory - The factory to register, null to clear the registration for the given type.

getModelFactory

@Deprecated
public ModelFactory getModelFactory(@Nullable
                                    String extension)

Deprecated.

Description copied from class: PersistenceFacade

Retrieves the factory associated with the given file extension.

Specified by:

getModelFactory in class PersistenceFacade

getModelFactory

@Nullable
public ModelFactory getModelFactory(@NotNull
                                    ModelFactoryType type)

Specified by:

getModelFactory in class PersistenceFacade

Returns:

the ModelFactory which was registered last. Use ModelFactoryRegister extension point in order to register a custom ModelFactory.

getModelFactory

@Nullable
public final ModelFactory getModelFactory(@NotNull
                                          DataSourceType dataSourceType)

Specified by:

getModelFactory in class PersistenceFacade

Returns:

the ModelFactory which was registered last and has in its ModelFactory.getPreferredDataSourceTypes() the dataSourceType.

getDefaultModelFactory

@Deprecated
public ModelFactory getDefaultModelFactory()

Deprecated.

Description copied from class: PersistenceFacade

Retrieves the factory for default MPS storage format (xml-based).

Specified by:

getDefaultModelFactory in class PersistenceFacade

createModuleId

@NotNull
public SModuleId createModuleId(@NotNull
                                String text)

Specified by:

createModuleId in class PersistenceFacade

Returns:

module identity object created from persistence text

asString

@NotNull
public String asString(@NotNull
                       SModuleId moduleId)

Specified by:

asString in class PersistenceFacade

Returns:

textual representation of the identifier ready for persistence

asString

public String asString(@NotNull
                       SModuleReference reference)

Description copied from class: PersistenceFacade

Serialize counterpart for PersistenceFacade.createModuleReference(String).

Specified by:

asString in class PersistenceFacade

Parameters:

reference - module reference to serialize

Returns:

persistence-ready presentation of a module identifier

createModuleReference

public SModuleReference createModuleReference(@NotNull
                                              String text)

Specified by:

createModuleReference in class PersistenceFacade

createModuleReference

public SModuleReference createModuleReference(@NotNull
                                              SModuleId moduleId,
                                              String moduleName)

Specified by:

createModuleReference in class PersistenceFacade

Returns:

module identity constructed from the fragments supplied

createModelId

public SModelId createModelId(@NotNull
                              String text)

Description copied from class: PersistenceFacade

Creates an SModelId from a given text identifier. Allows implementations to provide their own version of SModelId.

Specified by:

createModelId in class PersistenceFacade

Parameters:

text - A text that the custom implementation of SModelIdFactory could use to build its own SModelId. The text comes in the following format: "type:restInterpretedByTheConcreteTypeProvider" The actual type of the model id is followed by implementation-specific text.

See Also:

PersistenceFacade.asString(org.jetbrains.mps.openapi.model.SModelId)

asString

public String asString(@NotNull
                       SModelId modelId)

Description copied from class: PersistenceFacade

Serialize counterpart for PersistenceFacade.createModelId(String), persistence-ready presentation of a model identifier.

Specified by:

asString in class PersistenceFacade

Parameters:

modelId - model identity

Returns:

textual representation of a model identifier ready for persistence

createModelReference

@NotNull
public SModelReference createModelReference(@NotNull
                                            String text)

Description copied from class: PersistenceFacade

Creates an SModelReference from a given text identifier.

Specified by:

createModelReference in class PersistenceFacade

asString

public String asString(@NotNull
                       SModelReference modelRef)

Description copied from class: PersistenceFacade

Serialize counterpart for PersistenceFacade.createModelReference(String), persistence-ready presentation of a model reference

Specified by:

asString in class PersistenceFacade

Parameters:

modelRef - model reference to serialize

Returns:

textual representation of a model reference

createModelReference

public SModelReference createModelReference(SModuleReference module,
                                            @NotNull
                                            SModelId modelId,
                                            @NotNull
                                            String modelName)

Description copied from class: PersistenceFacade

Creates an SModelReference in a module with a given model id and model name. Prefer PersistenceFacade.createModelReference(SModuleReference, SModelId, SModelName) alternative that takes SModelName.

Specified by:

createModelReference in class PersistenceFacade

Parameters:

module - can be null only if modelId is globally unique (i.e. can be resolved without a module)

createModelReference

public SModelReference createModelReference(SModuleReference module,
                                            @NotNull
                                            SModelId modelId,
                                            @NotNull
                                            SModelName modelName)

Description copied from class: PersistenceFacade

Creates an SModelReference in a module with a given model id and model name.

Specified by:

createModelReference in class PersistenceFacade

Parameters:

module - can be null only if modelId is globally unique (i.e. can be resolved without a module)

modelId - identity of a model either globally or within a module

modelName - user-friendly name of a model

setModelIdFactory

public void setModelIdFactory(String type,
                              SModelIdFactory factory)

Description copied from class: PersistenceFacade

Registers the factory with the model id type, overwriting potential earlier registration.

Specified by:

setModelIdFactory in class PersistenceFacade

factory - The factory to register, null to clear the registration for the given type.

createNodeId

@Nullable
public SNodeId createNodeId(@NotNull
                            String nodeIdString)

Description copied from class: PersistenceFacade

Creates an SNodeId from a given text identifier. Allows implementations to provide their own version of SNodeId.

Specified by:

createNodeId in class PersistenceFacade

Parameters:

nodeIdString - A text that the custom implementation of SNodeIdFactory could use to build its own SNodeId. The text comes in the following format: "type:restInterpretedByTheConcreteTypeProvider" The actual type of the node id is followed by implementation-specific text.

asString

@NotNull
public String asString(@NotNull
                       SNodeReference nodeRef)

Description copied from class: PersistenceFacade

Serialize counterpart for PersistenceFacade.createNodeReference(String), persistence-ready presentation of a node reference.

Specified by:

asString in class PersistenceFacade

Parameters:

nodeRef - node reference to serialize

Returns:

textual representation of node reference

createNodeReference

public SNodeReference createNodeReference(@NotNull
                                          String text)

Specified by:

createNodeReference in class PersistenceFacade

setNodeIdFactory

public void setNodeIdFactory(String type,
                             SNodeIdFactory factory)

Description copied from class: PersistenceFacade

Registers the factory with the node id type, overwriting potential earlier registration.

Specified by:

setNodeIdFactory in class PersistenceFacade

factory - The factory to register, null to clear the registration for the given type.

getTypeIds

public Iterable<String> getTypeIds()

Description copied from class: PersistenceFacade

Retrieves all registered types of model roots FIXME shall rename to smth more meaningful (to reflect it's about model roots)

Specified by:

getTypeIds in class PersistenceFacade

addFindUsagesParticipant

public void addFindUsagesParticipant(FindUsagesParticipant participant)

Specified by:

addFindUsagesParticipant in class PersistenceFacade

removeFindUsagesParticipant

public void removeFindUsagesParticipant(FindUsagesParticipant participant)

Specified by:

removeFindUsagesParticipant in class PersistenceFacade

getFindUsagesParticipants

public Set<FindUsagesParticipant> getFindUsagesParticipants()

Description copied from class: PersistenceFacade

Find usages participants speed-up usages search by indexing the content. see FindUsagesParticipant

Specified by:

getFindUsagesParticipants in class PersistenceFacade

isFastSearch

public boolean isFastSearch()

addNavigationParticipant

public void addNavigationParticipant(NavigationParticipant participant)

Specified by:

addNavigationParticipant in class PersistenceFacade

removeNavigationParticipant

public void removeNavigationParticipant(NavigationParticipant participant)

Specified by:

removeNavigationParticipant in class PersistenceFacade

getNavigationParticipants

public Set<NavigationParticipant> getNavigationParticipants()

Description copied from class: PersistenceFacade

Navigation participants speed-up building Go to lists by indexing the available targets. see NavigationParticipant

Specified by:

getNavigationParticipants in class PersistenceFacade

init

public void init()

Specified by:

init in interface CoreComponent

dispose

public void dispose()

Specified by:

dispose in interface CoreComponent

disableFastFindUsages

public void disableFastFindUsages()

enableFastFindUsages

public void enableFastFindUsages()