Package org.openrefine.model.changes

Interface ChangeContext

All Known Implementing Classes:

ChangeContextImpl

public interface ChangeContext

Stores information that changes can rely on when modifying the project grid.

If we add multi-user support, we could for instance expose the user who committed the change, if we want this to let this information influence the change.

Method Summary

Modifier and Type	Method	Description
static ChangeContext	create(long historyEntryId, long projectId, ChangeDataStore dataStore, String description)	Creates a change context for a given history entry id and a project id.
<T> ChangeData<T>	getChangeData(String dataId, ChangeDataSerializer<T> serializer, Function<Optional<ChangeData<T>>,ChangeData<T>> completionProcess)	Retrieves a ChangeData from the underlying ChangeDataStore.
String	getChangeDescription()
long	getHistoryEntryId()
long	getProjectId()

Method Detail

create

static ChangeContext create(long historyEntryId,
                            long projectId,
                            ChangeDataStore dataStore,
                            String description)

Creates a change context for a given history entry id and a project id.

getHistoryEntryId

long getHistoryEntryId()

getProjectId

long getProjectId()

getChangeDescription

String getChangeDescription()

getChangeData

<T> ChangeData<T> getChangeData(String dataId,
                                ChangeDataSerializer<T> serializer,
                                Function<Optional<ChangeData<T>>,ChangeData<T>> completionProcess)
                         throws IOException

Retrieves a ChangeData from the underlying ChangeDataStore. It must have been registered in the store beforehand.

Throws:

IOException