WorksheetCommand.java

/*******************************************************************************
 * Copyright 2012 University of Southern California
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * 	http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This code was developed by the Information Integration Group as part 
 * of the Karma project at the Information Sciences Institute of the 
 * University of Southern California.  For more information, publications, 
 * and related projects, please see: http://www.isi.edu/integration
 ******************************************************************************/
package edu.isi.karma.controller.command;

import java.io.PrintWriter;

import edu.isi.karma.controller.update.UpdateContainer;
import edu.isi.karma.controller.update.WorksheetUpdateFactory;
import edu.isi.karma.modeling.alignment.Alignment;
import edu.isi.karma.modeling.alignment.AlignmentManager;
import edu.isi.karma.rep.Workspace;
import edu.isi.karma.util.JSONUtil;
import edu.isi.karma.view.VWorkspace;


/**
 * Commands that operate on a worksheet.
 * 
 * @author szekely
 * 
 */
public abstract class WorksheetCommand extends Command {
	public enum JsonKeys {
		commandId, title, description, commandType, historyType, worksheetId
	}
	
	protected final String worksheetId;
	protected WorksheetCommand(String id, String model, String worksheetId) {
		super(id, model);
		this.worksheetId = worksheetId;
	}

	public String getWorksheetId() {
		return worksheetId;
	}
	

	public UpdateContainer computeAlignmentAndSemanticTypesAndCreateUpdates(Workspace workspace)
	{
		Alignment alignment = AlignmentManager.Instance().getAlignment(workspace.getId(), getWorksheetId());
		if(null != alignment)
		{
			alignment.updateColumnNodesInAlignment(workspace.getWorksheet(getWorksheetId()));
		}
		return WorksheetUpdateFactory.createSemanticTypesAndSVGAlignmentUpdates(getWorksheetId(), workspace);
	}
	
	@Override
	public void generateJson(String prefix, PrintWriter pw,
	                         VWorkspace vWorkspace, HistoryType historyType) {
		pw.println(prefix + "{");
		String newPref = prefix + "  ";
		generateCommandJSONAttributes(prefix, pw, vWorkspace, historyType);
		pw.println("," + newPref
				+ JSONUtil.jsonLast(JsonKeys.worksheetId, getWorksheetId()));
		pw.println(prefix + "}");
	}
}