Package com.google.refine.commands

Class EngineDependentCommand

java.lang.Object

com.google.refine.commands.Command

com.google.refine.commands.EngineDependentCommand

Direct Known Subclasses:

AddColumnByFetchingURLsCommand, AddColumnCommand, AnnotateRowsCommand, BlankDownCommand, ExtendDataCommand, FillDownCommand, MassEditCommand, ReconcileCommand, ReconClearSimilarCellsCommand, ReconCopyAcrossColumnsCommand, ReconDiscardJudgmentsCommand, ReconJudgeSimilarCellsCommand, ReconMarkNewTopicsCommand, ReconMatchBestCandidatesCommand, ReconMatchSpecificTopicCommand, ReconUseValuesAsIdentifiersCommand, RemoveRowsCommand, ReorderColumnsCommand, ReorderRowsCommand, SplitColumnCommand, TextTransformCommand

public abstract class EngineDependentCommand
extends Command

Convenient super class for commands that perform abstract operations on only the filtered rows based on the faceted browsing engine's configuration on the client side. The engine's configuration is passed over as a POST body parameter. It is retrieved, de-serialized, and used to construct the abstract operation. The operation is then used to construct a process. The process is then queued for execution. If the process is not long running and there is no other queued process, then it gets executed right away, resulting in some change to the history. Otherwise, it is pending. The client side can decide how to update its UI depending on whether the process is done or still pending. Note that there are interactions on the client side that change only individual cells or individual rows (such as starring one row or editing the text of one cell). These interactions do not depend on the faceted browsing engine's configuration, and so they don't invoke commands that subclass this class. See AnnotateOneRowCommand and EditOneCellCommand as examples.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.refine.commands.Command

Command.HistoryEntryResponse

Field Summary

Fields inherited from class com.google.refine.commands.Command

csrfFactory, logger, servlet

Constructor Summary

Constructors

Constructor	Description
EngineDependentCommand()

Method Summary

Modifier and Type	Method	Description
protected abstract AbstractOperation	createOperation(Project project, javax.servlet.http.HttpServletRequest request, EngineConfig engineConfig)
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class com.google.refine.commands.Command

doDelete, doGet, doPut, getEngine, getEngineConfig, getIntegerParameter, getProject, getProjectMetadata, hasValidCSRFToken, hasValidCSRFTokenAsGET, init, logRequests, performProcessAndRespond, redirect, respond, respond, respondCSRFError, respondException, respondJSON, respondJSON, respondWithErrorPage

Methods inherited from class java.lang.Object

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

Constructor Details

EngineDependentCommand

public EngineDependentCommand()

Method Details

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
IOException

Overrides:

doPost in class Command

Throws:

javax.servlet.ServletException

IOException

createOperation

protected abstract AbstractOperation createOperation(Project project,
 javax.servlet.http.HttpServletRequest request,
 EngineConfig engineConfig)
                                              throws Exception

Throws:

Exception