com.fluidbpm.program.api.util.elasticsearch.ESFormUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fluid-api Show documentation
Used for the * Custom Program Step, * Custom Actions, * Scheduled Actions and * Fluid API in the Fluid BPM and Content Management system.
There is a newer version: 1.12
Show newest version
/*
 * Koekiebox CONFIDENTIAL
 *
 * [2012] - [2017] Koekiebox (Pty) Ltd
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains the property
 * of Koekiebox and its suppliers, if any. The intellectual and
 * technical concepts contained herein are proprietary to Koekiebox
 * and its suppliers and may be covered by South African and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material is strictly
 * forbidden unless prior written permission is obtained from Koekiebox.
 */

package com.fluidbpm.program.api.util.elasticsearch;

import java.sql.Connection;
import java.util.ArrayList;
import java.util.List;

import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.index.query.QueryBuilders;

import com.fluidbpm.program.api.util.ABaseUtil;
import com.fluidbpm.program.api.util.IFormAction;
import com.fluidbpm.program.api.util.cache.CacheUtil;
import com.fluidbpm.program.api.vo.ABaseFluidJSONObject;
import com.fluidbpm.program.api.vo.form.Form;

/**
 * ElasticSearch Utility class used for {@code Form} related actions.
 * A {@code Form} in Fluid is the equivalent to a Document in ElasticSearch.
 *
 * @author jasonbruwer on 2016/08/19.
 * @since 1.3
 * @see ABaseUtil
 * @see ABaseESUtil
 * @see IFormAction
 */
public class ESFormUtil extends ABaseESUtil implements IFormAction {

	/**
	 * Initialise with the ElasticSearch client.
	 *
	 * @param connectionParam SQL Connection to use.
	 * @param esClientParam The ES Client.
	 * @param cacheUtilParam The Cache Util for better performance.
	 */
	public ESFormUtil(
		Connection connectionParam,
		RestHighLevelClient esClientParam,
		CacheUtil cacheUtilParam
	) {
		super(connectionParam,
				esClientParam,
				cacheUtilParam);
	}

	/**
	 * Initialise with the ElasticSearch client.
	 *
	 * @param esClientParam The ES Client.
	 */
	public ESFormUtil(RestHighLevelClient esClientParam) {
		super(esClientParam);
	}

	/**
	 * Gets the ancestor for the {@code electronicFormIdParam} Form.
	 *
	 * @param electronicFormIdParam Identifier for the Form.
	 * @param includeFieldDataParam Whether to populate the return {@code Form} fields.
	 * @param includeTableFieldsParam Whether to populate the return {@code Form} table fields.
	 *
	 * @return {@code Form} descendants.
	 *
	 * @see Form
	 */
	public Form getFormAncestor(
			Long electronicFormIdParam,
			boolean includeFieldDataParam,
			boolean includeTableFieldsParam
	) {
		if (electronicFormIdParam == null) {
			return null;
		}

		//Query using the descendantId directly...
		StringBuffer ancestorQuery = new StringBuffer(
				Form.JSONMapping.DESCENDANT_IDS);
		ancestorQuery.append(":\"");
		ancestorQuery.append(electronicFormIdParam);
		ancestorQuery.append("\"");

		//Search for the Ancestor...
		List ancestorForms = null;
		if (includeFieldDataParam) {
			ancestorForms = this.searchAndConvertHitsToFormWithAllFields(
					QueryBuilders.queryStringQuery(ancestorQuery.toString()),
					DEFAULT_OFFSET,
					1);
		} else {
			ancestorForms = this.searchAndConvertHitsToFormWithNoFields(
					QueryBuilders.queryStringQuery(ancestorQuery.toString()),
					DEFAULT_OFFSET,
					1);
		}

		Form returnVal = null;
		if (ancestorForms != null && !ancestorForms.isEmpty()) {
			returnVal = ancestorForms.get(0);
		}

		//No result...
		if (returnVal == null) {
			return null;
		}

		//Whether table field data should be included...
		if (!includeTableFieldsParam) {
			return returnVal;
		}

		//Populate the Table Fields...
		this.populateTableFields(
				false,
				includeFieldDataParam,
				returnVal.getFormFields());

		return returnVal;
	}

	/**
	 * Gets the descendants for the {@code electronicFormIdParam} Form.
	 *
	 * @param electronicFormIdParam Identifier for the Form.
	 * @param includeFieldDataParam Whether to populate the return {@code List} fields.
	 * @param includeTableFieldsParam Whether to populate the return {@code List} table fields.
	 * @param includeTableFieldFormRecordInfoParam Does table record form data need to be included.
	 *
	 * @return {@code List} descendants.
	 *
	 * @see Form
	 */
	@Override
	public List getFormDescendants(
			Long electronicFormIdParam,
			boolean includeFieldDataParam,
			boolean includeTableFieldsParam,
			boolean includeTableFieldFormRecordInfoParam
	) {
		if (electronicFormIdParam == null) {
			return null;
		}

		List electronicFormIds = new ArrayList();
		electronicFormIds.add(electronicFormIdParam);

		//Get Form Descendants...
		return this.getFormDescendants(
				electronicFormIds,
				includeFieldDataParam,
				includeTableFieldsParam,
				includeTableFieldFormRecordInfoParam);
	}

	/**
	 * Gets the descendants for the {@code electronicFormIdsParam} Forms.
	 *
	 * @param electronicFormIdsParam Identifiers for the Forms to retrieve.
	 * @param includeFieldDataParam Whether to populate the return {@code List} fields.
	 * @param includeTableFieldsParam Whether to populate the return {@code List} table fields.
	 * @param includeTableFieldFormRecordInfoParam Does table record form data need to be included.
	 *
	 * @return {@code List} descendants.
	 *
	 * @see Form
	 */
	public List getFormDescendants(
			List electronicFormIdsParam,
			boolean includeFieldDataParam,
			boolean includeTableFieldsParam,
			boolean includeTableFieldFormRecordInfoParam)
	{
		if (electronicFormIdsParam == null ||
				electronicFormIdsParam.isEmpty())
		{
			return null;
		}

		//String stringQuery = "formType:(\"JIT Schedule\" \"SMT Training\") AND flowState:\"Not In Flow\"";

		//Query using the descendantId directly...
		StringBuffer descendantQuery = new StringBuffer(Form.JSONMapping.ANCESTOR_ID);
		descendantQuery.append(":(");

		for (Long electronicFormId : electronicFormIdsParam)
		{
			descendantQuery.append("\"");
			descendantQuery.append(electronicFormId);
			descendantQuery.append("\"");
			descendantQuery.append(" ");
		}

		String fullQueryToExec = descendantQuery.toString();
		fullQueryToExec = fullQueryToExec.substring(
				0, fullQueryToExec.length() - 1);
		fullQueryToExec = fullQueryToExec.concat(")");

		//Search for the Descendants...
		List returnVal = null;
		if (includeFieldDataParam) {
			returnVal = this.searchAndConvertHitsToFormWithAllFields(
					QueryBuilders.queryStringQuery(fullQueryToExec),
					DEFAULT_OFFSET, MAX_NUMBER_OF_TABLE_RECORDS);
		} else {
			returnVal = this.searchAndConvertHitsToFormWithNoFields(
					QueryBuilders.queryStringQuery(fullQueryToExec),
					DEFAULT_OFFSET, MAX_NUMBER_OF_TABLE_RECORDS);
		}

		//Whether table field data should be included...
		if (!includeTableFieldsParam) {
			return returnVal;
		}

		//No result...
		if (returnVal == null) {
			return returnVal;
		}

		//Populate in order to have table field data...
		for (Form descendantForm : returnVal) {
			this.populateTableFields(
					false,
					includeFieldDataParam,
					descendantForm.getFormFields());
		}

		return returnVal;
	}

	/**
	 * Retrieves the Table field records as {@code List}.
	 *
	 * @param electronicFormIdParam The Form Identifier.
	 * @param includeFieldDataParam Whether to populate the return {@code List} fields.
	 *
	 * @return {@code List} records.
	 */
	public List getFormTableForms(
			Long electronicFormIdParam,
			boolean includeFieldDataParam
	) {
		if (electronicFormIdParam == null) {
			return null;
		}

		//Query using the descendantId directly...
		StringBuffer primaryQuery = new StringBuffer(
				ABaseFluidJSONObject.JSONMapping.ID);
		primaryQuery.append(":\"");
		primaryQuery.append(electronicFormIdParam);
		primaryQuery.append("\"");

		//Search for the primary...
		List formsWithId = null;
		if (includeFieldDataParam) {
			formsWithId = this.searchAndConvertHitsToFormWithAllFields(
					QueryBuilders.queryStringQuery(primaryQuery.toString()),
					DEFAULT_OFFSET,
					1);
		} else {
			formsWithId = this.searchAndConvertHitsToFormWithNoFields(
					QueryBuilders.queryStringQuery(primaryQuery.toString()),
					DEFAULT_OFFSET,
					1);
		}

		Form returnVal = null;
		if (formsWithId != null && !formsWithId.isEmpty()) {
			returnVal = formsWithId.get(0);
		}

		//No result...
		if (returnVal == null) {
			return null;
		}

		//Populate the Table Fields...
		return this.populateTableFields(
				true,
				includeFieldDataParam,
				returnVal.getFormFields());
	}
}