Package jetbrains.mps.extapi.persistence

Class FileDataSource

java.lang.Object

jetbrains.mps.extapi.persistence.DataSourceBase

jetbrains.mps.extapi.persistence.FileDataSource

All Implemented Interfaces:

DisposableDataSource, FileSystemBasedDataSource, FileListener, FileSystemListener, DataSource, StreamDataSource

Direct Known Subclasses:

FileWithBackupDataSource

public class FileDataSource
extends DataSourceBase
implements StreamDataSource, FileSystemListener, FileSystemBasedDataSource

A data source which points explicitly to the single file location. Currently it also knows something about vfs (listens to the events) but it is going to be cleared away. Also it is worth considering the merging of this notion with the FolderDataSource and others which points to some files on the file system. It seems that it is unnecessary to separate these entities [as soon as there is no additional vfs functionality] AP

Constructor Summary

Constructors

Constructor	Description
FileDataSource(IFile file)
FileDataSource(IFile file, ModelRoot modelRoot)	Deprecated. use DataSourceFactoryRuleService.getFactory(org.jetbrains.mps.openapi.persistence.datasource.DataSourceType) AND DataSourceFactoryFromName.create(org.jetbrains.mps.openapi.model.SModelName, jetbrains.mps.extapi.persistence.SourceRoot)

Method Summary

Modifier and Type	Method	Description
void	addListener(DataSourceListener listener)	Registers listeners who need to be notified about changes in the underlying data source.
void	delete()	Invoked with intention never come across this data source again.
protected void	fireChanged(ProgressMonitor monitor)
Collection<IFile>	getAffectedFiles()
IFile	getFile()
IFile	getFileToListen()
String	getLocation()	Yields a string representation for the location of the data source (if applicable)
long	getTimestamp()	Retrieves the last modification timestamp.
DataSourceType	getType()	Defines a data source type for this kind of data sources.
boolean	isReadOnly()	TODO Makes sense only with API which introduce changes to the DataSource.
InputStream	openInputStream()
OutputStream	openOutputStream()
void	refresh()
void	removeListener(DataSourceListener listener)
void	setFile(IFile file)
protected void	startListening()
protected void	stopListening()
void	update(ProgressMonitor monitor, FileSystemEvent event)	listener gets here all the events

Methods inherited from class jetbrains.mps.extapi.persistence.DataSourceBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.mps.vfs.refresh.FileListener

listeningPreferences

Methods inherited from interface jetbrains.mps.vfs.refresh.FileSystemListener

getListenerDependencies

Constructor Detail

FileDataSource

public FileDataSource(@NotNull
                      IFile file)

FileDataSource

@Deprecated
public FileDataSource(@NotNull
                      IFile file,
                      @Nullable
                      ModelRoot modelRoot)

Deprecated.

use DataSourceFactoryRuleService.getFactory(org.jetbrains.mps.openapi.persistence.datasource.DataSourceType) AND DataSourceFactoryFromName.create(org.jetbrains.mps.openapi.model.SModelName, jetbrains.mps.extapi.persistence.SourceRoot)

FIXME remove modelRoot parameter

Parameters:

modelRoot - (optional) containing model root, which should be notified before the source during the update

Method Detail

getFile

@NotNull
public IFile getFile()

setFile

public void setFile(@NotNull
                    IFile file)

isReadOnly

public boolean isReadOnly()

Description copied from interface: DataSource

TODO Makes sense only with API which introduce changes to the DataSource. Currently it is incomplete. Usually there is a possibility to edit DataSource. For examples please see StreamDataSource.

Specified by:

isReadOnly in interface DataSource

Overrides:

isReadOnly in class DataSourceBase

Returns:

whether this data source can be changed.

getLocation

@NotNull
public String getLocation()

Description copied from interface: DataSource

Yields a string representation for the location of the data source (if applicable)

Specified by:

getLocation in interface DataSource

Overrides:

getLocation in class DataSourceBase

openInputStream

public InputStream openInputStream()
                            throws IOException

Specified by:

openInputStream in interface StreamDataSource

Throws:

IOException

openOutputStream

public OutputStream openOutputStream()
                              throws IOException

Specified by:

openOutputStream in interface StreamDataSource

Throws:

IOException

refresh

public void refresh()

Overrides:

refresh in class DataSourceBase

getTimestamp

public long getTimestamp()

Description copied from interface: DataSource

Retrieves the last modification timestamp. The timestamp should reliably reflect all external changes to the data source.

Specified by:

getTimestamp in interface DataSource

Overrides:

getTimestamp in class DataSourceBase

Returns:

0 if timestamp is not supported for the source, or -1 if the source is dead (like when file is deleted)

addListener

public final void addListener(@NotNull
                              DataSourceListener listener)

Description copied from interface: DataSource

Registers listeners who need to be notified about changes in the underlying data source. It is the responsibility of the DataSource to detect such updates and notify the listeners.

Specified by:

addListener in interface DataSource

Overrides:

addListener in class DataSourceBase

startListening

protected void startListening()

removeListener

public final void removeListener(@NotNull
                                 DataSourceListener listener)

Specified by:

removeListener in interface DataSource

Overrides:

removeListener in class DataSourceBase

delete

public void delete()

Description copied from interface: DisposableDataSource

Invoked with intention never come across this data source again. For a file/folder/DB entry, this would mean 'wipe out'.

Specified by:

delete in interface DisposableDataSource

stopListening

protected void stopListening()

getFileToListen

@NotNull
public IFile getFileToListen()

Specified by:

getFileToListen in interface FileSystemListener

update

public void update(ProgressMonitor monitor,
                   @NotNull
                   FileSystemEvent event)

Description copied from interface: FileListener

listener gets here all the events

Specified by:

update in interface FileListener

fireChanged

protected void fireChanged(ProgressMonitor monitor)

getAffectedFiles

@NotNull
public Collection<IFile> getAffectedFiles()

Specified by:

getAffectedFiles in interface FileSystemBasedDataSource

Returns:

collection of files (or folders) which comprise a set of source paths (!) for this DataSource CONTRACT: Minimality: 1. If a 'file' is in the result then 'file.getParent()' could not be among resulting files 2. All the files in the directory could not be there (the parent directory as a whole would be returned instead)

getType

@NotNull
public DataSourceType getType()

Description copied from interface: DataSource

Defines a data source type for this kind of data sources. The data source type notion is strongly associated with the possibility to provide DataSourceFactory and ModelFactory custom mappings. See DataSourceFactoryRuleService and ModelFactoryService for the implementation details.

Specified by:

getType in interface DataSource

Overrides:

getType in class DataSourceBase

Returns:

the unique data source type for this instance of data source if the developer wants others to be able to change the default behavior of this data source (register with the same key) or if he desires to associate this data source with some specific model factory.