QRunIO/qqq
2
0
Fork 0
mirror of https://github.com/Kingsrook/qqq.git synced 2025-07-19 13:40:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial checkin

Browse Source
This commit is contained in:
darin.kelkhoff
2025-05-30 20:32:28 -05:00
parent 8b6aad5412
commit 3888aab490
2 changed files with 225 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/utils/QQueryFilterFormatter.java Normal file
View File

@ -0,0 +1,168 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qqq.backend.core.utils;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qqq.backend.core.actions.values.SearchPossibleValueSourceAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.logging.QLogger;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceInput;
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceOutput;
import com.kingsrook.qqq.backend.core.model.metadata.fields.FieldAndJoinTable;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import static com.kingsrook.qqq.backend.core.logging.LogUtils.logPair;
/*******************************************************************************
**
*******************************************************************************/
public class QQueryFilterFormatter
{
private static final QLogger LOG = QLogger.getLogger(QQueryFilterFormatter.class);
/***************************************************************************
**
***************************************************************************/
public static String formatQueryFilter(String tableName, QQueryFilter filter)
{
List<String> parts = new ArrayList<>();
QTableMetaData table = QContext.getQInstance().getTable(tableName);
for(QFilterCriteria criteria : CollectionUtils.nonNullList(filter.getCriteria()))
{
parts.add(formatCriteria(table, criteria));
}
if(parts.isEmpty())
{
return ("Empty filter");
}
return String.join(" " + filter.getBooleanOperator() + " ", parts);
}
/***************************************************************************
**
***************************************************************************/
private static String formatCriteria(QTableMetaData table, QFilterCriteria criteria)
{
String fieldLabel = criteria.getFieldName();
QFieldMetaData field = null;
QFieldType fieldType = null;
try
{
FieldAndJoinTable fieldAndJoinTable = FieldAndJoinTable.get(table, criteria.getFieldName());
fieldLabel = fieldAndJoinTable.getLabel(table);
field = fieldAndJoinTable.field();
fieldType = field.getType();
}
catch(Exception e)
{
LOG.debug("Error getting field label for formatting criteria", e, logPair("fieldName", criteria.getFieldName()));
}
boolean isTemporal = fieldType != null && fieldType.isTemporal();
StringBuilder rs = new StringBuilder(fieldLabel);
switch(criteria.getOperator())
{
case EQUALS -> rs.append(" equals ");
case NOT_EQUALS, NOT_EQUALS_OR_IS_NULL -> rs.append(" does not equal ");
case IN -> rs.append(" is any of ");
case NOT_IN -> rs.append(" is none of ");
case IS_NULL_OR_IN -> rs.append(" is blank or any of ");
case LIKE -> rs.append(" is like ");
case NOT_LIKE -> rs.append(" is not like ");
case STARTS_WITH -> rs.append(" starts with ");
case ENDS_WITH -> rs.append(" ends with ");
case CONTAINS -> rs.append(" contains ");
case NOT_STARTS_WITH -> rs.append(" does not start with ");
case NOT_ENDS_WITH -> rs.append(" does not end with ");
case NOT_CONTAINS -> rs.append(" does not contain ");
case LESS_THAN -> rs.append(isTemporal ? " is before " : " is less than ");
case LESS_THAN_OR_EQUALS -> rs.append(isTemporal ? " is before or at " : " is less than or equal to ");
case GREATER_THAN -> rs.append(isTemporal ? " is after " : " is greater than ");
case GREATER_THAN_OR_EQUALS -> rs.append(isTemporal ? " is after or at " : " is greater than or equal to ");
case IS_BLANK -> rs.append(" is empty ");
case IS_NOT_BLANK -> rs.append(" is not empty ");
case BETWEEN -> rs.append(" is between ");
case NOT_BETWEEN -> rs.append(" is not ");
case TRUE -> rs.append(" is True ");
case FALSE -> rs.append(" is False ");
}
List<Serializable> values = criteria.getValues();
if(values.size() == 1)
{
rs.append(formatValue(field, values.get(0)));
}
else if(values.size() == 2)
{
rs.append(formatValue(field, values.get(0))).append(" and ").append(formatValue(field, values.get(1)));
}
else if(values.size() > 1)
{
rs.append(formatValue(field, values.get(0))).append(" and ").append(values.size() - 1).append(" other values");
}
return (rs.toString());
}
/***************************************************************************
**
***************************************************************************/
private static String formatValue(QFieldMetaData field, Serializable value)
{
try
{
if(field != null && StringUtils.hasContent(field.getPossibleValueSourceName()))
{
SearchPossibleValueSourceOutput searchPossibleValueSourceOutput = new SearchPossibleValueSourceAction().execute(new SearchPossibleValueSourceInput()
.withIdList(List.of(value))
.withPossibleValueSourceName(field.getPossibleValueSourceName()));
if(CollectionUtils.nullSafeHasContents(searchPossibleValueSourceOutput.getResults()))
{
return searchPossibleValueSourceOutput.getResults().get(0).getLabel();
}
}
}
catch(Exception e)
{
LOG.debug("Error getting formatting value for criteria", e, logPair("field", () -> field.getName()), logPair("value", value));
}
return ValueUtils.getValueAsString(value);
}
}

57
qqq-backend-core/src/test/java/com/kingsrook/qqq/backend/core/utils/QQueryFilterFormatterTest.java Normal file
View File

@ -0,0 +1,57 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qqq.backend.core.utils;
import java.util.List;
import com.kingsrook.qqq.backend.core.BaseTest;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
/*******************************************************************************
** Unit test for QQueryFilterFormatter
*******************************************************************************/
class QQueryFilterFormatterTest extends BaseTest
{
/*******************************************************************************
**
*******************************************************************************/
@Test
void test() throws QException
{
TestUtils.insertDefaultShapes(QContext.getQInstance());
QQueryFilter filter = new QQueryFilter()
.withCriteria("firstName", QCriteriaOperator.EQUALS, "Darin")
.withCriteria("lastName", QCriteriaOperator.IN, List.of("Kelkhoff", "Smellkhoff", "Dumbkhoff"))
.withCriteria("favoriteShapeId", QCriteriaOperator.NOT_EQUALS, List.of(1));
assertEquals("First Name equals Darin AND Last Name is any of Kelkhoff and 2 other values AND Favorite Shape does not equal Triangle", QQueryFilterFormatter.formatQueryFilter(TestUtils.TABLE_NAME_PERSON, filter));
}
}