org.simplity.tp.ReplaceAttachment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kernel Show documentation
The newest version!
/*
 * Copyright (c) 2015 EXILANT Technologies Private Limited (www.exilant.com)
 * Copyright (c) 2016 simplity.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.simplity.tp;

import org.simplity.kernel.Tracer;
import org.simplity.kernel.comp.ComponentManager;
import org.simplity.kernel.comp.ValidationContext;
import org.simplity.kernel.data.DataSheet;
import org.simplity.kernel.data.SingleRowSheet;
import org.simplity.kernel.db.DbAccessType;
import org.simplity.kernel.db.DbDriver;
import org.simplity.kernel.dm.Field;
import org.simplity.kernel.dm.Record;
import org.simplity.kernel.value.Value;
import org.simplity.kernel.value.ValueType;
import org.simplity.service.ServiceContext;
import org.simplity.service.ServiceProtocol;

/**
 * Save (add/modify/delete) a row from a record, and possibly save relevant rows
 * from related records
 *
 *
 * @author simplity.org
 *
 */
public class ReplaceAttachment extends DbAction {

	/**
	 * rdbms table that has this column
	 */
	String recordName;

	/**
	 * field name of this attachment. This is the name that we refer in our
	 * service context. This is the name that is known to client
	 */
	String attachmentFieldName;

	private String selectSql;
	private String updateSql;
	private String keyFieldName;
	@Override
	protected int doDbAct(ServiceContext ctx, DbDriver driver) {
		Value tokenValue = ctx.getValue(this.attachmentFieldName);
		Value keyValue = ctx.getValue(this.keyFieldName);
		Value[] values = { keyValue };
		String[] columnNames = { this.attachmentFieldName };
		ValueType[] valueTypes = { ValueType.TEXT };
		DataSheet outData = new SingleRowSheet(columnNames, valueTypes);
		int res = driver.extractFromSql(this.selectSql, values, outData, true);
		if (res == 0) {
			Tracer.trace("No row found while reading from record "
					+ this.recordName + " for key value " + keyValue
					+ " and hence no update.");
			return 0;
		}
		/*
		 * save this token into fieldNameOld. Service will take care of removing
		 * this on exit
		 */
		ctx.setValue(this.attachmentFieldName + ServiceProtocol.OLD_ATT_TOKEN_SUFFIX, outData.getRow(0)[0]);

		/*
		 * update row with new value
		 */
		Value[] updateValues = { tokenValue, keyValue };
		return driver.executeSql(this.updateSql, updateValues, false);
	}

	@Override
	public DbAccessType getDataAccessType() {
		return DbAccessType.READ_WRITE;
	}

	@Override
	public int validate(ValidationContext ctx, Service service) {
		int count = super.validate(ctx, service);
		count += ctx.checkMandatoryField("attachmentFieldName", this.attachmentFieldName);
		count += ctx.checkMandatoryField("recordName", this.recordName);
		int j = ctx.checkRecordExistence(this.recordName, "recordName", true);
		if (j == 0) {
			Record record = ComponentManager.getRecordOrNull(this.recordName);
			Field field = record.getField(this.attachmentFieldName);
			if (field == null) {
				ctx.addError(this.attachmentFieldName
						+ " is defined an an attachmentField, but this field is not defined in this record");
			}
			Field[] keyFields = record.getPrimaryKeyFields();
			if(keyFields == null || keyFields.length > 1) {
				ctx.addError("Record " + this.recordName + " has " + (keyFields == null ? "not defined a primary key." : "defined a primary key with more than one columns.")
						+ ". Our designe require sthat this record defines a single primary key.");
			}
		} else {
			count++;
		}
		return count;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.simplity.tp.Action#getReady(int)
	 */
	@Override
	public void getReady(int idx, Service service) {
		super.getReady(idx, service);
		this.createSqls();
	}

	private void createSqls() {
		Record record = ComponentManager.getRecord(this.recordName);
		this.keyFieldName = record.getPrimaryKeyFields()[0].getName();

		String tableName = record.getTableName();
		String attColName = record.getField(this.attachmentFieldName)
				.getColumnName();
		String keyColName = record.getField(this.keyFieldName).getColumnName();

		this.selectSql = "SELECT " + attColName + " FROM " + tableName
				+ " WHERE " + keyColName + " =?";
		this.updateSql = "UPDATE " + tableName + " SET " + attColName + " = ? "
				+ " WHERE " + keyColName + " =?";
	}
}