|
| 1 | +package org.labkey.snprc_ehr.helpers; |
| 2 | + |
| 3 | +import org.apache.commons.lang.StringUtils; |
| 4 | +import org.apache.commons.lang.text.StrSubstitutor; |
| 5 | +import org.apache.commons.text.CaseUtils; |
| 6 | +import org.labkey.api.data.AbstractTableInfo; |
| 7 | +import org.labkey.api.data.ColumnInfo; |
| 8 | +import org.labkey.api.data.TableInfo; |
| 9 | +import org.labkey.api.data.WrappedColumn; |
| 10 | +import org.labkey.api.query.UserSchema; |
| 11 | +import org.labkey.snprc_ehr.model.CalculatedColumn; |
| 12 | +import org.labkey.snprc_ehr.model.CalculatedColumnQueryInfo; |
| 13 | +import org.labkey.snprc_ehr.query.CalculatedColumnForeignKey; |
| 14 | + |
| 15 | +import java.util.HashMap; |
| 16 | +import java.util.List; |
| 17 | +import java.util.Map; |
| 18 | +import java.util.Set; |
| 19 | + |
| 20 | +import static org.labkey.snprc_ehr.constants.QueryConstants.DATE_COLUMN_VARIABLE; |
| 21 | +import static org.labkey.snprc_ehr.constants.QueryConstants.EHR_PATH_VARIABLE; |
| 22 | +import static org.labkey.snprc_ehr.constants.QueryConstants.ID_COLUMN; |
| 23 | +import static org.labkey.snprc_ehr.constants.QueryConstants.ID_COLUMN_VARIABLE; |
| 24 | +import static org.labkey.snprc_ehr.constants.QueryConstants.PRIMARY_KEY_VARIABLE; |
| 25 | +import static org.labkey.snprc_ehr.constants.QueryConstants.QUERY_VARIABLE; |
| 26 | +import static org.labkey.snprc_ehr.constants.QueryConstants.SCHEMA_VARIABLE; |
| 27 | +import static org.labkey.snprc_ehr.constants.QueryConstants.TARGET_CONTAINER_VARIABLE; |
| 28 | + |
| 29 | +/** |
| 30 | + * Class that provides methods to build a table from a SQL query that contains columns to be calculated |
| 31 | + */ |
| 32 | +public class CustomizerQueryProvider |
| 33 | +{ |
| 34 | + /** |
| 35 | + * Constructor |
| 36 | + */ |
| 37 | + public CustomizerQueryProvider() { |
| 38 | + |
| 39 | + } |
| 40 | + |
| 41 | + /** |
| 42 | + * Checks if the passed table exists, the primary key and id columns, |
| 43 | + * and builds table with calculated fields from SQL query. Returns false if any checks fail and |
| 44 | + * true if all checks pass and the table is successfully built |
| 45 | + * @param tableInfo |
| 46 | + * @param columnName |
| 47 | + * @param dateColumnName |
| 48 | + * @param queryString |
| 49 | + * @param ehrSchema |
| 50 | + * @param calculatedColumns |
| 51 | + * @param isRemovingDefaultCustomizerColumns |
| 52 | + * @return |
| 53 | + */ |
| 54 | + public AbstractTableInfo getCalculatedColumnsTable(AbstractTableInfo tableInfo, String columnName, String dateColumnName, |
| 55 | + String queryString, UserSchema ehrSchema, |
| 56 | + Set<CalculatedColumn> calculatedColumns, boolean isRemovingDefaultCustomizerColumns) { |
| 57 | + /* Check if the column already exists in the table */ |
| 58 | + if (tableInfo.getColumn(CaseUtils.toCamelCase(columnName, false), false) != null) |
| 59 | + { |
| 60 | + /* Check if the table should be removed so that it can be rebuilt. Applies to tables that require |
| 61 | + * queries that are different from the DefaultEHRCustomizer's query */ |
| 62 | + if (isRemovingDefaultCustomizerColumns) |
| 63 | + tableInfo.removeColumn(tableInfo.getColumn(CaseUtils.toCamelCase(columnName, false))); |
| 64 | + else |
| 65 | + return null; |
| 66 | + } |
| 67 | + |
| 68 | + final ColumnInfo primaryKeyColumn = getPrimaryKeyColumn(tableInfo); |
| 69 | + if (primaryKeyColumn == null) |
| 70 | + return null; |
| 71 | + final ColumnInfo idColumn = tableInfo.getColumn(ID_COLUMN); |
| 72 | + if(idColumn == null) |
| 73 | + return null; |
| 74 | + |
| 75 | + /* Build a query info object to be used by the foreign key class */ |
| 76 | + CalculatedColumnQueryInfo queryInfo = getQueryInfo(tableInfo, primaryKeyColumn, idColumn, ehrSchema, columnName, |
| 77 | + calculatedColumns); |
| 78 | + |
| 79 | + /* Build a wrapped column object for the table */ |
| 80 | + WrappedColumn calculatedColumn = getWrappedCalculatedColumn(queryInfo, mapQueryStringValues(queryString, queryInfo, |
| 81 | + dateColumnName)); |
| 82 | + tableInfo.addColumn(calculatedColumn); |
| 83 | + return tableInfo; |
| 84 | + } |
| 85 | + |
| 86 | + /** |
| 87 | + * Obtain the column info for the primary key of a given table |
| 88 | + * @param tableInfo |
| 89 | + * @return |
| 90 | + */ |
| 91 | + private ColumnInfo getPrimaryKeyColumn(TableInfo tableInfo) { |
| 92 | + List<ColumnInfo> primaryKeys = tableInfo.getPkColumns(); |
| 93 | + return (primaryKeys.size() != 1) ? null : primaryKeys.get(0); |
| 94 | + } |
| 95 | + |
| 96 | + /** |
| 97 | + * Returns a new query info object to be used for calculating a column's info |
| 98 | + * @param tableInfo |
| 99 | + * @param primaryKeyColumn |
| 100 | + * @param idColumn |
| 101 | + * @param ehrSchema |
| 102 | + * @param label |
| 103 | + * @param calculatedColumns |
| 104 | + * @return |
| 105 | + */ |
| 106 | + private CalculatedColumnQueryInfo getQueryInfo(AbstractTableInfo tableInfo, ColumnInfo primaryKeyColumn, |
| 107 | + ColumnInfo idColumn, UserSchema ehrSchema, |
| 108 | + String label, Set<CalculatedColumn> calculatedColumns) |
| 109 | + { |
| 110 | + CalculatedColumnQueryInfo queryInfo = new CalculatedColumnQueryInfo(); |
| 111 | + queryInfo.setTableInfo(tableInfo); |
| 112 | + queryInfo.setCalculatedColumns(calculatedColumns); |
| 113 | + queryInfo.setPrimaryKeyColumn(primaryKeyColumn); |
| 114 | + queryInfo.setIdColumn(idColumn); |
| 115 | + queryInfo.setEhrSchema(ehrSchema); |
| 116 | + queryInfo.setLabel(label); |
| 117 | + |
| 118 | + return queryInfo; |
| 119 | + } |
| 120 | + |
| 121 | + /** |
| 122 | + * Returns a wrapped column object from a given query and it's information |
| 123 | + * @param queryInfo |
| 124 | + * @param queryString |
| 125 | + * @return |
| 126 | + */ |
| 127 | + private WrappedColumn getWrappedCalculatedColumn(CalculatedColumnQueryInfo queryInfo, String queryString) { |
| 128 | + WrappedColumn column = new WrappedColumn(queryInfo.getPrimaryKeyColumn(), CaseUtils.toCamelCase(queryInfo.getLabel(), |
| 129 | + false)); |
| 130 | + column.setLabel(queryInfo.getLabel()); |
| 131 | + column.setReadOnly(true); |
| 132 | + column.setIsUnselectable(true); |
| 133 | + column.setUserEditable(false); |
| 134 | + /* Invokes the CalculatedColumnForeignKey class */ |
| 135 | + column.setFk(new CalculatedColumnForeignKey(queryInfo, queryString)); |
| 136 | + return column; |
| 137 | + } |
| 138 | + |
| 139 | + /** |
| 140 | + * Maps values from the query object's data to the variable names within the SQL query string |
| 141 | + * (formatted for the Apache Commons Lang StrSubstitor where ${variableName} maps to variableName) |
| 142 | + * @param queryString |
| 143 | + * @param queryInfo |
| 144 | + * @param dateColumnName |
| 145 | + * @return |
| 146 | + */ |
| 147 | + private String mapQueryStringValues(String queryString, CalculatedColumnQueryInfo queryInfo, String dateColumnName) { |
| 148 | + Map<String, String> queryByValues = new HashMap<>(); |
| 149 | + if(StringUtils.contains(queryString, PRIMARY_KEY_VARIABLE)) |
| 150 | + queryByValues.put(PRIMARY_KEY_VARIABLE, queryInfo.getPrimaryKeyColumn().getFieldKey().toSQLString()); |
| 151 | + if(StringUtils.contains(queryString, SCHEMA_VARIABLE)) |
| 152 | + queryByValues.put(SCHEMA_VARIABLE, queryInfo.getTableInfo().getPublicSchemaName()); |
| 153 | + if(StringUtils.contains(queryString, QUERY_VARIABLE)) |
| 154 | + queryByValues.put(QUERY_VARIABLE, queryInfo.getTableInfo().getName()); |
| 155 | + if(StringUtils.contains(queryString, EHR_PATH_VARIABLE)) |
| 156 | + queryByValues.put(EHR_PATH_VARIABLE, queryInfo.getEhrSchema().getContainer().getPath()); |
| 157 | + if(StringUtils.contains(queryString, ID_COLUMN_VARIABLE)) |
| 158 | + queryByValues.put(ID_COLUMN_VARIABLE, queryInfo.getIdColumn().getFieldKey().toSQLString()); |
| 159 | + if(StringUtils.contains(queryString, TARGET_CONTAINER_VARIABLE)) |
| 160 | + queryByValues.put(TARGET_CONTAINER_VARIABLE, queryInfo.getTableInfo().getUserSchema().getName()); |
| 161 | + if(StringUtils.contains(queryString, DATE_COLUMN_VARIABLE)) |
| 162 | + queryByValues.put(DATE_COLUMN_VARIABLE, dateColumnName); |
| 163 | + return StrSubstitutor.replace(queryString, queryByValues); |
| 164 | + |
| 165 | + } |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | +} |
0 commit comments