|
| 1 | +package org.labkey.query.sql; |
| 2 | + |
| 3 | +import org.apache.commons.lang3.Strings; |
| 4 | +import org.jetbrains.annotations.NotNull; |
| 5 | +import org.jetbrains.annotations.Nullable; |
| 6 | +import org.labkey.api.data.BaseColumnInfo; |
| 7 | +import org.labkey.api.data.ContainerFilter; |
| 8 | +import org.labkey.api.data.JdbcType; |
| 9 | +import org.labkey.api.data.SQLFragment; |
| 10 | +import org.labkey.api.data.TableInfo; |
| 11 | +import org.labkey.api.data.dialect.SqlDialect; |
| 12 | +import org.labkey.api.exp.api.ExpLineageOptions; |
| 13 | +import org.labkey.api.exp.api.ExperimentService; |
| 14 | +import org.labkey.api.exp.query.ExpTable; |
| 15 | +import org.labkey.api.query.FieldKey; |
| 16 | +import org.labkey.api.query.QueryParseException; |
| 17 | +import org.labkey.api.query.column.BuiltInColumnTypes; |
| 18 | +import org.labkey.data.xml.ColumnType; |
| 19 | + |
| 20 | +import java.util.Collection; |
| 21 | +import java.util.List; |
| 22 | +import java.util.Map; |
| 23 | +import java.util.Objects; |
| 24 | +import java.util.Set; |
| 25 | + |
| 26 | +public class QueryLineage extends AbstractQueryRelation |
| 27 | +{ |
| 28 | + final QuerySelect sourceSelect; |
| 29 | + final boolean ancestors; |
| 30 | + |
| 31 | + QueryLineage(Query query, QNode token, QuerySelect source, String alias, boolean ancestors) |
| 32 | + { |
| 33 | + super(query, query.getSchema(), Objects.toString(alias, "explineage_" + query.incrementAliasCounter())); |
| 34 | + this.sourceSelect = source; |
| 35 | + this.ancestors = ancestors; |
| 36 | + |
| 37 | + sourceSelect.setSkipSuggestedColumns(true); |
| 38 | + var all = source.getAllColumns(); |
| 39 | + if (1 != all.size()) |
| 40 | + { |
| 41 | + query.getParseErrors().add(new QueryParseException(token.getTokenText() + " subquery must have one column", null, token.getLine(), token.getColumn())); |
| 42 | + } |
| 43 | + else |
| 44 | + { |
| 45 | + var relationColumn = all.values().iterator().next(); |
| 46 | + var col = new BaseColumnInfo("?"); |
| 47 | + relationColumn.copyColumnAttributesTo(col); |
| 48 | + if (!BuiltInColumnTypes.EXPOBJECTID_CONCEPT_URI.equals(col.getConceptURI())) |
| 49 | + query.getParseErrors().add(new QueryParseException(token.getTokenText() + " requires an object column", null, token.getLine(), token.getColumn())); |
| 50 | + } |
| 51 | + } |
| 52 | + |
| 53 | + @Override |
| 54 | + public void declareFields() |
| 55 | + { |
| 56 | + sourceSelect.declareFields(); |
| 57 | + } |
| 58 | + |
| 59 | + @Override |
| 60 | + public void resolveFields() |
| 61 | + { |
| 62 | + sourceSelect.resolveFields(); |
| 63 | + } |
| 64 | + |
| 65 | + @Override |
| 66 | + public TableInfo getTableInfo() |
| 67 | + { |
| 68 | + throw new UnsupportedOperationException(); |
| 69 | + } |
| 70 | + |
| 71 | + @Override |
| 72 | + public Map<String, RelationColumn> getAllColumns() |
| 73 | + { |
| 74 | + return Map.of( |
| 75 | + "Depth", Objects.requireNonNull(getColumn("depth")), |
| 76 | + "FromObject", Objects.requireNonNull(getColumn("fromobject")), |
| 77 | + "ToObject", Objects.requireNonNull(getColumn("toobject"))); |
| 78 | + } |
| 79 | + |
| 80 | + @Override |
| 81 | + public @Nullable AbstractQueryRelation.RelationColumn getFirstColumn() |
| 82 | + { |
| 83 | + return getColumn("fromobject"); |
| 84 | + } |
| 85 | + |
| 86 | + @Override |
| 87 | + public @Nullable AbstractQueryRelation.RelationColumn getColumn(@NotNull String name) |
| 88 | + { |
| 89 | + return switch (name.toLowerCase()) |
| 90 | + { |
| 91 | + case "depth", "fromobject", "toobject" -> new LineageColumn(name.toLowerCase()); |
| 92 | + default -> null; |
| 93 | + }; |
| 94 | + } |
| 95 | + |
| 96 | + @Override |
| 97 | + public int getSelectedColumnCount() |
| 98 | + { |
| 99 | + return 3; |
| 100 | + } |
| 101 | + |
| 102 | + @Override |
| 103 | + public @Nullable AbstractQueryRelation.RelationColumn getLookupColumn(@NotNull RelationColumn parent, @NotNull String name) |
| 104 | + { |
| 105 | + throw new UnsupportedOperationException(); |
| 106 | + } |
| 107 | + |
| 108 | + @Override |
| 109 | + public @Nullable AbstractQueryRelation.RelationColumn getLookupColumn(@NotNull RelationColumn parent, ColumnType.@NotNull Fk fk, @NotNull String name) |
| 110 | + { |
| 111 | + throw new UnsupportedOperationException(); |
| 112 | + } |
| 113 | + |
| 114 | + @Override |
| 115 | + public SQLFragment getSql() |
| 116 | + { |
| 117 | + throw new UnsupportedOperationException(); |
| 118 | + } |
| 119 | + |
| 120 | + @Override |
| 121 | + public SQLFragment getFromSql() |
| 122 | + { |
| 123 | + SqlDialect d = _query.getSchema().getDbSchema().getSqlDialect(); |
| 124 | + |
| 125 | + ExpLineageOptions options = new ExpLineageOptions(ancestors, !ancestors, 1000); |
| 126 | + options.setForLookup(true); // remove intermediate edges |
| 127 | + options.setUseObjectIds(true); // expObject() returns objectid not lsid |
| 128 | + |
| 129 | + SQLFragment sql = new SQLFragment(); |
| 130 | + sql.appendComment("<QueryLineage>", d); |
| 131 | + // CONSIDER: use CTE for sourceSelect.getSql() |
| 132 | + SQLFragment lineageSql = ExperimentService.get().generateExperimentTreeSQL(sourceSelect.getSql(), options); |
| 133 | + sql.append("(\n").append(lineageSql).append("\n) AS ").appendIdentifier(getAlias()); |
| 134 | + sql.appendComment("</QueryLineage>", d); |
| 135 | + return sql; |
| 136 | + } |
| 137 | + |
| 138 | + @Override |
| 139 | + public String getQueryText() |
| 140 | + { |
| 141 | + return (ancestors?"EXPANCESTORSOF":"EXPDESCENDANTSOF") + "(" + sourceSelect.getQueryText() + ")"; |
| 142 | + } |
| 143 | + |
| 144 | + @Override |
| 145 | + public void setContainerFilter(ContainerFilter containerFilter) |
| 146 | + { |
| 147 | + sourceSelect.setContainerFilter(containerFilter); |
| 148 | + } |
| 149 | + |
| 150 | + @Override |
| 151 | + public Set<RelationColumn> getSuggestedColumns(Set<RelationColumn> selected) |
| 152 | + { |
| 153 | + return Set.of(); |
| 154 | + } |
| 155 | + |
| 156 | + |
| 157 | + private class LineageColumn extends RelationColumn |
| 158 | + { |
| 159 | + final FieldKey _fieldKey; |
| 160 | + final String _alias; |
| 161 | + final JdbcType _jdbcType; |
| 162 | + |
| 163 | + LineageColumn(String name) |
| 164 | + { |
| 165 | + String alias; |
| 166 | + FieldKey fk; |
| 167 | + JdbcType jdbcType = JdbcType.BIGINT; |
| 168 | + switch (name.toLowerCase()) |
| 169 | + { |
| 170 | + case "depth": |
| 171 | + alias = "depth"; |
| 172 | + fk = new FieldKey(null, "Depth"); |
| 173 | + jdbcType = JdbcType.INTEGER; |
| 174 | + break; |
| 175 | + case "fromobject": |
| 176 | + alias = "self"; |
| 177 | + fk = new FieldKey(null, "FromObject"); |
| 178 | + break; |
| 179 | + case "toobject": |
| 180 | + alias = "objectid"; |
| 181 | + fk = new FieldKey(null, "ToObject"); |
| 182 | + break; |
| 183 | + default: |
| 184 | + throw new IllegalArgumentException("Unknown column name: " + name); |
| 185 | + } |
| 186 | + _fieldKey = fk; |
| 187 | + _alias = alias; |
| 188 | + _jdbcType = jdbcType; |
| 189 | + } |
| 190 | + |
| 191 | + @Override |
| 192 | + SQLFragment getInternalSql() |
| 193 | + { |
| 194 | + return new SQLFragment().appendDottedIdentifiers(QueryLineage.this.getAlias(), getAlias()); |
| 195 | + } |
| 196 | + |
| 197 | + @Override |
| 198 | + void copyColumnAttributesTo(@NotNull BaseColumnInfo to) |
| 199 | + { |
| 200 | + to.setJdbcType(_jdbcType); |
| 201 | + if (!"depth".equals(_alias)) |
| 202 | + { |
| 203 | + to.setConceptURI(BuiltInColumnTypes.EXPOBJECTID_CONCEPT_URI); |
| 204 | + to.setDisplayColumnFactory(ExpTable.ExpObjectDataColumn::new); |
| 205 | + } |
| 206 | + } |
| 207 | + |
| 208 | + @Override |
| 209 | + public FieldKey getFieldKey() |
| 210 | + { |
| 211 | + return _fieldKey; |
| 212 | + } |
| 213 | + |
| 214 | + @Override |
| 215 | + String getAlias() |
| 216 | + { |
| 217 | + return _alias; |
| 218 | + } |
| 219 | + |
| 220 | + @Override |
| 221 | + AbstractQueryRelation getTable() |
| 222 | + { |
| 223 | + return QueryLineage.this; |
| 224 | + } |
| 225 | + |
| 226 | + @Override |
| 227 | + boolean isHidden() |
| 228 | + { |
| 229 | + return false; |
| 230 | + } |
| 231 | + |
| 232 | + @Override |
| 233 | + String getPrincipalConceptCode() |
| 234 | + { |
| 235 | + return ""; |
| 236 | + } |
| 237 | + |
| 238 | + @Override |
| 239 | + String getConceptURI() |
| 240 | + { |
| 241 | + return ""; |
| 242 | + } |
| 243 | + |
| 244 | + @Override |
| 245 | + public @NotNull JdbcType getJdbcType() |
| 246 | + { |
| 247 | + return _jdbcType; |
| 248 | + } |
| 249 | + |
| 250 | + @Override |
| 251 | + public Collection<RelationColumn> gatherInvolvedSelectColumns(Collection<RelationColumn> collect) |
| 252 | + { |
| 253 | + return List.of(); |
| 254 | + } |
| 255 | + } |
| 256 | +} |
0 commit comments