Package com.google.refine.history

Class History

java.lang.Object

com.google.refine.history.History

public class History
extends Object

Track done and undone changes. Done changes can be undone; undone changes can be redone. Each change is actually not tracked directly but through a history entry. The history entry stores only the metadata, while the change object stores the actual data, thus the history entries are much smaller and can be kept in memory, while the change objects are only loaded into memory on demand.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<HistoryEntry>	_futureEntries
protected List<HistoryEntry>	_pastEntries
protected long	_projectID

Constructor Summary

Constructors

Constructor	Description
History(Project project)

Method Summary

Modifier and Type	Method	Description
void	addEntry(HistoryEntry entry)	Adds a HistoryEntry to the list of past histories Adding a new entry clears all currently held future histories
static Class<? extends Change>	getChangeClass(String className)
protected HistoryEntry	getEntry(long entryID)
List<HistoryEntry>	getLastPastEntries(int count)
long	getPrecedingEntryID(long entryID)
void	load(Project project, LineNumberReader reader)
static Change	readOneChange(InputStream in, Pool pool)
static Change	readOneChange(LineNumberReader reader, Pool pool)
protected void	redo(int times)
void	save(Writer writer, Properties options)
protected void	setModified()
protected void	undo(int times)
void	undoRedo(long lastDoneEntryID)
static void	writeOneChange(OutputStream out, Change change, Pool pool)
static void	writeOneChange(Writer writer, Change change, Pool pool)
static void	writeOneChange(Writer writer, Change change, Properties options)

Methods inherited from class java.lang.Object

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

Field Details

_projectID

protected long _projectID

_pastEntries

protected List<HistoryEntry> _pastEntries

_futureEntries

protected List<HistoryEntry> _futureEntries

Constructor Details

History

public History(Project project)

Method Details

readOneChange

public static Change readOneChange(InputStream in,
 Pool pool)
                            throws Exception

Throws:

Exception

readOneChange

public static Change readOneChange(LineNumberReader reader,
 Pool pool)
                            throws Exception

Throws:

Exception

writeOneChange

public static void writeOneChange(OutputStream out,
 Change change,
 Pool pool)
                           throws IOException

Throws:

IOException

writeOneChange

public static void writeOneChange(Writer writer,
 Change change,
 Pool pool)
                           throws IOException

Throws:

IOException

writeOneChange

public static void writeOneChange(Writer writer,
 Change change,
 Properties options)
                           throws IOException

Throws:

IOException

getChangeClass

public static Class<? extends Change> getChangeClass(String className)
                                              throws ClassNotFoundException

Throws:

ClassNotFoundException

addEntry

public void addEntry(HistoryEntry entry)

Adds a HistoryEntry to the list of past histories Adding a new entry clears all currently held future histories

Parameters:

entry -

setModified

protected void setModified()

getLastPastEntries

public List<HistoryEntry> getLastPastEntries(int count)

undoRedo

public void undoRedo(long lastDoneEntryID)

getPrecedingEntryID

public long getPrecedingEntryID(long entryID)

getEntry

protected HistoryEntry getEntry(long entryID)

undo

protected void undo(int times)

redo

protected void redo(int times)

save

public void save(Writer writer,
 Properties options)
          throws IOException

Throws:

IOException

load

public void load(Project project,
 LineNumberReader reader)
          throws IOException

Throws:

IOException