Skip to content

Multi value text choices #7323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
XingY wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Multi value text choices #7323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
685f9ed
Multi choices
XingY Jan 8, 2026
322bd91
Multi value text choices
XingY Jan 12, 2026
672a750
fix empty array
XingY Jan 12, 2026
11f042c
crlf
XingY Jan 12, 2026
65538dc
support filters
XingY Jan 13, 2026
5a017c6
Merge remote-tracking branch 'origin/develop' into fb_mvtc
XingY Jan 13, 2026
9801a9c
clean
XingY Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions api/gwtsrc/org/labkey/api/gwt/client/model/GWTDomain.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ public class GWTDomain<FieldType extends GWTPropertyDescriptor> implements IsSer
@Getter @Setter private boolean allowAttachmentProperties;
@Getter @Setter private boolean allowFlagProperties;
@Getter @Setter private boolean allowTextChoiceProperties;
@Getter @Setter private boolean allowMultiChoiceProperties;
@Getter @Setter private boolean allowSampleSubjectProperties;
@Getter @Setter private boolean allowTimepointProperties;
@Getter @Setter private boolean allowUniqueConstraintProperties;
Expand Down Expand Up @@ -90,6 +91,7 @@ public GWTDomain(GWTDomain<FieldType> src)
this.allowAttachmentProperties = src.allowAttachmentProperties;
this.allowFlagProperties = src.allowFlagProperties;
this.allowTextChoiceProperties = src.allowTextChoiceProperties;
this.allowMultiChoiceProperties = src.allowMultiChoiceProperties;
this.allowSampleSubjectProperties = src.allowSampleSubjectProperties;
this.allowTimepointProperties = src.allowTimepointProperties;
this.allowUniqueConstraintProperties = src.allowUniqueConstraintProperties;
Expand Down
7 changes: 7 additions & 0 deletions api/schemas/queryCustomView.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@

<xsd:simpleType name="operatorType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="arraycontainsall"/>
<xsd:enumeration value="arraycontainsany"/>
<xsd:enumeration value="arraymatches"/>
<xsd:enumeration value="arraynotmatches"/>
<xsd:enumeration value="arraycontainsnone"/>
<xsd:enumeration value="arrayisempty"/>
<xsd:enumeration value="arrayisnotempty"/>
<xsd:enumeration value="eq"/>
<xsd:enumeration value="dateeq"/>
<xsd:enumeration value="dateneq"/>
Expand Down
344 changes: 344 additions & 0 deletions api/src/org/labkey/api/data/CompareType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -808,6 +808,350 @@ public QClause createFilterClause(@NotNull FieldKey fieldKey, Object value)
}
};

protected Collection getCollectionParam(Object value)
{
if (value instanceof Collection)
{
return (Collection)value;
}
else
{
List<String> values = new ArrayList<>();
if (value != null)
{
if (value.toString().trim().isEmpty())
{
values.add(null);
}
else
{
values.addAll(parseParams(value, getValueSeparator(), isNewLineSeparatorAllowed()));
}
}
return values;
}
}

/** TODO:
* <xsd:enumeration value="arrayisempty"/>
* <xsd:enumeration value="arrayisnotempty"/>
*/
Comment on lines +835 to +838
Copy link

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a TODO comment indicating that arrayisempty and arrayisnotempty operators are not yet implemented, but they are already added to the XSD schema (lines 101-102 in queryCustomView.xsd). This creates an inconsistency where the schema allows these operators but the backend doesn't support them. Either implement these operators or remove them from the XSD until they are ready.

Copilot uses AI. Check for mistakes.
public static final CompareType ARRAY_CONTAINS_ALL = new CompareType("Contains All", "arraycontainsall", "ARRAYCONTAINSALL", true, null, OperatorType.ARRAYCONTAINSALL)
{
@Override
public ArrayContainsAllClause createFilterClause(@NotNull FieldKey fieldKey, Object value)
{
return new ArrayContainsAllClause(fieldKey, getCollectionParam(value));
}

@Override
public boolean meetsCriteria(ColumnRenderProperties col, Object value, Object[] filterValues)
{
throw new UnsupportedOperationException("Conditional formatting not yet supported for Multi Choices");
}

@Override
public String getValueSeparator()
{
return ArrayClause.ARRAY_VALUE_SEPARATOR;
}
};

public static final CompareType ARRAY_CONTAINS_ANY = new CompareType("Contains Any", "arraycontainsany", "ARRAYCONTAINSANY", true, null, OperatorType.ARRAYCONTAINSANY)
{
@Override
public ArrayContainsAnyClause createFilterClause(@NotNull FieldKey fieldKey, Object value)
{
return new ArrayContainsAnyClause(fieldKey, getCollectionParam(value));
}

@Override
public boolean meetsCriteria(ColumnRenderProperties col, Object value, Object[] filterValues)
{
throw new UnsupportedOperationException("Conditional formatting not yet supported for Multi Choices");
}

@Override
public String getValueSeparator()
{
return ArrayClause.ARRAY_VALUE_SEPARATOR;
}
};

public static final CompareType ARRAY_CONTAINS_NONE = new CompareType("Contains None", "arraycontainsnone", "ARRAYCONTAINSNONE", true, null, OperatorType.ARRAYCONTAINSNONE)
{
@Override
public ArrayContainsNoneClause createFilterClause(@NotNull FieldKey fieldKey, Object value)
{
return new ArrayContainsNoneClause(fieldKey, getCollectionParam(value));
}

@Override
public boolean meetsCriteria(ColumnRenderProperties col, Object value, Object[] filterValues)
{
throw new UnsupportedOperationException("Conditional formatting not yet supported for Multi Choices");
}

@Override
public String getValueSeparator()
{
return ArrayClause.ARRAY_VALUE_SEPARATOR;
}
};

public static final CompareType ARRAY_MATCHES = new CompareType("Contains Exactly", "arraymatches", "ARRAYMATCHES", true, null, OperatorType.ARRAYMATCHES)
{
@Override
public ArrayMatchesClause createFilterClause(@NotNull FieldKey fieldKey, Object value)
{
return new ArrayMatchesClause(fieldKey, getCollectionParam(value));
}

@Override
public boolean meetsCriteria(ColumnRenderProperties col, Object value, Object[] filterValues)
{
throw new UnsupportedOperationException("Conditional formatting not yet supported for Multi Choices");
}

@Override
public String getValueSeparator()
{
return ArrayClause.ARRAY_VALUE_SEPARATOR;
}
};

public static final CompareType ARRAY_NOT_MATCHES = new CompareType("Does Not Contain Exactly", "arraynotmatches", "ARRAYNOTMATCHES", true, null, OperatorType.ARRAYNOTMATCHES)
{
@Override
public ArrayNotMatchesClause createFilterClause(@NotNull FieldKey fieldKey, Object value)
{
return new ArrayNotMatchesClause(fieldKey, getCollectionParam(value));
}

@Override
public boolean meetsCriteria(ColumnRenderProperties col, Object value, Object[] filterValues)
{
throw new UnsupportedOperationException("Conditional formatting not yet supported for Multi Choices");
}

@Override
public String getValueSeparator()
{
return ArrayClause.ARRAY_VALUE_SEPARATOR;
}
};

public static abstract class ArrayClause extends SimpleFilter.MultiValuedFilterClause
{
public static final String ARRAY_VALUE_SEPARATOR = ",";

public ArrayClause(@NotNull FieldKey fieldKey, CompareType comparison, Collection<?> params, boolean negated)
{
super(fieldKey, comparison, params, negated);
}

public SQLFragment[] getParamSQLFragments(SqlDialect dialect)
{
Object[] params = getParamVals();
SQLFragment[] fragments = new SQLFragment[params.length];

JdbcType type = null;
// Try to infer the type from the first non-null parameter
for (Object param : params)
{
if (param != null)
{
type = JdbcType.valueOf(param.getClass());
break;
}
}

for (int i = 0; i < params.length; i++)
fragments[i] = new SQLFragment().append(escapeLabKeySqlValue(params[i], type));

return fragments;
}

public Pair<SQLFragment, SQLFragment> getSqlFragments(Map<FieldKey, ? extends ColumnInfo> columnMap, SqlDialect dialect)
{
SQLFragment[] paramValues = getParamSQLFragments(dialect);

if (paramValues == null || paramValues.length == 0)
return null;

ColumnInfo colInfo = columnMap != null ? columnMap.get(_fieldKey) : null;
var alias = SimpleFilter.getAliasForColumnFilter(dialect, colInfo, _fieldKey);

SQLFragment valuesFragment = dialect.array_construct(paramValues);
SQLFragment columnFragment = new SQLFragment().appendIdentifier(alias);

return new Pair<>(valuesFragment, columnFragment);
}

}

private static class ArrayContainsAllClause extends ArrayClause
{

public ArrayContainsAllClause(@NotNull FieldKey fieldKey, Collection<?> params)
{
super(fieldKey, CompareType.ARRAY_CONTAINS_ALL, params, false);
}

@Override
public SQLFragment toSQLFragment(Map<FieldKey, ? extends ColumnInfo> columnMap, SqlDialect dialect)
{
Pair<SQLFragment, SQLFragment> valueFieldSql = getSqlFragments(columnMap, dialect);
if (valueFieldSql == null)
return new SQLFragment("1=2");

return dialect.array_all_in_array(valueFieldSql.first, valueFieldSql.second);
}

@Override
public String getLabKeySQLWhereClause(Map<FieldKey, ? extends ColumnInfo> columnMap)
{
return "array_contains_all(" + getLabKeySQLColName(_fieldKey) + ", " + getParamVals()[0] + ")";
}

@Override
public void appendFilterText(StringBuilder sb, ColumnNameFormatter formatter)
{
Object[] params = getParamVals();
sb.append("contains all of ").append(Arrays.toString(params));
}

}

private static class ArrayContainsAnyClause extends ArrayClause
{

public ArrayContainsAnyClause(@NotNull FieldKey fieldKey, CompareType comparison, Collection<?> params, boolean negated)
{
super(fieldKey, comparison, params, negated);
}

public ArrayContainsAnyClause(@NotNull FieldKey fieldKey, Collection<?> params)
{
this(fieldKey, CompareType.ARRAY_CONTAINS_ANY, params, false);
}

@Override
public SQLFragment toSQLFragment(Map<FieldKey, ? extends ColumnInfo> columnMap, SqlDialect dialect)
{
Pair<SQLFragment, SQLFragment> valueFieldSql = getSqlFragments(columnMap, dialect);
if (valueFieldSql == null)
return new SQLFragment("1=2");

SQLFragment sql = dialect.array_some_in_array(valueFieldSql.first, valueFieldSql.second);
if (!_negated)
return sql;
return new SQLFragment(" NOT (").append(sql).append(")");
}

@Override
public String getLabKeySQLWhereClause(Map<FieldKey, ? extends ColumnInfo> columnMap)
{
return "array_contains_any(" + getLabKeySQLColName(_fieldKey) + ", " + getParamVals()[0] + ")";
}

@Override
public void appendFilterText(StringBuilder sb, ColumnNameFormatter formatter)
{
Object[] params = getParamVals();
sb.append("contains at least one of ").append(Arrays.toString(params));
}

}

private static class ArrayContainsNoneClause extends ArrayContainsAnyClause
{

public ArrayContainsNoneClause(@NotNull FieldKey fieldKey, Collection<?> params)
{
super(fieldKey, CompareType.ARRAY_CONTAINS_NONE, params, true);
}

@Override
public String getLabKeySQLWhereClause(Map<FieldKey, ? extends ColumnInfo> columnMap)
{
return "array_contains_none(" + getLabKeySQLColName(_fieldKey) + ", " + getParamVals()[0] + ")";
}

@Override
public void appendFilterText(StringBuilder sb, ColumnNameFormatter formatter)
{
Object[] params = getParamVals();
sb.append("contains none of ").append(Arrays.toString(params));
}

}

private static class ArrayMatchesClause extends ArrayClause
{

public ArrayMatchesClause(@NotNull FieldKey fieldKey, CompareType comparison, Collection<?> params, boolean negated)
{
super(fieldKey, comparison, params, negated);
}

public ArrayMatchesClause(@NotNull FieldKey fieldKey, Collection<?> params)
{
this(fieldKey, CompareType.ARRAY_MATCHES, params, false);
}

@Override
public SQLFragment toSQLFragment(Map<FieldKey, ? extends ColumnInfo> columnMap, SqlDialect dialect)
{
Pair<SQLFragment, SQLFragment> valueFieldSql = getSqlFragments(columnMap, dialect);
if (valueFieldSql == null)
return new SQLFragment("1=2");

SQLFragment sql = dialect.array_same_array(valueFieldSql.first, valueFieldSql.second);
if (!_negated)
return sql;
return new SQLFragment(" NOT (").append(sql).append(")");
}

@Override
public String getLabKeySQLWhereClause(Map<FieldKey, ? extends ColumnInfo> columnMap)
{
return "array_is_same(" + getLabKeySQLColName(_fieldKey) + ", " + getParamVals()[0] + ")";
}

@Override
public void appendFilterText(StringBuilder sb, ColumnNameFormatter formatter)
{
Object[] params = getParamVals();
sb.append("contains the same elements as ").append(Arrays.toString(params));
}

}

private static class ArrayNotMatchesClause extends ArrayMatchesClause
{

public ArrayNotMatchesClause(@NotNull FieldKey fieldKey, Collection<?> params)
{
super(fieldKey, CompareType.ARRAY_NOT_MATCHES, params, true);
}

@Override
public String getLabKeySQLWhereClause(Map<FieldKey, ? extends ColumnInfo> columnMap)
{
return "NOT array_is_same(" + getLabKeySQLColName(_fieldKey) + ", " + getParamVals()[0] + ")";
}

@Override
public void appendFilterText(StringBuilder sb, ColumnNameFormatter formatter)
{
Object[] params = getParamVals();
sb.append("does not contain the same elements as ").append(Arrays.toString(params));
}

}


private static class QClause extends CompareType.CompareClause
{
private List<ColumnInfo> _queryColumns = null;
Expand Down
2 changes: 1 addition & 1 deletion api/src/org/labkey/api/data/ConnectionWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1025,7 +1025,7 @@ public Array createArrayOf(String unused, Object[] array) throws SQLException
try
{
SqlDialect dialect = _scope.getSqlDialect();
String typeName = dialect.getJDBCArrayType(array[0]);
String typeName = dialect.getJDBCArrayType(array);
return _connection.createArrayOf(typeName, array);
}
catch (SQLException e)
Expand Down
Loading