Filtex

The Filtex library is a versatile tool designed to filtering data across various sources like PostgreSQL, MongoDB, and in-memory datasets. This library empowers developers to create complex queries using both JSON and text formats, generating expressions compatible with the target data sources.

It allows to configure your dataset with some options and provides a metadata model to be able to use in UI components and then it accepts the query that is generated by UI and generates query for data sources like Postgres, Mongo etc.

Check the packages for other platforms.

• filtex-go
• filtex-net
• filtex-js
• filtex-ui

Setup

Add the dependency to your pom.xml:

<dependency>
    <groupId>io.github.filtex</groupId>
    <artifactId>filtex-java</artifactId>
    <version>1.0.0</version>
</dependency>

Usage

Configure

import filtex.Filtex;
import filtex.models.Lookup;
import filtex.options.FieldOption;
import filtex.options.LookupOption;

// Create new filtex instance with options
Filtex fx = Filtex.create(
    FieldOption.create().string().name("name").label("Name"),
    FieldOption.create().number().name("version").label("Version"),
    FieldOption.create().bool().name("status").label("Status").lookup("statuses"),
    LookupOption.create().key("statuses").values(new Lookup[]
    {
        new Lookup("Enabled", true),
        new Lookup("Disabled", false),
    })
);

Metadata

import filtex.expressions.Expression;
import filtex.models.Metadata;

// Get metadata model to render components
Metadata metadata = fx.getMetadata();

System.out.println(metadata);

Expression From Text

// Generate expression from the text input
Expression expression = fx.expressionFromText("Name Contain Filtex And Status Equal Enabled");

Expression From JSON

// Generate expression from the json input
Expression expression = fx.expressionFromJson("["
    + "\"And\","
    + "["
    + "  [\"Name\", \"Contain\", \"Filtex\"],"
    + "  [\"Status\", \"Equal\", \"Enabled\"]"
    + "]"
    + "]");

Validate From Text

// Validate from the text input
fx.validateFromText("Name Contain Filtex And Status Equal Enabled");

Validate From JSON

// Validate from the json input
fx.validateFromJson("["
    + "\"And\","
    + "["
    + "  [\"Name\", \"Contain\", \"Filtex\"],"
    + "  [\"Status\", \"Equal\", \"Enabled\"]"
    + "]"
    + "]");

Mongo Filter

import filtex.builders.mongo.MongoFilterBuilder;
import filtex.builders.mongo.types.MongoExpression;

// Generate filter from the expression for mongo
MongoExpression mongoFilter = new MongoFilterBuilder().build(expression);

System.out.println(mongoFilter);

// Use generated mongo filter
FindIterable<Document> result = mongoClient
        .getCollection("projects")
        .find(mongoFilter.getCondition());

System.out.println(result);

Postgres Filter

import filtex.builders.postgres.PostgresFilterBuilder;
import filtex.builders.postgres.types.PostgresExpression;

// Generate filter from the expression for postgres
PostgresExpression postgresFilter = new PostgresFilterBuilder().build(expression);

System.out.println(postgresFilter);

// Use generated postgres filter
String sql = "SELECT * FROM projects WHERE " + postgresFilter.getCondition();
List<Map<String, Object>> result = postgresClient.query(sql, postgresFilter.getArgs());

System.out.println(result);

Memory Filter

import filtex.builders.memory.MemoryFilterBuilder;
import filtex.builders.memory.types.MemoryExpression;

// Generate filter from the expression for memory
MemoryExpression memoryFilter = new MemoryFilterBuilder().build(expression);

// Use generated memory function
List<Object> result = items.stream()
        .filter(memoryFilter.getFn())
        .collect(Collectors.toList());

System.out.println(result);

License

This library is licensed under the MIT License.