Note
|
Most of the code used throughout this manual is available in the manual demo module included in the project. |
1. Framework
1.1. Domain & Database
1.1.1. Domain Model
Domain modelling
-
Declarative, not magical
-
Visible and localized behavior
-
Safe, testable, Java-native APIs
-
Avoiding runtime introspection/config injection
Codion’s domain model layer is a declarative, type-safe representation of the underlying database schema, designed to provide expressive CRUD functionality without annotation overhead. At its heart is the Entity interface — representing a single row of data and its modifiable state, providing access to attribute values via its get() and set() methods.
Core classes
- Domain
-
Specifies a domain model, containing entity definitions, procedures, functions and reports. A Codion domain model is implemented by extending the DomainModel class and populating it with entity definitions.
- DomainType
-
A unique identifier for a domain model and a factory for EntityType instances associated with that domain model.
- EntityType
-
A unique identifier for an entity type and a factory for Attribute instances associated with that entity type.
- Attribute
-
A typed identifier for a column, foreign key or transient attribute, usually a Column or ForeignKey, allowing for type safe access to the associated value. Attributes are usually wrapped in an interface, serving as a convenient namespace.
- Column
-
An Attribute subclass representing a table column.
- ForeignKey
-
An attribute subclass representing a foreign key relationship.
- EntityDefinition
-
Encapsulates the meta-data required for presenting and persisting an entity.
- AttributeDefinition
-
Each Attribute has an associated AttributeDefinition (or one of its subclasses) which encapsulates the meta-data required for presenting and persisting the associated value.
- Entity
-
Represents a row in a table (or query) and maps Attributes to their associated values while keeping track of values which have been modified since they were initially set.
- Entity.Key
-
Represents a unique key for a given entity.
Domain API
To define a domain model API we:
-
Create a DomainType constant representing the domain.
-
Use the DomainType to create EntityType constants for each table, wrapped in a namespace interface.
-
Use the EntityTypes to create Column constants for each column and a ForeignKey constant for each foreign key.
These constants represent the domain API and are used when referring to tables, columns or foreign keys.
Note
|
The use of constant interfaces is discouraged in modern Java practice because all implementing classes inherit the constants, potentially polluting their namespaces. If this is a concern, use a public static final constants class instead — at the cost of slightly more typing. |
public interface Store {
DomainType DOMAIN = DomainType.domainType("Store");
interface City {
EntityType TYPE = DOMAIN.entityType("store.city"); //(1)
Column<Integer> ID = TYPE.integerColumn("id"); //(2)
Column<String> NAME = TYPE.stringColumn("name");
}
interface Customer {
EntityType TYPE = DOMAIN.entityType("store.customer");
Column<Integer> ID = TYPE.integerColumn("id");
Column<String> NAME = TYPE.stringColumn("name");
Column<Integer> CITY_ID = TYPE.integerColumn("city_id");
ForeignKey CITY_FK = TYPE.foreignKey("city", CITY_ID, City.ID);
}
}
-
The DomainType instance serves as a factory for EntityTypes associated with that domain.
-
Each EntityType instance serves as a factory for Columns and ForeignKeys associated with that entity.
Typically, the underlying table name is used as the EntityType name, but you can use whatever identifying string you want and specify the table name via the tableName() builder method when defining the entity.
The underlying column name is typically used as the Column name, but as with the EntityType you can use whatever value you want and specify the column name via the columnName() method when creating the associated ColumnDefinition.
Domain implementation
The domain model is implemented by extending the DomainModel class and populating it with EntityDefinitions based on the domain tables. An EntityDefinition is comprised of AttributeDefinitions based on the Attributes associated with the entity.
The EntityType and Attribute constants provide define() methods returning builders which allow for further configuration (such as nullability and maximum length for values and the caption and primary key generator for the entity definition).
Tip
|
Omitting a caption marks an attribute as hidden. Hidden attributes won’t appear in table views by default. |
public static class StoreImpl extends DomainModel {
public StoreImpl() {
super(Store.DOMAIN); //(1)
add(city(), customer());
}
EntityDefinition city() {
return City.TYPE.define(
City.ID.define()
.primaryKey(),
City.NAME.define()
.column()
.caption("Name")
.nullable(false))
.keyGenerator(KeyGenerator.identity())
.caption("Cities")
.build();
}
EntityDefinition customer() {
return Customer.TYPE.define(
Customer.ID.define()
.primaryKey(),
Customer.NAME.define()
.column()
.caption("Name")
.maximumLength(42),
Customer.CITY_ID.define()
.column(),
Customer.CITY_FK.define()
.foreignKey()
.caption("City"))
.keyGenerator(KeyGenerator.identity())
.caption("Customers")
.build();
}
}
-
The DomainType constant is a required constructor parameter.
Domain is a Service Provider Interface (SPI), and it is recommended to configure the domain implementation class for the Service Loader. Without the Service Loader you are restricted to a local JDBC connection, since you must manually provide a domain instance when establishing a connection, instead of just referring to the DomainType constant.
src/main/java/module-info.java
provides is.codion.framework.domain.Domain
with is.codion.demos.store.domain.StoreImpl;
or if not using Java Modules (JPMS)
src/main/resources/META-INF/services/is.codion.framework.domain.Domain
is.codion.demos.store.domain.StoreImpl
Note
|
The domain model implementation must be on the classpath when running with a local JDBC connection, but when running with an RMI or HTTP connection the domain model API is sufficient. If you foresee using RMI or HTTP connections it is recommended to split your domain model into separate API and implementation modules, to simplify client configurations (see Chinook and World demo applications, see Petclinic for a simple single class domain model). |
The domain model provides an Entities instance via entities(), which contains the entity definitions and serves as a factory for Entity and Entity.Key instances.
Domain store = new StoreImpl();
Entities entities = store.entities();
Entity city = entities.builder(City.TYPE)
.with(City.NAME, "Reykjavík")
.build();
Entity.Key customerKey = entities.builder(Customer.TYPE).key()
.with(Customer.ID, 42)
.build();
Entity customer = Entity.builder(customerKey)
.with(Customer.NAME, "John")
.with(Customer.CITY_FK, city)
.build();
EntityDefinition customerDefinition = entities.definition(Customer.TYPE);
EntityDefinition cityDefinition = customerDefinition.foreignKeys().referencedBy(Customer.CITY_FK);
List<Column<?>> cityPrimaryKeyColumns = cityDefinition.primaryKey().columns();
Data type mapping
Java type | SQL type |
---|---|
Short |
java.sql.Types.SMALLINT |
Integer |
java.sql.Types.INTEGER |
Double |
java.sql.Types.DOUBLE |
Long |
java.sql.Types.BIGINT |
BigDecimal |
java.sql.Types.DECIMAL |
LocalDateTime |
java.sql.Types.TIMESTAMP |
LocalDate |
java.sql.Types.DATE |
LocalTime |
java.sql.Types.TIME |
OffsetTime |
java.sql.Types.TIME_WITH_TIMEZONE |
OffsetDateTime |
java.sql.Types.TIMESTAMP_WITH_TIMEZONE |
java.util.Date |
java.sql.Types.DATE |
java.sql.Time |
java.sql.Types.TIME |
java.sql.Date |
java.sql.Types.DATE |
java.sql.Timestamp |
java.sql.Types.TIMESTAMP |
String |
java.sql.Types.VARCHAR |
Boolean |
java.sql.Types.BOOLEAN |
Character |
java.sql.Types.CHAR |
byte[] |
java.sql.Types.BLOB |
Foreign keys
Examples
A simple foreign key based on a single column.
ForeignKey CAPITAL_FK = TYPE.foreignKey("capital_fk", CAPITAL, City.ID);
Foreign key based on a composite key.
interface Parent {
EntityType<Entity> TYPE = DOMAIN.entityType("parent");
Column<Integer> ID_1 = TYPE.integerColumn("id1");
Column<Integer> ID_2 = TYPE.integerColumn("id2");
}
interface Child {
EntityType<Entity> TYPE = DOMAIN.entityType("child");
Column<Integer> PARENT_ID_1 = TYPE.integerColumn("parent_id1");
Column<Integer> PARENT_ID_2 = TYPE.integerColumn("parent_id2");
ForeignKey PARENT_FK = TYPE.foreignKey("parent",
PARENT_ID_1, Parent.ID_1,
PARENT_ID_2, Parent.ID_2);
}
Domain constant definitions for the World demo application (simplified).
public interface World {
DomainType DOMAIN = DomainType.domainType(World.class);
interface City {
EntityType TYPE = DOMAIN.entityType("world.city");
Column<Integer> ID = TYPE.integerColumn("id");
Column<String> NAME = TYPE.stringColumn("name");
Column<String> COUNTRY_CODE = TYPE.stringColumn("countrycode");
Column<String> DISTRICT = TYPE.stringColumn("district");
Column<Integer> POPULATION = TYPE.integerColumn("population");
ForeignKey COUNTRY_FK = TYPE.foreignKey("country_fk", COUNTRY_CODE, Country.CODE);
}
interface Country {
EntityType TYPE = DOMAIN.entityType("world.country");
Column<String> CODE = TYPE.stringColumn("code");
Column<String> NAME = TYPE.stringColumn("name");
Column<String> CONTINENT = TYPE.stringColumn("continent");
Column<String> REGION = TYPE.stringColumn("region");
Column<Double> SURFACEAREA = TYPE.doubleColumn("surfacearea");
Column<Integer> INDEPYEAR = TYPE.integerColumn("indepyear");
Column<Integer> POPULATION = TYPE.integerColumn("population");
Column<Double> LIFE_EXPECTANCY = TYPE.doubleColumn("lifeexpectancy");
Column<Double> GNP = TYPE.doubleColumn("gnp");
Column<Double> GNPOLD = TYPE.doubleColumn("gnpold");
Column<String> LOCALNAME = TYPE.stringColumn("localname");
Column<String> GOVERNMENTFORM = TYPE.stringColumn("governmentform");
Column<String> HEADOFSTATE = TYPE.stringColumn("headofstate");
Column<Integer> CAPITAL = TYPE.integerColumn("capital");
Column<String> CODE_2 = TYPE.stringColumn("code2");
Column<Integer> CAPITAL_POPULATION = TYPE.integerColumn("capital_population");
Column<Integer> NO_OF_CITIES = TYPE.integerColumn("no_of_cities");
Column<Integer> NO_OF_LANGUAGES = TYPE.integerColumn("no_of_languages");
Column<byte[]> FLAG = TYPE.byteArrayColumn("flag");
ForeignKey CAPITAL_FK = TYPE.foreignKey("capital_fk", CAPITAL, City.ID);
}
interface CountryLanguage {
EntityType TYPE = DOMAIN.entityType("world.countrylanguage");
Column<String> COUNTRY_CODE = TYPE.stringColumn("countrycode");
Column<String> LANGUAGE = TYPE.stringColumn("language");
Column<Boolean> IS_OFFICIAL = TYPE.booleanColumn("isofficial");
Column<Double> PERCENTAGE = TYPE.doubleColumn("percentage");
Column<Integer> NO_OF_SPEAKERS = TYPE.integerColumn("noOfSpeakers");
ForeignKey COUNTRY_FK = TYPE.foreignKey("country_fk", COUNTRY_CODE, Country.CODE);
}
interface Continent {
EntityType TYPE = DOMAIN.entityType("continent");
Column<String> NAME = TYPE.stringColumn("continent");
Column<Integer> SURFACE_AREA = TYPE.integerColumn("sum(surfacearea)");
Column<Long> POPULATION = TYPE.longColumn("sum(population)");
Column<Double> MIN_LIFE_EXPECTANCY = TYPE.doubleColumn("min(lifeexpectancy)");
Column<Double> MAX_LIFE_EXPECTANCY = TYPE.doubleColumn("max(lifeexpectancy)");
Column<Integer> MIN_INDEPENDENCE_YEAR = TYPE.integerColumn("min(indepyear)");
Column<Integer> MAX_INDEPENDENCE_YEAR = TYPE.integerColumn("max(indepyear)");
Column<Double> GNP = TYPE.doubleColumn("sum(gnp)");
}
}
Attributes
For the framework to know how to present and persist values, Attributes need further configuration. Each attribute is represented by the AttributeDefinition class or one of its subclasses, which encapsulates the required metadata.
The Attribute, Column and ForeignKey classes provide methods for creating AttributeDefinition.Builder instances, which can be used to configure the attributes.
An Attribute can be configured three ways, as transient, derived or denormalized.
Transient
Transient attributes are nullable by default and behave like regular fields, but do not map to any underlying column. Transient attributes are always initialized with a null value. Changing the value of a transient attribute does not render the Entity instance modified by default, but can be configured to do so.
Denormalized
An entity can include a read-only attribute value from an entity referenced via foreign key, by defining a denormalized attribute.
Country.CAPITAL_POPULATION.define()
.denormalized(Country.CAPITAL_FK, City.POPULATION)
.caption("Capital pop.")
.numberFormatGrouping(true),
Derived
A derived attribute is used to represent a value which is derived from one or more attributes in the same entity. The value of a derived attribute is provided via a DerivedAttribute.Provider implementation as shown below.
CountryLanguage.NO_OF_SPEAKERS.define()
.derived(CountryLanguage.COUNTRY_FK, CountryLanguage.PERCENTAGE)
.provider(new NoOfSpeakersProvider())
.caption("No. of speakers")
.numberFormatGrouping(true),
final class NoOfSpeakersProvider implements DerivedAttribute.Provider<Integer> {
@Serial
private static final long serialVersionUID = 1;
@Override
public Integer get(SourceValues values) {
Double percentage = values.get(CountryLanguage.PERCENTAGE);
Entity country = values.get(CountryLanguage.COUNTRY_FK);
if (percentage != null && country != null && !country.isNull(Country.POPULATION)) {
return Double.valueOf(country.get(Country.POPULATION) * (percentage / 100)).intValue();
}
return null;
}
}
Columns
Column
Column is used to represent attributes that are based on table columns.
Country.REGION.define()
.column()
.caption("Region")
.nullable(false)
.maximumLength(26),
Country.SURFACEAREA.define()
.column()
.caption("Surface area")
.nullable(false)
.numberFormatGrouping(true)
.maximumFractionDigits(2),
Country.INDEPYEAR.define()
.column()
.caption("Indep. year")
.valueRange(-2000, 2500),
Country.INDEPYEAR_SEARCHABLE.define()
.column()
.expression("to_char(indepyear)")
.searchable(true)
.readOnly(true),
Country.POPULATION.define()
.column()
.caption("Population")
.nullable(false)
.numberFormatGrouping(true),
Country.LIFE_EXPECTANCY.define()
.column()
.caption("Life expectancy")
.maximumFractionDigits(1)
.valueRange(0, 99),
Primary key
It is recommended that entities have a primary key defined, that is, one or more columns representing a unique combination.
The primary key defined in the domain model does not have to correspond to an actual table primary (or unique) key, although that is of course preferable.
If no primary key columns are specified, equals() will not work (since it is based on the primary key). You can still use the Entity.columnValuesEqual() method to check if all column based values are equal in two entities without primary keys.
Country.CODE.define()
.primaryKey()
.caption("Code")
.updatable(true)
.maximumLength(3),
In case of composite primary keys you simply specify the primary key index.
CountryLanguage.COUNTRY_CODE.define()
.primaryKey(0)
.updatable(true),
CountryLanguage.LANGUAGE.define()
.primaryKey(1)
.caption("Language")
.updatable(true),
Subquery
A Column can represent a subquery returning a single value.
Country.NO_OF_CITIES.define()
.subquery("""
SELECT COUNT(*)
FROM world.city
WHERE city.countrycode = country.code""")
.caption("No. of cities"),
Boolean
For databases supporting Types.BOOLEAN you simply specify a column.
CountryLanguage.IS_OFFICIAL.define()
.column()
.caption("Official")
.columnHasDefaultValue(true)
.nullable(false),
For databases lacking native boolean support we can define a boolean column, specifying the underlying type and the true/false values.
Customer.ACTIVE.define()
.booleanColumn("Is active", Integer.class, 1, 0)
Customer.ACTIVE.define()
.booleanColumn("Is active", String.class, "true", "false")
Customer.ACTIVE.define()
.booleanColumn("Is active", Character.class, 'T', 'F')
Note that boolean attributes always use the boolean Java type, the framework handles translating to and from the actual column values.
entity.set(Customer.ACTIVE, true);
Boolean isActive = entity.get(Customer.ACTIVE);
Item
A column based on a list of valid items.
private static final List<Item<String>> CONTINENT_ITEMS = List.of(
item("Africa"), item("Antarctica"), item("Asia"),
item("Europe"), item("North America"), item("Oceania"),
item("South America"));
Country.CONTINENT.define()
.column()
.items(CONTINENT_ITEMS)
.caption("Continent")
.nullable(false),
Domain
Each entity is defined by creating a EntityDefinition.Builder instance via EntityType.define() and adding the resulting definition to the domain model, via the add(EntityDefinition) method in the DomainModel class. The framework assumes the entityType name is the underlying table name, but the tableName can be specified via EntityDefinition.Builder.tableName(String) method.
EntityDefinition city() {
return City.TYPE.define(
City.ID.define()
.primaryKey(),
City.NAME.define()
.column()
.caption("Name")
.searchable(true)
.nullable(false)
.maximumLength(35),
City.COUNTRY_CODE.define()
.column()
.nullable(false),
City.COUNTRY_FK.define()
.foreignKey()
.caption("Country"),
City.DISTRICT.define()
.column()
.caption("District")
.nullable(false)
.maximumLength(20),
City.POPULATION.define()
.column()
.caption("Population")
.nullable(false)
.numberFormatGrouping(true),
City.LOCATION.define()
.column()
.caption("Location")
.columnClass(String.class, new LocationConverter())
.comparator(new LocationComparator()))
.keyGenerator(sequence("world.city_seq"))
.validator(new CityValidator())
.orderBy(ascending(City.NAME))
.stringFactory(City.NAME)
.description("Cities of the World")
.caption("City")
.build();
}
KeyGenerator
The framework provides implementations for most commonly used primary key generation strategies, identity column, sequence (with or without trigger) and auto-increment columns. The KeyGenerator class serves as a factory for KeyGenerator implementations. Static imports are assumed in the below examples.
Automatic
This assumes the underlying primary key column is either an auto-increment column or is populated from a sequence using a trigger during insert.
//Auto increment column in the 'store.customer' table
.keyGenerator(automatic("store.customer"));
//Trigger and a sequence named 'store.customer_seq'
.keyGenerator(automatic("store.customer_seq"));
Sequence
When sequences are used without triggers the framework can fetch the value from a sequence before insert.
.keyGenerator(sequence("world.city_seq"))
Queried
The framework can select new primary key values from a query.
.keyGenerator(queried("""
select next_id
from store.id_values
where table_name = 'store.customer'"""))
Custom
You can provide a custom key generator strategy by implementing a KeyGenerator.
private static final class UUIDKeyGenerator implements KeyGenerator {
@Override
public void beforeInsert(Entity entity, DatabaseConnection connection) {
entity.set(Customer.ID, UUID.randomUUID().toString());
}
}
StringFactory
The StringFactory class provides a builder for a Function<Entity, String> instance, which is then used to provide the toString() implementations for entities. This value is used wherever entities are displayed, for example in a ComboBox or as foreign key values in table views.
return Address.TYPE.define(
Address.ID.define()
.primaryKey(),
Address.STREET.define()
.column()
.caption("Street")
.nullable(false)
.maximumLength(120),
Address.CITY.define()
.column()
.caption("City")
.nullable(false)
.maximumLength(50),
Address.VALID.define()
.column()
.caption("Valid")
.columnHasDefaultValue(true)
.defaultValue(true)
.nullable(false))
.stringFactory(StringFactory.builder()
.value(Address.STREET)
.text(", ")
.value(Address.CITY)
.build())
.keyGenerator(identity())
.smallDataset(true)
.caption("Address")
.build();
For more complex toString() implementations you can implement a custom Function<Entity, String>.
.stringFactory(new CustomerToString())
private static final class CustomerToString implements Function<Entity, String>, Serializable {
@Serial
private static final long serialVersionUID = 1;
@Override
public String apply(Entity customer) {
return new StringBuilder()
.append(customer.get(Customer.LAST_NAME))
.append(", ")
.append(customer.get(Customer.FIRST_NAME))
.append(customer.optional(Customer.EMAIL)
.map(email -> " <" + email + ">")
.orElse(""))
.toString();
}
}
Validation
Custom validation of Entities is performed by implementing a EntityValidator.
The DefaultEntityValidator implementation provides basic range and null validation and can be extended to provide further validations.
Warning
|
EntityValidator logic runs frequently — avoid expensive operations like database queries. Use edit model listeners (such as beforeInsert or beforeUpdate ) for validations that require cross-entity or remote checks.
|
final class CityValidator extends DefaultEntityValidator implements Serializable {
@Serial
private static final long serialVersionUID = 1;
@Override
public <T> void validate(Entity city, Attribute<T> attribute) {
super.validate(city, attribute);
if (attribute.equals(City.POPULATION)) {
// population is guaranteed to be non-null after the call to super.validate()
Integer cityPopulation = city.get(City.POPULATION);
if (!city.isNull(City.COUNTRY_FK)) {
Entity country = city.get(City.COUNTRY_FK);
Integer countryPopulation = country.get(Country.POPULATION);
if (countryPopulation != null && cityPopulation > countryPopulation) {
throw new ValidationException(City.POPULATION,
cityPopulation, "City population can not exceed country population");
}
}
}
}
}
.validator(new CityValidator())
Custom data types
When using a custom data type you must specify the columnClass of a ColumnDefinition and provide a Converter implementation.
Column<Location> LOCATION = TYPE.column("location", Location.class);
record Location(double latitude, double longitude) implements Serializable {
@Override
public String toString() {
return "[" + latitude + "," + longitude + "]";
}
}
Note
|
The custom type must be serializable for use in an application using the RMI connection. |
City.LOCATION.define()
.column()
.caption("Location")
.columnClass(String.class, new LocationConverter())
.comparator(new LocationComparator()))
private static final class LocationConverter implements Converter<Location, String> {
@Override
public String toColumnValue(Location location,
Statement statement) {
return "POINT (" + location.longitude() + " " + location.latitude() + ")";
}
@Override
public Location fromColumnValue(String columnValue) {
String[] latLon = columnValue
.replace("POINT (", "")
.replace(")", "")
.split(" ");
return new Location(parseDouble(latLon[1]), parseDouble(latLon[0]));
}
}
When using the HTTP connection in an application using a custom data type, you must implement a EntityObjectMapperFactory, providing a EntityObjectMapper instance containing a serializer/deserializer for the custom types.
public final class WorldObjectMapperFactory extends DefaultEntityObjectMapperFactory {
private static final String LATITUDE = "latitude";
private static final String LONGITUDE = "longitude";
public WorldObjectMapperFactory() {
super(World.DOMAIN);
}
@Override
public EntityObjectMapper entityObjectMapper(Entities entities) {
EntityObjectMapper objectMapper = super.entityObjectMapper(entities);
objectMapper.addSerializer(Location.class, new LocationSerializer());
objectMapper.addDeserializer(Location.class, new LocationDeserializer());
return objectMapper;
}
private static final class LocationSerializer extends StdSerializer<Location> {
private LocationSerializer() {
super(Location.class);
}
@Override
public void serialize(Location location, JsonGenerator generator, SerializerProvider provider) throws IOException {
generator.writeStartObject();
generator.writeNumberField(LATITUDE, location.latitude());
generator.writeNumberField(LONGITUDE, location.longitude());
generator.writeEndObject();
}
}
private static final class LocationDeserializer extends StdDeserializer<Location> {
private LocationDeserializer() {
super(Location.class);
}
@Override
public Location deserialize(JsonParser parser, DeserializationContext ctxt) throws IOException, JacksonException {
JsonNode node = parser.getCodec().readTree(parser);
return new Location(node.get(LATITUDE).asDouble(), node.get(LONGITUDE).asDouble());
}
}
}
This EntityObjectMapperFactory must be exposed to the ServiceLoader.
src/main/java/module-info.java
provides is.codion.framework.json.domain.EntityObjectMapperFactory
with is.codion.demos.world.domain.api.WorldObjectMapperFactory;
Entities in action
Using the Entity class is rather straight forward.
EntityConnectionProvider connectionProvider = EntityConnectionProvider.builder()
.domainType(Petstore.DOMAIN)
.clientType("Manual")
.user(User.parse("scott:tiger"))
.build();
Entities entities = connectionProvider.entities();
EntityConnection connection = connectionProvider.connection();
//populate a new category
Entity insects = entities.builder(Category.TYPE)
.with(Category.NAME, "Insects")
.with(Category.DESCRIPTION, "Creepy crawlies")
.build();
insects = connection.insertSelect(insects);
//populate a new product for the insect category
Entity smallBeetles = entities.builder(Product.TYPE)
.with(Product.CATEGORY_FK, insects)
.with(Product.NAME, "Small Beetles")
.with(Product.DESCRIPTION, "Beetles on the smaller side")
.build();
connection.insert(smallBeetles);
//see what products are available for the Cats category
Entity categoryCats = connection.selectSingle(Category.NAME.equalTo("Cats"));
List<Entity> cats = connection.select(Product.CATEGORY_FK.equalTo(categoryCats));
cats.forEach(System.out::println);
Unit Testing
Introduction
To unit test the CRUD operations on the domain model extend DomainTest.
The unit tests are run within a single transaction which is rolled back after the test finishes, so these tests are pretty much guaranteed to leave no junk data behind.
DomainTest
The DomainTest uses a default EntityFactory implementation which provides test entities with randomly created values, based on the value constraints set in the domain model. Extend this class and pass to the super constructor, overriding the required methods.
-
foreignKey should return an entity instance for the given foreign key to use for a foreign key reference required for inserting the entity being tested.
-
entity should return an entity to use as basis for the unit test, that is, the entity that should be inserted, selected, updated and finally deleted.
-
modify should simply leave the entity in a modified state so that it can be used for update test, since the database layer throws an exception if an unmodified entity is updated. If modify returns an unmodified entity, the update test is skipped.
To run the full CRUD test for a domain entity you need to call the test(EntityType entityType) method with the entity type as parameter. You can either create a single testDomain() method and call the test method in turn for each entityType or create a entityName method for each domain entity, as we do in the example below.
public class StoreTest extends DomainTest {
private static final Store DOMAIN = new Store();
public StoreTest() {
super(DOMAIN, StoreEntityFactory::new);
}
@Test
public void customer() {
test(Customer.TYPE);
}
@Test
public void address() {
test(Address.TYPE);
}
@Test
public void customerAddress() {
test(CustomerAddress.TYPE);
}
private static final class StoreEntityFactory extends DefaultEntityFactory {
private StoreEntityFactory(EntityConnection connection) {
super(connection);
}
@Override
public Optional<Entity> entity(ForeignKey foreignKey) {
// See if the currently running test requires an ADDRESS entity
if (foreignKey.referencedType().equals(Address.TYPE)) {
return Optional.of(connection().insertSelect(entities().builder(Address.TYPE)
.with(Address.ID, 21L)
.with(Address.STREET, "One Way")
.with(Address.CITY, "Sin City")
.build()));
}
return super.entity(foreignKey);
}
@Override
public Entity entity(EntityType entityType) {
if (entityType.equals(Address.TYPE)) {
// Initialize an entity representing a record in the
// STORE.ADDRESS table, to use for testing
return entities().builder(Address.TYPE)
.with(Address.ID, 42L)
.with(Address.STREET, "Street")
.with(Address.CITY, "City")
.with(Address.VALID, true)
.build();
}
else if (entityType.equals(Customer.TYPE)) {
// Initialize an entity representing a record in the
// STORE.CUSTOMER table, to use for testing
return entities().builder(Customer.TYPE)
.with(Customer.ID, UUID.randomUUID().toString())
.with(Customer.FIRST_NAME, "Robert")
.with(Customer.LAST_NAME, "Ford")
.with(Customer.ACTIVE, true)
.build();
}
else if (entityType.equals(CustomerAddress.TYPE)) {
return entities().builder(CustomerAddress.TYPE)
.with(CustomerAddress.CUSTOMER_FK, entity(CustomerAddress.CUSTOMER_FK).orElseThrow())
.with(CustomerAddress.ADDRESS_FK, entity(CustomerAddress.ADDRESS_FK).orElseThrow())
.build();
}
return super.entity(entityType);
}
@Override
public void modify(Entity entity) {
if (entity.type().equals(Address.TYPE)) {
entity.set(Address.STREET, "New Street");
entity.set(Address.CITY, "New City");
}
else if (entity.type().equals(Customer.TYPE)) {
// It is sufficient to change the value of a
// single property, but the more, the merrier
entity.set(Customer.FIRST_NAME, "Jesse");
entity.set(Customer.LAST_NAME, "James");
entity.set(Customer.ACTIVE, false);
}
}
}
}
1.1.2. Conditions
Conditions in Codion are composable, strongly-typed query filters used to construct WHERE or HAVING clauses for select, update, and count operations. They are typically created via domain attributes (like Column or ForeignKey), and can be freely combined using logical operators like AND
and OR
.
The Chinook domain model is used in the examples below.
Condition
- Condition
-
Represents a query condition and contains factory methods for creating
Condition
instances. - ColumnCondition
-
Represents a column based
Condition
. - ForeignKeyCondition
-
Represents a foreign key based
Condition
.
Note
|
Column and ForeignKey implement their respective condition factory interfaces (ColumnCondition.Factory and ForeignKeyCondition.Factory), so you can create Condition instances directly from them using fluent methods like .equalTo() , .isNull() , .in() , etc.
|
Condition allArtistsCondition =
Condition.all(Artist.TYPE);
List<Entity> artists =
connection.select(allArtistsCondition);
Condition liveAlbums =
Album.TITLE.likeIgnoreCase("%Live%");
List<Entity> albums =
connection.select(liveAlbums);
Entity metallica =
connection.selectSingle(
Artist.NAME.equalTo("Metallica"));
Condition albums =
Album.ARTIST_FK.equalTo(metallica);
- CustomCondition
-
A CustomCondition can be used when your logic can’t be expressed through column-based or foreign-key-based conditions — for example, when writing native SQL fragments or using DB-specific syntax.
List<Long> classicalPlaylistIds =
List.of(42L, 43L);
Condition noneClassical =
Track.NOT_IN_PLAYLIST.get(
Playlist.ID, classicalPlaylistIds);
List<Entity> tracks =
connection.select(noneClassical);
- Condition.Combination
-
Allows you to combine multiple conditions using logical
AND
/OR
operators. Conditions can be nested to build expressive and complex query logic.
Condition liveMetallicaAlbums =
Condition.and(liveAlbums, metallicaAlbums);
List<Entity> albums =
connection.select(liveMetallicaAlbums);
Select, Update, Count
The EntityConnection.Select
, EntityConnection.Update
, and EntityConnection.Count
classes each provide a .where(Condition)
factory method returning a builder object for further configuration.
Select.where returns a Select.Builder.
Update.where returns a Update.Builder.
Count.where returns a Count.Builder
Select
- EntityConnection.Select
-
Represents a
WHERE
condition as well as extended configuration specifically for selecting, such as orderBy, limit, offset and referenceDepth.
Select selectLiveMetallicaAlbums =
Select.where(liveMetallicaAlbums)
.orderBy(OrderBy.descending(Album.NUMBER_OF_TRACKS))
.build();
List<Entity> albums =
connection.select(selectLiveMetallicaAlbums);
Update
- EntityConnection.Update
-
Represents a
WHERE
condition as well as the columns and values for updating one or more entities.
Update removeLiveMetallicaAlbumCovers =
Update.where(liveMetallicaAlbums)
.set(Album.COVER, null)
.build();
int updateCount =
connection.update(removeLiveMetallicaAlbumCovers);
Count
- EntityConnection.Count
-
Represents a
WHERE
condition specifically for counting records.
Count countAlbumsWithCover =
Count.where(Album.COVER.isNotNull());
int count = connection.count(countAlbumsWithCover);
1.1.3. EntityConnection
Codion’s EntityConnection is the primary interface for executing database operations — including querying, modifying, transaction control, calling procedures and functions and filling reports. It exposes a small, explicit API for working with Entity instances and makes no assumptions about your database engine or schema design.
Codion’s database layer is intentionally minimal. It does not perform SQL joins, nor does it rely on DB-specific features — except where needed for primary key generation via KeyGenerator strategies.
Instead, it gives you predictable, queryable access to individual Entity objects and their associated foreign keys — controlled through a feature called reference depth.
The Chinook domain model is used in the examples below.
Selecting
By default, when you select a row using EntityConnection you receive an Entity instance along with a single level of foreign key references, that is a so-called reference depth of one. This means that selecting a track you get all the entities referenced via foreign keys as well.
The reference depth can be configured on a foreign key basis when defining entities. A reference depth of zero means that no foreign key references are fetched, and a value larger than one means that not only is the foreign key reference fetched but also its foreign key references, until the defined depth has been reached. A negative reference depth means no limit with the whole dependency graph fetched. This limiting of foreign key reference depth can be turned off, meaning the full reference graph is always fetched, via a system property:
codion.db.limitForeignKeyReferenceDepth=false
or the LocalEntityConnection.LIMIT_FOREIGN_KEY_REFERENCE_DEPTH configuration value:
LocalEntityConnection.LIMIT_FOREIGN_KEY_REFERENCE_DEPTH.set(false);
or on a connection instance via setLimitForeignKeyReferenceDepth()
connection.setLimitForeignKeyReferenceDepth(false);
You can specify that the foreign key should not be populated by default by using a reference depth of 0.
InvoiceLine.INVOICE_FK.define()
.foreignKey()
.referenceDepth(0)
.hidden(true),
Or you can specify that the foreign key should be populated along with one more level by using a reference depth of 2.
Track.ALBUM_FK.define()
.foreignKey()
.referenceDepth(2)
.attributes(Album.ARTIST_FK, Album.TITLE),
EntityConnection connection = connectionProvider.connection();
List<Entity> tracks = connection.select(Track.NAME.like("Bad%"));
Entity track = tracks.get(0);
Entity genre = track.get(Track.GENRE_FK);
Entity mediaType = track.get(Track.MEDIATYPE_FK);
Entity album = track.get(Track.ALBUM_FK);
// reference depth for Track.ALBUM_FK is 2, which means two levels of
// references are fetched, so we have the artist here as well
Entity artist = album.get(Album.ARTIST_FK);
The reference depth can also be configured on a query basis, either for the whole query or one or more foreign keys.
EntityConnection connection = connectionProvider.connection();
List<Entity> tracks = connection.select(
Select.where(Track.NAME.like("Bad%"))
.referenceDepth(0)
.build());
Entity track = tracks.get(0);
// reference depth is 0, so this 'genre' instance is null
Entity genre = track.get(Track.GENRE_FK);
// using track.entity(Track.GENRE_FK) you get a 'genre'
// instance containing only the primary key, since the condition
// reference depth limit prevented it from being selected
genre = track.entity(Track.GENRE_FK);
EntityConnection connection = connectionProvider.connection();
List<Entity> tracks = connection.select(
Select.where(Track.NAME.like("Bad%"))
.referenceDepth(Track.ALBUM_FK, 0)
.build());
Entity track = tracks.get(0);
Entity genre = track.get(Track.GENRE_FK);
Entity mediaType = track.get(Track.MEDIATYPE_FK);
// this 'album' instance is null, since the condition
// reference depth limit prevented it from being selected
Entity album = track.get(Track.ALBUM_FK);
// using track.entity(Track.ALBUM_FK) you get an 'album'
// instance containing only the primary key, since the condition
// reference depth limit prevented it from being selected
album = track.entity(Track.ALBUM_FK);
Reference Depth Values:
-
0 – Do not fetch foreign key references
-
1 (default) – Fetch directly referenced foreign key entities
-
N – Fetch up to N levels deep
-
-1 – Fetch entire reference graph (no limit)
The N+1 problem
Selecting tracks performs four queries (track + album, mediatype and genre), but that number of queries is the same whether you select one or a thousand tracks.
Selecting entities
EntityConnection connection = connectionProvider.connection();
List<Entity> artists = connection.select(
Artist.NAME.like("The %"));
List<Entity> nonLiveAlbums = connection.select(and(
Album.ARTIST_FK.in(artists),
Album.TITLE.likeIgnoreCase("%live%")));
Entity aliceInChains = connection.selectSingle(
Artist.NAME.equalTo("Alice In Chains"));
List<Entity> aliceInChainsAlbums = connection.select(
Album.ARTIST_FK.equalTo(aliceInChains));
Entity metal = connection.selectSingle(
Genre.NAME.equalToIgnoreCase("metal"));
List<Entity> metalTracks = connection.select(
Select.where(Track.GENRE_FK.equalTo(metal))
.attributes(Track.NAME, Track.ALBUM_FK)
.orderBy(descending(Track.NAME))
.build());
Long classicalPlaylistId = connection.select(
Playlist.ID, Playlist.NAME.equalTo("Classical")).get(0);
List<Entity> nonClassicalTracks = connection.select(
Track.NOT_IN_PLAYLIST.get(Playlist.ID, classicalPlaylistId));
EntityConnection connection = connectionProvider.connection();
Entities entities = connection.entities();
Entity.Key key = entities.primaryKey(Artist.TYPE, 42L);
Entity artist = connection.select(key);
EntityConnection connection = connectionProvider.connection();
Entities entities = connection.entities();
Entity.Key key42 = entities.primaryKey(Artist.TYPE, 42L);
Entity.Key key43 = entities.primaryKey(Artist.TYPE, 43L);
Collection<Entity> artists = connection.select(List.of(key42, key43));
Selecting values
For selecting the values of a single column.
EntityConnection connection = connectionProvider.connection();
List<String> customerUsStates =
connection.select(Customer.STATE,
Customer.COUNTRY.equalTo("USA"));
iterator
LocalEntityConnection provides a way to iterate over a result set, instead of loading it into memory.
LocalEntityConnection connection = connectionProvider.connection();
try (ResultIterator<Entity> iterator =
connection.iterator(Customer.EMAIL.isNotNull())) {
while (iterator.hasNext()) {
System.out.println(iterator.next().get(Customer.EMAIL));
}
}
catch (SQLException e) {
throw new DatabaseException(e);
}
dependencies
For selecting entities that depend on a set of entities via foreign keys.
EntityConnection connection = connectionProvider.connection();
List<Entity> employees = connection.select(all(Employee.TYPE));
Map<EntityType, Collection<Entity>> dependencies = connection.dependencies(employees);
Collection<Entity> customersDependingOnEmployees = dependencies.get(Customer.TYPE);
Modifying
insert
For inserting rows.
EntityConnection connection = connectionProvider.connection();
Entities entities = connection.entities();
Entity myBand = entities.builder(Artist.TYPE)
.with(Artist.NAME, "My Band")
.build();
myBand = connection.insertSelect(myBand);
Entity firstAlbum = entities.builder(Album.TYPE)
.with(Album.ARTIST_FK, myBand)
.with(Album.TITLE, "First album")
.build();
Entity secondAlbum = entities.builder(Album.TYPE)
.with(Album.ARTIST_FK, myBand)
.with(Album.TITLE, "Second album")
.build();
Collection<Entity.Key> albumKeys =
connection.insert(List.of(firstAlbum, secondAlbum));
update
For updating one or more entity instances.
Important
|
These methods throw an exception if any of the entities is unmodified. |
EntityConnection connection = connectionProvider.connection();
Entity myBand = connection.selectSingle(
Artist.NAME.equalTo("My Band"));
myBand.set(Artist.NAME, "Proper Name");
myBand = connection.updateSelect(myBand);
List<Entity> customersWithoutPhoneNo =
connection.select(Customer.PHONE.isNull());
customersWithoutPhoneNo.forEach(customer ->
customer.set(Customer.PHONE, "<none>"));
connection.update(customersWithoutPhoneNo);
The framework performs optimistic locking during updates using the methods above. This is done by selecting the entities being updated FOR UPDATE (when supported by the underlying database) and comparing all original values to the current row values, throwing an exception if one or more values differ or the row is missing. Optimistic locking is field-based: any difference between original and current values causes an update to fail.
entity.set(Album.TITLE, "New Title");
connection.update(entity); // fails if the row has been changed by someone else
Note
|
Excluding attributes when selecting entities results in those attributes (lazy loaded ones for example) not being included when optimistic locking is performed on subsequent updates, since optimistic locking relies on the original attribute value being available for making a comparison. |
Optimistic locking can be turned off system-wide using a system property:
codion.db.optimisticLocking=false
or by using the LocalEntityConnection.OPTIMISTIC_LOCKING configuration value:
LocalEntityConnection.OPTIMISTIC_LOCKING.set(false);
or on a connection instance via setOptimisticLocking():
connection.setOptimisticLocking(false);
or on a per-entity basis via EntityDefinition.Builder.optimisticLocking(false).
For updating by condition.
EntityConnection connection = connectionProvider.connection();
connection.update(
Update.where(Artist.NAME.equalTo("Azymuth"))
.set(Artist.NAME, "Azymouth")
.build());
int updateCount = connection.update(
Update.where(Customer.EMAIL.isNull())
.set(Customer.EMAIL, "<none>")
.build());
delete
For deleting existing rows.
EntityConnection connection = connectionProvider.connection();
Entity aquaman = connection.selectSingle(
Artist.NAME.equalTo("Aquaman"));
List<Long> aquamanAlbumIds = connection.select(Album.ID,
Album.ARTIST_FK.equalTo(aquaman));
List<Long> aquamanTrackIds = connection.select(Track.ID,
Track.ALBUM_ID.in(aquamanAlbumIds));
int playlistTracksDeleted = connection.delete(
PlaylistTrack.TRACK_ID.in(aquamanTrackIds));
int tracksDeleted = connection.delete(
Track.ALBUM_ID.in(aquamanAlbumIds));
int albumsDeleted = connection.delete(
Album.ARTIST_FK.equalTo(aquaman));
EntityConnection connection = connectionProvider.connection();
Entity audioslave = connection.selectSingle(
Artist.NAME.equalTo("Audioslave"));
List<Entity> albums = connection.select(
Album.ARTIST_FK.equalTo(audioslave));
List<Entity> tracks = connection.select(
Track.ALBUM_FK.in(albums));
List<Entity> playlistTracks = connection.select(
PlaylistTrack.TRACK_FK.in(tracks));
List<Entity> invoiceLines = connection.select(
InvoiceLine.TRACK_FK.in(tracks));
List<Entity> toDelete = new ArrayList<>();
toDelete.addAll(invoiceLines);
toDelete.addAll(playlistTracks);
toDelete.addAll(tracks);
toDelete.addAll(albums);
toDelete.add(audioslave);
connection.delete(Entity.primaryKeys(toDelete));
Procedures & Functions
-
Functions return a single value.
-
Procedures perform logic with no return value.
-
Both are executed through the same API:
EntityConnection.execute(…)
.
Function
EntityConnection connection = connectionProvider.connection();
List<Long> trackIds = List.of(123L, 1234L);
BigDecimal priceIncrease = BigDecimal.valueOf(0.1);
Collection<Entity> modifiedTracks =
connection.execute(Track.RAISE_PRICE,
new RaisePriceParameters(trackIds, priceIncrease));
Collection<Entity> updatedInvoices =
connection.execute(Invoice.UPDATE_TOTALS, List.of(1234L, 3412L));
String playlistName = "Random playlist";
int numberOfTracks = 100;
Collection<Entity> playlistGenres = connection.select(
Genre.NAME.in("Classical", "Soundtrack"));
Entity playlist = connection.execute(Playlist.RANDOM_PLAYLIST,
new RandomPlaylistParameters(playlistName, numberOfTracks, playlistGenres));
Reporting
Transaction control
Transactional
Codion encourages declarative transaction boundaries using lambdas or anonymous classes. This ensures transaction safety (commit/rollback) with minimal boilerplate.
Most use cases are covered by:
-
EntityConnection.transaction(EntityConnection, Transactional transactional) – no return value
-
EntityConnection.transaction(EntityConnection, TransactionalResult transactional) – with return value
These methods perform a commit on success and rollback on failure.
Note
|
Nested transactions are not supported and will cause an IllegalStateException to be thrown, causing the outer transaction to be rolled back. |
EntityConnection connection = connectionProvider.connection();
EntityConnection.transaction(connection, () -> {
Entities entities = connection.entities();
Entity artist = entities.builder(Artist.TYPE)
.with(Artist.NAME, "The Band")
.build();
artist = connection.insertSelect(artist);
Entity album = entities.builder(Album.TYPE)
.with(Album.ARTIST_FK, artist)
.with(Album.TITLE, "The Album")
.build();
connection.insert(album);
});
Same example using an anonymous class
EntityConnection connection = connectionProvider.connection();
Transactional transactional = new Transactional() {
@Override
public void execute() {
Entities entities = connection.entities();
Entity artist = entities.builder(Artist.TYPE)
.with(Artist.NAME, "The Band")
.build();
artist = connection.insertSelect(artist);
Entity album = entities.builder(Album.TYPE)
.with(Album.ARTIST_FK, artist)
.with(Album.TITLE, "The Album")
.build();
connection.insert(album);
}
};
EntityConnection.transaction(connection, transactional);
EntityConnection connection = connectionProvider.connection();
Entity.Key albumKey = EntityConnection.transaction(connection, () -> {
Entities entities = connection.entities();
Entity artist = entities.builder(Artist.TYPE)
.with(Artist.NAME, "The Band")
.build();
artist = connection.insertSelect(artist);
Entity album = entities.builder(Album.TYPE)
.with(Album.ARTIST_FK, artist)
.with(Album.TITLE, "The Album")
.build();
return connection.insert(album);
});
Same example using an anonymous class
EntityConnection connection = connectionProvider.connection();
TransactionalResult<Entity.Key> transactional = new TransactionalResult<Entity.Key>() {
@Override
public Entity.Key execute() {
Entities entities = connection.entities();
Entity artist = entities.builder(Artist.TYPE)
.with(Artist.NAME, "The Band")
.build();
artist = connection.insertSelect(artist);
Entity album = entities.builder(Album.TYPE)
.with(Album.ARTIST_FK, artist)
.with(Album.TITLE, "The Album")
.build();
return connection.insert(album);
}
};
Entity.Key albumKey = EntityConnection.transaction(connection, transactional);
Transaction
For a more fine-grained transaction control and the ability to rollback, transactions can be started and ended manually, note that this is more complex and thereby error-prone and should not be used unless the method described above does not work for your use-case.
// This example demonstrates full manual transaction control, including rollback safety
// and protection against leaving transactions open in the presence of unexpected failures.
EntityConnection connection = connectionProvider.connection();
Entities entities = connection.entities();
// It is very important to start the transaction here, outside the try/catch block,
// otherwise, trying to start a transaction on a connection already with an open transaction
// (which is a bug in itself), would cause the current transaction to be rolled back
// in the Exception catch block, which is probably not what you want.
connection.startTransaction();
try {
Entity artist = entities.builder(Artist.TYPE)
.with(Artist.NAME, "The Band")
.build();
connection.insert(artist);
Entity album = entities.builder(Album.TYPE)
.with(Album.ARTIST_FK, artist)
.with(Album.TITLE, "The Album")
.build();
connection.insert(album);
connection.commitTransaction();
}
catch (DatabaseException e) {
connection.rollbackTransaction();
throw e;
}
catch (RuntimeException e) {
// It is a good practice, but not necessary, to catch RuntimeException,
// in order to not wrap a RuntimeException in another RuntimeException.
connection.rollbackTransaction();
throw e;
}
catch (Exception e) {
// Always include a catch for the top level Exception, otherwise unexpected
// exceptions may cause a transaction to remain open, which is a very serious bug.
connection.rollbackTransaction();
throw new RuntimeException(e);
}
catch (Throwable e) {
// It's rare, but including a catch for Throwable ensures rollback safety
// even in the face of serious errors (e.g., OutOfMemoryError, LinkageError).
connection.rollbackTransaction();
throw e;
}
LocalEntityConnection
An EntityConnection implementation based on a direct connection to the database, provides access to the underlying JDBC connection.
1.1.4. EntityConnectionProvider
An EntityConnectionProvider is a factory and lifecycle manager for EntityConnection instances — ensuring reliable access to the database regardless of protocol (JDBC, RMI, HTTP).
In most cases EntityConnections are retrieved from a EntityConnectionProvider, which is responsible for establishing a connection to the underlying database. The EntityConnectionProvider class is central to the framework and is a common constructor parameter in classes requiring database access.
Each call to connection() returns the current active connection. If the existing connection is invalid (e.g., due to network failure or server restart), a new one is transparently established. If the EntityConnectionProvider is unable to connect to the underlying database or server, connection() throws an exception.
Important
|
Do NOT cache the EntityConnection instance. The instance returned by connection() should only be kept for a short time, such as a local variable or method parameter since it can become invalid and thereby unusable. Always use connection() to make sure you have a healthy EntityConnection. |
LocalEntityConnectionProvider
Provides a connection based on a local JDBC connection.
Database.DATABASE_URL.set("jdbc:h2:mem:h2db");
Database.DATABASE_INIT_SCRIPTS.set("src/main/sql/create_schema.sql");
Database database = Database.instance();
LocalEntityConnectionProvider connectionProvider =
LocalEntityConnectionProvider.builder()
.database(database)
.domain(new ChinookImpl())
.user(User.parse("scott:tiger"))
.build();
LocalEntityConnection entityConnection =
connectionProvider.connection();
DatabaseConnection databaseConnection =
entityConnection.databaseConnection();
// the underlying JDBC connection is available in a local connection
Connection connection = databaseConnection.getConnection();
connectionProvider.close();
RemoteEntityConnectionProvider
Provides a connection based on a remote RMI connection.
RemoteEntityConnectionProvider connectionProvider =
RemoteEntityConnectionProvider.builder()
.domainType(Chinook.DOMAIN)
.user(User.parse("scott:tiger"))
.clientType(EntityConnectionProviderDemo.class.getSimpleName())
.hostName("localhost")
.registryPort(1099)
.build();
EntityConnection entityConnection =
connectionProvider.connection();
Entities entities = entityConnection.entities();
Entity track = entityConnection.select(entities.primaryKey(Track.TYPE, 42L));
connectionProvider.close();
HttpEntityConnectionProvider
Provides a connection based on a remote HTTP connection.
HttpEntityConnectionProvider connectionProvider =
HttpEntityConnectionProvider.builder()
.domainType(Chinook.DOMAIN)
.clientType(EntityConnectionProviderDemo.class.getSimpleName())
.user(User.parse("scott:tiger"))
.hostName("localhost")
.port(8080)
.https(false)
.build();
EntityConnection entityConnection = connectionProvider.connection();
Entities entities = entityConnection.entities();
entityConnection.select(entities.primaryKey(Track.TYPE, 42L));
connectionProvider.close();
1.2. Framework Model
1.2.1. Framework Model Architecture
The framework model layer serves as the bridge between the domain layer’s entity definitions and the UI layer’s visual components. It provides a comprehensive set of model classes that handle data retrieval, manipulation, and state management while maintaining strict separation of concerns.
Overview
The model layer implements a reactive MVC architecture where:
-
Models manage data and business logic through observable state
-
Views (UI layer) observe models for state changes
-
Controllers are the reactive bindings (like ComponentValue) that automatically synchronize models and views
All model components are built on Codion’s observable foundation, ensuring that any data or state change automatically propagates to interested observers.
Core Components
EntityModel
The EntityModel serves as the central coordinator, managing both edit and table models along with any detail models in master-detail relationships.
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityModel invoiceModel = new SwingEntityModel(Invoice.TYPE, connectionProvider);
// Establish master-detail relationship
customerModel.detailModels().add(invoiceModel);
EntityEditModel
The EntityEditModel handles single entity CRUD operations and maintains the current entity state.
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
EntityEditModel editModel = customerModel.editModel();
// Access entity values
Value<String> nameValue = editModel.editor().value(Customer.FIRSTNAME);
// Perform operations
editModel.insert();
editModel.update();
editModel.delete();
EntityTableModel
The EntityTableModel manages collections of entities, providing sorting, filtering, and selection capabilities.
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
EntityTableModel tableModel = customerModel.tableModel();
// Refresh data
tableModel.items().refresh();
// Access selection
Collection<Entity> selected = tableModel.selection().items().get();
EntityQueryModel
The EntityQueryModel controls how data is fetched from the database, including conditions, limits, and ordering.
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityTableModel tableModel = customerModel.tableModel();
EntityQueryModel queryModel = tableModel.queryModel();
// Configure query behavior
queryModel.limit().set(200);
queryModel.conditionRequired().set(true);
queryModel.orderBy().set(OrderBy.ascending(Customer.LASTNAME));
Observable Architecture
Every model component extends Codion’s observable foundation:
State Management
Models expose their state through observable values:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
EntityEditModel editModel = customerModel.editModel();
EntityTableModel tableModel = customerModel.tableModel();
// Edit model states
State updateEnabled = editModel.updateEnabled();
State updateMultipleEnabled = editModel.updateMultipleEnabled();
ObservableState modified = editModel.editor().modified();
// Table model states
ObservableState refreshing = tableModel.items().refresher().active();
ObservableState hasSelection = tableModel.selection().empty().not();
// Combine states
ObservableState canDelete = State.and(hasSelection, refreshing.not());
Event System
Models emit events for all significant operations:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityEditModel editModel = customerModel.editModel();
SwingEntityTableModel tableModel = customerModel.tableModel();
// Listen for entity changes
editModel.afterInsert().addConsumer(entities -> {
System.out.println("Inserted: " + entities);
});
// Listen for selection changes
tableModel.selection().item().addConsumer(selectedEntity -> {
if (selectedEntity != null) {
loadDetails(selectedEntity);
}
});
Value Observers
Entity values are observable and can be bound across models:
SwingEntityModel trackModel = new SwingEntityModel(Track.TYPE, connectionProvider);
EntityEditModel editModel = trackModel.editModel();
// Bind edit model value to UI state
EditorValue<BigDecimal> priceValue = editModel.editor().value(Track.UNITPRICE);
ObservableState priceValid = editModel.editor().value(Track.UNITPRICE).valid();
// React to value changes
priceValue.addConsumer(newPrice -> updateTotalPrice(newPrice));
// React to value edits
priceValue.edited().addConsumer(newPrice -> System.out.println("Price: " + newPrice));
Model Relationships
Master-Detail Pattern
The framework supports arbitrarily deep master-detail hierarchies:
// Three-level hierarchy
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityModel invoiceModel = new SwingEntityModel(Invoice.TYPE, connectionProvider);
SwingEntityModel invoiceLineModel = new SwingEntityModel(InvoiceLine.TYPE, connectionProvider);
customerModel.detailModels().add(invoiceModel);
invoiceModel.detailModels().add(invoiceLineModel);
// Selection cascades down the hierarchy
Entity customer = getCustomer(connectionProvider);
customerModel.tableModel().selection().item().set(customer);
// Invoices for selected customer are loaded
Entity invoice = invoiceModel.tableModel().items().visible().get(0);
invoiceModel.tableModel().selection().item().set(invoice);
// Invoice lines for selected invoice are loaded
Best Practices
Query Optimization
Always configure appropriate limits to prevent loading excessive data:
class CustomerTableModel extends SwingEntityTableModel {
public CustomerTableModel(EntityConnectionProvider connectionProvider) {
super(new SwingEntityEditModel(Customer.TYPE, connectionProvider));
// Prevent loading entire customer base
queryModel().limit().set(100);
queryModel().conditionRequired().set(true);
}
}
Event Handling
Use the event system to maintain consistency across models:
SwingEntityModel invoiceLineModel = new SwingEntityModel(InvoiceLine.TYPE, connectionProvider);
// Update summary when details change
invoiceLineModel.editModel().afterInsert().addConsumer(entities -> updateInvoiceTotal());
invoiceLineModel.editModel().afterUpdate().addConsumer(entities -> updateInvoiceTotal());
invoiceLineModel.editModel().afterDelete().addConsumer(entities -> updateInvoiceTotal());
Custom Data Sources
For specialized queries, consider custom data sources:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityTableModel tableModel = customerModel.tableModel();
// Fetch only Customers with emails by default
tableModel.queryModel().dataSource().set(queryModel -> {
EntityConnection connection = queryModel.connectionProvider().connection();
return connection.select(and(
Customer.EMAIL.isNotNull(),
queryModel.condition().where(Conjunction.AND))
);
});
See Also
-
EntityModel - Detailed EntityModel documentation
-
EntityEditModel - Edit model specifics
-
EntityTableModel - Table model features
-
Domain Model - Entity definition layer
1.2.2. EntityModel
The application model layer consists of the EntityModel class and its associates; the EntityTableModel, which provides a table representation of entities and the EntityEditModel which provides the CRUD operations.
An EntityModel always contains an EntityEditModel instance and usually contains a EntityTableModel as well. A default edit model implementation is created automatically by the EntityTableModel if one is not supplied via a constructor argument.
public class AddressModel extends SwingEntityModel {
public AddressModel(EntityConnectionProvider connectionProvider) {
super(Address.TYPE, connectionProvider);
}
}
public class CustomerAddressModel extends SwingEntityModel {
public CustomerAddressModel(EntityConnectionProvider connectionProvider) {
super(new CustomerAddressTableModel(connectionProvider));
}
}
Detail models
An EntityModel can contain one or more detail models, usually based on foreign key relationships.
public class StoreApplicationModel extends SwingEntityApplicationModel {
public StoreApplicationModel(EntityConnectionProvider connectionProvider) {
super(connectionProvider, List.of(createCustomerModel(connectionProvider)));
}
private static SwingEntityModel createCustomerModel(EntityConnectionProvider connectionProvider) {
CustomerModel customerModel =
new CustomerModel(connectionProvider);
CustomerAddressModel customerAddressModel =
new CustomerAddressModel(connectionProvider);
customerModel.detailModels().add(customerAddressModel);
//populate the model with rows from the database
customerModel.tableModel().items().refresh();
return customerModel;
}
}
Event binding
The model layer classes expose a number of Event, State and Value observers.
The example below prints, to the standard output, all changes made to a given attribute value as well as a message indicating that a table refresh has started.
public class CustomerModel extends SwingEntityModel {
public CustomerModel(EntityConnectionProvider connectionProvider) {
super(new CustomerTableModel(connectionProvider));
bindEvents();
}
private void bindEvents() {
CustomerTableModel tableModel = (CustomerTableModel) tableModel();
tableModel.selection().items()
.addConsumer(selected ->
System.out.println("Items selected: " + selected));
tableModel.items().refresher().result()
.addListener(() -> System.out.println("Refresh successful"));
CustomerEditModel editModel = (CustomerEditModel) editModel();
editModel.afterInsert()
.addConsumer(inserted ->
System.out.println("Entities inserted" + inserted));
editModel.editor().value(Customer.FIRST_NAME).edited()
.addConsumer(firstName ->
System.out.println("First name changed to " + firstName));
}
}
1.2.3. EntityEditModel
The EntityEditModel interface defines the CRUD business logic used by the EntityEditPanel class when entities are being edited. The EntityEditModel works with a single entity instance, which can be retrieved and set via the EntityEditor instance accessible via the editor() method. EntityEditor exposes a number of methods for manipulating as well as querying the state of the entity being edited.
public class CustomerEditModel extends SwingEntityEditModel {
public CustomerEditModel(EntityConnectionProvider connectionProvider) {
super(Customer.TYPE, connectionProvider);
}
}
EntityConnectionProvider connectionProvider =
EntityConnectionProvider.builder()
.domainType(Store.DOMAIN)
.user(User.parse("scott:tiger"))
.clientType("StoreMisc")
.build();
CustomerEditModel editModel = new CustomerEditModel(connectionProvider);
EntityEditor editor = editModel.editor();
editor.value(Customer.ID).defaultValue()
.set(() -> UUID.randomUUID().toString());
//sets the defaults
editor.defaults();
//set the values
editor.value(Customer.FIRST_NAME).set("Björn");
editor.value(Customer.LAST_NAME).set("Sigurðsson");
editor.value(Customer.ACTIVE).set(true);
//inserts and returns the inserted entity
Entity customer = editModel.insert();
//modify some values
editor.value(Customer.FIRST_NAME).set("John");
editor.value(Customer.LAST_NAME).set("Doe");
//updates and returns the updated entity
customer = editModel.update();
//deletes the active entity
editModel.delete();
1.2.4. EntityTableModel
The EntityTableModel class provides a table representation of the underlying entities.
Every EntityTableModel contains a EntityEditModel instance. A default edit model implementation is created automatically by the EntityTableModel if one is not supplied via a constructor argument.
public class CustomerTableModel extends SwingEntityTableModel {
public CustomerTableModel(EntityConnectionProvider connectionProvider) {
super(new CustomerEditModel(connectionProvider));
}
}
public class CustomerAddressTableModel extends SwingEntityTableModel {
public CustomerAddressTableModel(EntityConnectionProvider connectionProvider) {
super(CustomerAddress.TYPE, connectionProvider);
}
}
1.2.5. EntityQueryModel
The EntityQueryModel manages how entities are fetched from the database for table models. It provides fine-grained control over query conditions, result limits, ordering, and custom data sources.
Overview
EntityQueryModel
acts as the data retrieval engine for EntityTableModel
, encapsulating:
-
Query conditions (WHERE and HAVING clauses)
-
Result limits to prevent excessive data loading
-
Custom ordering specifications
-
Attribute selection for optimization
-
Custom data sources for specialized queries
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityTableModel tableModel = customerModel.tableModel();
EntityQueryModel queryModel = tableModel.queryModel();
// Configure query behavior
queryModel.limit().set(200);
queryModel.conditionRequired().set(true);
queryModel.orderBy().set(OrderBy.ascending(Customer.LASTNAME));
Condition Management
Table Condition Model
The primary condition mechanism is the EntityTableConditionModel, which provides a flexible way to build complex queries:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
EntityTableConditionModel conditionModel = customerModel.tableModel().queryModel().condition();
// Set condition values
conditionModel.get(Customer.EMAIL).set().isNotNull();
conditionModel.get(Customer.COUNTRY).set().equalTo("Iceland");
// The resulting query will include:
// WHERE email is not null AND country = 'Iceland'
Additional WHERE Conditions
Beyond the table condition model, you can add custom WHERE conditions:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
EntityQueryModel queryModel = customerModel.tableModel().queryModel();
// Single additional condition
queryModel.where().conjunction().set(Conjunction.AND);
queryModel.where().set(() -> Customer.COUNTRY.equalTo("Iceland"));
// Multiple conditions with custom conjunction
queryModel.where().set(() -> Condition.or(
Customer.CITY.equalTo("Reykjavik"),
Customer.CITY.equalTo("Akureyri")
));
Query Limits
Prevent loading excessive data by setting query limits:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
EntityQueryModel queryModel = customerModel.tableModel().queryModel();
// Set a specific limit
queryModel.limit().set(500);
// Remove limit (fetch all matching rows)
queryModel.limit().clear();
// Add a max limit validator
queryModel.limit().addValidator(newLimit -> {
if (newLimit > 10.000) {
throw new IllegalArgumentException("Limit may not exceed 10.000");
}
});
// Listen for limit changes
queryModel.limit().addConsumer(newLimit ->
System.out.println("Query limit changed to: " + newLimit));
Result Ordering
Specify how results should be ordered:
SwingEntityModel invoiceModel = new SwingEntityModel(Invoice.TYPE, connectionProvider);
EntityQueryModel queryModel = invoiceModel.tableModel().queryModel();
// Single column ordering
queryModel.orderBy().set(OrderBy.descending(Invoice.DATE));
// Multiple columns
queryModel.orderBy().set(OrderBy.builder()
.ascending(Invoice.BILLINGCOUNTRY)
.descending(Invoice.DATE)
.build()
);
Custom Data Sources
For complex queries that can’t be expressed through conditions, provide a custom data source:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
EntityQueryModel entityQueryModel = customerModel.tableModel().queryModel();
entityQueryModel.dataSource().set(queryModel -> {
EntityConnection connection = queryModel.connectionProvider().connection();
// Custom query with complex joins or database-specific features
return connection.select(Select.where(customComplexCondition())
.attributes(Customer.ADDRESS, Customer.CITY, Customer.COUNTRY)
.build());
});
Condition Required
Prevent accidental full table scans:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
EntityQueryModel queryModel = customerModel.tableModel().queryModel();
// Require at least one condition
queryModel.conditionRequired().set(true);
// Specify that a certain condition must be enabled
queryModel.conditionEnabled().set(queryModel.condition().get(Customer.SUPPORTREP_FK).enabled());
Attribute Management
Optimize queries by selecting only needed attributes:
SwingEntityModel albumModel = new SwingEntityModel(Album.TYPE, connectionProvider);
EntityQueryModel queryModel = albumModel.tableModel().queryModel();
// Exclude large columns by default
queryModel.attributes().excluded().add(Album.COVER);
// Include them only when needed
State detailView = State.state();
detailView.addConsumer(showDetails -> {
if (showDetails) {
queryModel.attributes().included().add(Album.COVER);
}
});
Configuration Properties
Property | Default | Description |
---|---|---|
|
1000 |
Default query limit |
|
false |
Whether queries require at least one condition |
|
empty |
Default attributes to exclude from queries |
1.2.6. EntitySearchModel
The EntitySearchModel is the model component underlying the EntitySearchField UI component. It provides entity search functionality with support for multi-column text searching and entity selection.
Overview
EntitySearchModel
provides:
-
Multi-column text searching with configurable wildcards
-
Single or multi-entity selection management
-
Result limiting to prevent excessive data retrieval
-
Case-sensitive or insensitive search options
-
The model component for
EntitySearchField
UI component -
Automatic updates when entities are modified
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider)
.searchColumns(List.of(Customer.FIRSTNAME, Customer.LASTNAME, Customer.EMAIL))
.limit(50)
.build();
// Perform search
searchModel.condition().set(() -> Customer.FIRSTNAME.equalTo("john"));
// Get search result
List<Entity> result = searchModel.search().result();
Search Configuration
Search Settings
Configure search behavior per column:
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider)
.searchColumns(List.of(Customer.FIRSTNAME, Customer.LASTNAME))
.build();
// Get settings for a specific column
EntitySearchModel.Settings settings = searchModel.settings().get(Customer.LASTNAME);
// Add wildcards automatically
settings.wildcardPrefix().set(true); // Adds % before search text
settings.wildcardPostfix().set(true); // Adds % after search text
// Replace spaces with wildcards
settings.spaceAsWildcard().set(true); // "john smith" → "john%smith"
// Case sensitivity
settings.caseSensitive().set(false); // Case-insensitive search
Wildcard Strategies
The search model supports different wildcard configurations:
-
Prefix search (autocomplete style):
wildcardPrefix(false)
,wildcardPostfix(true)
- "joh" → "joh%" -
Contains search:
wildcardPrefix(true)
,wildcardPostfix(true)
- "ohn" → "%ohn%" -
Exact search:
wildcardPrefix(false)
,wildcardPostfix(false)
- "john" → "john" -
Multi-word search:
spaceAsWildcard(true)
- "john reyk" → "%john%reyk%"
Selection Management
Single Selection Mode
For selecting one entity at a time:
EntitySearchModel searchModel = EntitySearchModel.builder(Album.TYPE, connectionProvider)
.searchColumns(List.of(Album.TITLE))
.build();
// Set selection programmatically
Entity album = getAlbum(connectionProvider);
searchModel.selection().entity().set(album);
// React to selection changes
searchModel.selection().entity().addConsumer(selectedAlbum -> {
if (selectedAlbum != null) {
displayAlbumDetails(selectedAlbum);
}
});
// Clear selection
searchModel.selection().clear();
Multi-Selection Mode
For selecting multiple entities:
EntitySearchModel searchModel = EntitySearchModel.builder(Track.TYPE, connectionProvider)
.searchColumns(List.of(Track.NAME))
.build();
// Get all selected entities
Collection<Entity> selectedTracks = searchModel.selection().entities().get();
// Add to selection
Entity track = getTrack(connectionProvider);
searchModel.selection().entities().add(track);
// Remove from selection
searchModel.selection().entities().remove(track);
// Replace entire selection
searchModel.selection().entities().set(List.of(track));
Configuration Properties
Property | Default | Description |
---|---|---|
|
true |
Whether search models react to entity edit events |
|
100 |
Default result limit for search models |
|
false |
Default wildcard prefix setting |
|
true |
Default wildcard postfix setting |
|
false |
Default space replacement setting |
|
false |
Default case sensitivity setting |
1.2.7. Model Linking
Model linking provides the mechanism for establishing master-detail relationships between entity models. The framework automatically synchronizes detail models based on master model selection and data changes.
Overview
The ModelLink API enables automatic detail model filtering based on master selection and propagation of data changes.
// Invoice -> InvoiceLines
SwingEntityModel invoiceModel = new SwingEntityModel(Invoice.TYPE, connectionProvider);
SwingEntityModel invoiceLineModel = new SwingEntityModel(InvoiceLine.TYPE, connectionProvider);
invoiceModel.detailModels().add(invoiceLineModel);
// Configure detail model for optimal performance
invoiceLineModel.tableModel().queryModel().conditionRequired().set(true); // Don't load all lines
invoiceLineModel.tableModel().queryModel().limit().set(1000); // Reasonable limit
Building Custom Links
Create links with specific behavior:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityModel invoiceModel = new SwingEntityModel(Invoice.TYPE, connectionProvider);
ModelLink<SwingEntityModel, SwingEntityEditModel, SwingEntityTableModel> customLink =
customerModel.link(invoiceModel)
.active(true)
.onSelection(selectedCustomers -> {
// Custom selection logic
if (selectedCustomers.size() > 1) {
// Handle multi-selection differently
invoiceModel.tableModel().queryModel().condition().clear();
invoiceModel.tableModel().queryModel().where().set(() ->
Invoice.CUSTOMER_FK.in(selectedCustomers)
);
}
})
.build();
customerModel.detailModels().add(customLink);
Automatic Foreign Key Management
The ForeignKeyModelLink specializes ModelLink
for foreign key relationships:
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityModel invoiceModel = new SwingEntityModel(Invoice.TYPE, connectionProvider);
// ForeignKeyModelLink is created automatically when foreign key is detected
customerModel.detailModels().add(invoiceModel);
// Or configure explicitly
customerModel.detailModels().add(ForeignKeyModelLink.builder(invoiceModel, Invoice.CUSTOMER_FK)
// Clear foreign key value when master has no selection
.clearValueOnEmptySelection(true)
// Set foreign key value automatically on insert
.setValueOnInsert(true)
// Control when to refresh detail data
.refreshOnSelection(true)
// Filter detail records based on master selection
.setConditionOnInsert(true)
.build());
Simple One-to-Many
Classic master-detail relationship:
// Invoice -> InvoiceLines
SwingEntityModel invoiceModel = new SwingEntityModel(Invoice.TYPE, connectionProvider);
SwingEntityModel invoiceLineModel = new SwingEntityModel(InvoiceLine.TYPE, connectionProvider);
invoiceModel.detailModels().add(invoiceLineModel);
// Configure detail model for optimal performance
invoiceLineModel.tableModel().queryModel().conditionRequired().set(true); // Don't load all lines
invoiceLineModel.tableModel().queryModel().limit().set(1000); // Reasonable limit
Multi-Level Hierarchy
Deep master-detail chains:
// Customer -> Invoice -> InvoiceLine
SwingEntityModel customerModel = new SwingEntityModel(Customer.TYPE, connectionProvider);
SwingEntityModel invoiceModel = new SwingEntityModel(Invoice.TYPE, connectionProvider);
SwingEntityModel invoiceLineModel = new SwingEntityModel(InvoiceLine.TYPE, connectionProvider);
// Build hierarchy
customerModel.detailModels().add(invoiceModel);
invoiceModel.detailModels().add(invoiceLineModel);
// Configure each level
invoiceModel.tableModel().queryModel().conditionRequired().set(true);
invoiceLineModel.tableModel().queryModel().conditionRequired().set(true);
// Selection cascades down the hierarchy automatically
Entity customer = getCustomer(connectionProvider);
customerModel.tableModel().selection().item().set(customer);
// Invoices for customer are loaded
// When an invoice is selected, its lines are loaded
invoiceModel.tableModel().selection().indexes().increment();// selects first
1.2.8. EntityApplicationModel
The EntityApplicationModel class serves as the base for the application. Its main purpose is to hold references to the root EntityModel instances used by the application.
When extending this class you must provide a constructor with a single EntityConnectionProvider parameter, as seen below.
public class StoreApplicationModel extends SwingEntityApplicationModel {
public StoreApplicationModel(EntityConnectionProvider connectionProvider) {
super(connectionProvider, List.of(createCustomerModel(connectionProvider)));
}
private static SwingEntityModel createCustomerModel(EntityConnectionProvider connectionProvider) {
CustomerModel customerModel =
new CustomerModel(connectionProvider);
CustomerAddressModel customerAddressModel =
new CustomerAddressModel(connectionProvider);
customerModel.detailModels().add(customerAddressModel);
//populate the model with rows from the database
customerModel.tableModel().items().refresh();
return customerModel;
}
}
1.2.9. Application load testing
The application load testing harness is used to see how your application, server and database handle multiple concurrent users.
This is done by using the LoadTestModel and LoadTestPanel classes as shown below.
public class StoreLoadTest {
private static final class StoreApplicationModelFactory
implements Function<User, StoreApplicationModel> {
@Override
public StoreApplicationModel apply(User user) {
EntityConnectionProvider connectionProvider =
RemoteEntityConnectionProvider.builder()
.user(user)
.domainType(Store.DOMAIN)
.build();
return new StoreApplicationModel(connectionProvider);
}
}
private static class StoreScenarioPerformer
implements Performer<StoreApplicationModel> {
private static final Random RANDOM = new Random();
@Override
public void perform(StoreApplicationModel application) {
SwingEntityModel customerModel = application.entityModels().get(Customer.TYPE);
customerModel.tableModel().items().refresh();
selectRandomRow(customerModel.tableModel());
}
private static void selectRandomRow(EntityTableModel<?> tableModel) {
if (tableModel.items().visible().count() > 0) {
tableModel.selection().index().set(RANDOM.nextInt(tableModel.items().visible().count()));
}
}
}
public static void main(String[] args) {
LoadTest<StoreApplicationModel> loadTest =
LoadTest.builder(new StoreApplicationModelFactory(),
application -> application.connectionProvider().close())
.user(User.parse("scott:tiger"))
.scenarios(List.of(scenario(new StoreScenarioPerformer())))
.name("Store LoadTest - " + EntityConnectionProvider.CLIENT_CONNECTION_TYPE.get())
.build();
loadTestPanel(loadTestModel(loadTest)).run();
}
}
1.3. Framework UI
1.3.1. EntityPanel
The EntityPanel is the base UI class for working with entity instances. It usually consists of an EntityTablePanel, an EntityEditPanel, and a set of detail panels representing the entities having a master/detail relationship with the underlying entity.
Basics
You can either extend the EntityPanel class or instantiate one directly, depending on your needs.
public class AddressPanel extends EntityPanel {
public AddressPanel(SwingEntityModel addressModel) {
super(addressModel, new AddressEditPanel(addressModel.editModel()));
}
}
SwingEntityModel addressModel =
new SwingEntityModel(Address.TYPE, connectionProvider);
EntityPanel addressPanel =
new EntityPanel(addressModel,
new AddressEditPanel(addressModel.editModel()));
Detail panels
Adding a detail panel is done with a single method call, but note that the underlying EntityModel must contain the correct detail model for the detail panel, in this case a CustomerModel instance, see detail models. See EntityApplicationPanel.
public class CustomerPanel extends EntityPanel {
public CustomerPanel(SwingEntityModel entityModel) {
super(entityModel);
SwingEntityModel addressModel =
entityModel.detailModels().get(Address.TYPE);
detailPanels().add(new AddressPanel(addressModel));
}
}
1.3.2. EntityEditPanel
The EntityEditPanel manages the input components (text fields, combo boxes and such) for editing an entity instance.
When extending an EntityEditPanel you must implement the initializeUI() method, which initializes the edit panel UI. The EntityEditPanel class exposes methods for creating input components and binding them with the underlying EntityEditModel instance.
public class CustomerEditPanel extends EntityEditPanel {
public CustomerEditPanel(SwingEntityEditModel editModel) {
super(editModel);
}
@Override
protected void initializeUI() {
//the firstName field should receive the focus whenever the panel is initialized
focus().initial().set(Customer.FIRST_NAME);
createTextField(Customer.FIRST_NAME);
createTextField(Customer.LAST_NAME);
createTextField(Customer.EMAIL);
createCheckBox(Customer.ACTIVE);
setLayout(new GridLayout(4, 1));
//the addInputPanel method creates and adds a panel containing the
//component associated with the attribute as well as a JLabel with the
//property caption as defined in the domain model
addInputPanel(Customer.FIRST_NAME);
addInputPanel(Customer.LAST_NAME);
addInputPanel(Customer.EMAIL);
addInputPanel(Customer.ACTIVE);
}
}
public class AddressEditPanel extends EntityEditPanel {
public AddressEditPanel(SwingEntityEditModel editModel) {
super(editModel);
}
@Override
protected void initializeUI() {
focus().initial().set(Address.STREET);
createTextField(Address.STREET).columns(25);
createTextField(Address.CITY).columns(25);
createCheckBox(Address.VALID);
setLayout(new GridLayout(3, 1, 5, 5));
addInputPanel(Address.STREET);
addInputPanel(Address.CITY);
addInputPanel(Address.VALID);
}
}
public class CustomerAddressEditPanel extends EntityEditPanel {
public CustomerAddressEditPanel(SwingEntityEditModel editModel) {
super(editModel);
}
@Override
protected void initializeUI() {
focus().initial().set(CustomerAddress.ADDRESS_FK);
createComboBoxPanel(CustomerAddress.ADDRESS_FK, this::createAddressEditPanel)
.preferredWidth(280)
.includeAddButton(true);
setLayout(borderLayout());
addInputPanel(CustomerAddress.ADDRESS_FK);
}
private AddressEditPanel createAddressEditPanel() {
return new AddressEditPanel(new SwingEntityEditModel(Address.TYPE, editModel().connectionProvider()));
}
}
Detailed example
Here’s how a text field is created and added to the edit panel.
createTextField(Customer.FIRST_NAME)
.columns(12);
setLayout(gridLayout(1, 1));
addInputPanel(Customer.FIRST_NAME);
And here’s the equivilent code, showing what’s going on behind the scenes.
ColumnDefinition<String> firstNameDefinition =
editModel().entityDefinition().columns().definition(Customer.FIRST_NAME);
//create the text field
JTextField firstNameField = new JTextField();
firstNameField.setColumns(12);
firstNameDefinition.description()
.ifPresent(firstNameField::setToolTipText);
//associate the text field with the first name attribute
component(Customer.FIRST_NAME).set(firstNameField);
//wrap the text field in a ComponentValue
ComponentValue<String, JTextField> firstNameFieldValue =
new AbstractTextComponentValue<String, JTextField>(firstNameField) {
@Override
protected String getComponentValue() {
return component().getText();
}
@Override
protected void setComponentValue(String text) {
component().setText(text);
}
};
//link the component value to the attribute value in the editor
firstNameFieldValue.link(editModel().editor().value(Customer.FIRST_NAME));
//create the first name label
JLabel firstNameLabel = new JLabel(firstNameDefinition.caption());
//associate the label with the text field
firstNameLabel.setLabelFor(firstNameField);
//create an input panel, with the label and text field
JPanel firstNamePanel = new JPanel(borderLayout());
firstNamePanel.add(firstNameLabel, BorderLayout.NORTH);
firstNamePanel.add(firstNameField, BorderLayout.CENTER);
setLayout(gridLayout(1, 1));
add(firstNamePanel);
Input controls
Boolean
JCheckBox checkBox =
createCheckBox(Demo.BOOLEAN)
.build();
NullableCheckBox nullableCheckBox =
(NullableCheckBox) createCheckBox(Demo.BOOLEAN)
.nullable(true)
.build();
JComboBox<Item<Boolean>> comboBox =
createBooleanComboBox(Demo.BOOLEAN)
.build();
Foreign key
EntityComboBox comboBox =
createComboBox(Demo.FOREIGN_KEY)
.build();
EntitySearchField searchField =
createSearchField(Demo.FOREIGN_KEY)
.build();
//readOnly
JTextField textField =
createTextField(Demo.FOREIGN_KEY)
.build();
Temporal
TemporalField<LocalDateTime> textField =
(TemporalField<LocalDateTime>) createTextField(Demo.LOCAL_DATE)
.build();
TemporalField<LocalDate> localDateField =
createTemporalField(Demo.LOCAL_DATE)
.build();
TemporalFieldPanel<LocalDate> temporalPanel =
createTemporalFieldPanel(Demo.LOCAL_DATE)
.build();
Numerical
NumberField<Integer> integerField =
(NumberField<Integer>) createTextField(Demo.INTEGER)
.build();
integerField =
createIntegerField(Demo.INTEGER)
.build();
NumberField<Long> longField =
(NumberField<Long>) createTextField(Demo.LONG)
.build();
longField =
createLongField(Demo.LONG)
.build();
NumberField<Double> doubleField =
(NumberField<Double>) createTextField(Demo.DOUBLE)
.build();
doubleField =
createDoubleField(Demo.DOUBLE)
.build();
NumberField<BigDecimal> bigDecimalField =
(NumberField<BigDecimal>) createTextField(Demo.BIG_DECIMAL)
.build();
bigDecimalField =
createBigDecimalField(Demo.BIG_DECIMAL)
.build();
Text
JTextField textField =
createTextField(Demo.TEXT)
.build();
JFormattedTextField maskedField =
createMaskedTextField(Demo.FORMATTED_TEXT)
.mask("###:###")
.valueContainsLiteralCharacters(true)
.build();
JTextArea textArea =
createTextArea(Demo.LONG_TEXT)
.rowsColumns(5, 20)
.build();
TextFieldPanel inputPanel =
createTextFieldPanel(Demo.LONG_TEXT)
.build();
Selection
DefaultComboBoxModel<String> comboBoxModel =
new DefaultComboBoxModel<>(new String[] {"One", "Two"});
JComboBox<String> comboBox =
createComboBox(Demo.TEXT, comboBoxModel)
.editable(true)
.build();
Panels & labels
JLabel label = createLabel(Demo.TEXT)
.build();
JPanel inputPanel = createInputPanel(Demo.TEXT);
Advanced Patterns
Configuration Options
EntityEditPanel supports configuration via a lambda in the constructor:
class InvoiceEditPanel extends EntityEditPanel {
public InvoiceEditPanel(SwingEntityEditModel editModel) {
super(editModel, config ->
// Keep displaying newly inserted invoice since we'll continue
// working with it by adding invoice lines
config.clearAfterInsert(false));
}
@Override
protected void initializeUI() {
// UI setup
}
}
Focus Management
Configure the focus behaviour:
class CustomerEditPanel extends EntityEditPanel {
public CustomerEditPanel(SwingEntityEditModel editModel) {
super(editModel);
}
@Override
protected void initializeUI() {
focus().initial().set(Customer.FIRSTNAME);
focus().afterInsert().set(Customer.ADDRESS);
// Create your input components...
}
}
Inline Edit Panels with ComboBoxPanel
Create combo boxes with inline add/edit capabilities:
class TrackEditPanel extends EntityEditPanel {
public TrackEditPanel(SwingEntityEditModel editModel) {
super(editModel);
}
@Override
protected void initializeUI() {
createComboBoxPanel(Track.MEDIATYPE_FK, this::createMediaTypeEditPanel)
.preferredWidth(160)
.includeAddButton(true)
.includeEditButton(true);
createSearchFieldPanel(Track.MEDIATYPE_FK, this::createMediaTypeEditPanel)
.preferredWidth(160)
.includeAddButton(true)
.includeEditButton(true);
}
private EntityEditPanel createMediaTypeEditPanel() {
return new MediaTypeEditPanel(new SwingEntityEditModel(Chinook.MediaType.TYPE, editModel().connectionProvider()));
}
}
Custom Component Integration
Replace default components with custom ones:
class TrackEditPanel extends EntityEditPanel {
public TrackEditPanel(SwingEntityEditModel editModel) {
super(editModel);
}
@Override
protected void initializeUI() {
// Create a custom component
DurationComponentValue durationValue = createDurationComponent();
// Link it to the attribute value
editModel().editor().value(Track.MILLISECONDS).link(durationValue);
// And set the component it as the attribute component
component(Track.MILLISECONDS).set(durationValue.component());
}
private DurationComponentValue createDurationComponent() {
// Custom implementation
return new DurationComponentValue();
}
}
Keyboard Shortcuts and Actions
Add custom keyboard shortcuts for enhanced productivity:
class CustomerEditPanel extends EntityEditPanel {
public CustomerEditPanel(SwingEntityEditModel editModel) {
super(editModel);
}
@Override
protected void initializeUI() {
createTextField(Customer.STATE)
.keyEvent(KeyEvents.builder(VK_SPACE)
.modifiers(CTRL_DOWN_MASK)
.action(Control.action(this::selectStateFromExistingValues)));
}
private void selectStateFromExistingValues(ActionEvent event) {
JTextField stateField = (JTextField) event.getSource();
Dialogs.listSelectionDialog(editModel().connection().select(Customer.STATE))
.owner(stateField)
.selectSingle()
.ifPresent(stateField::setText);
}
}
Detail Panel Integration
EntityEditPanel can include detail panels for master-detail relationships:
class InvoiceEditPanel extends EntityEditPanel {
private final EntityPanel invoiceLinePanel;
public InvoiceEditPanel(SwingEntityEditModel editModel, SwingEntityModel invoiceLineModel) {
super(editModel, config -> config.clearAfterInsert(false));
this.invoiceLinePanel = createInvoiceLinePanel(invoiceLineModel);
}
@Override
protected void initializeUI() {
// Initialize main edit controls...
// Add detail panel
add(invoiceLinePanel, BorderLayout.SOUTH);
}
private EntityPanel createInvoiceLinePanel(SwingEntityModel invoiceLineModel) {
// Create and return invoice line panel
return new EntityPanel(invoiceLineModel);
}
}
1.3.3. EntityTablePanel
The EntityTablePanel provides a table view of entities.
Adding a print action
The most common place to add a custom control is the table popup menu, i.e. an action for printing reports or for acting on the selected rows. For the simplest case, where a single print action is required, a custom control can be associated with the PRINT ControlKey, this control will appear in the Print submenu in the table popup menu as well as on the table toolbar.
For more complex cases, where multiple print controls are required, custom controls can be associated with the PRINT_CONTROLS ControlKey.
public class CustomerTablePanel extends EntityTablePanel {
public CustomerTablePanel(SwingEntityTableModel tableModel) {
super(tableModel);
// associate a custom Control with the PRINT control key,
// which calls the viewCustomerReport method in this class,
// enabled only when the selection is not empty
control(PRINT).set(Control.builder()
.command(this::viewCustomerReport)
.caption("Customer report")
.smallIcon(FrameworkIcons.instance().print())
.enabled(tableModel().selection().empty().not())
.build());
}
private void viewCustomerReport() {
List<Entity> selectedCustomers = tableModel().selection().items().get();
if (selectedCustomers.isEmpty()) {
return;
}
Collection<String> customerIds = Entity.values(Customer.ID, selectedCustomers);
Map<String, Object> reportParameters = new HashMap<>();
reportParameters.put("CUSTOMER_IDS", customerIds);
JasperPrint customerReport = tableModel().connection()
.report(Customer.REPORT, reportParameters);
Dialogs.componentDialog(new JRViewer(customerReport))
.owner(this)
.modal(false)
.title("Customer Report")
.size(new Dimension(800, 600))
.show();
}
}
1.3.4. EntityPanel.Builder
Use the EntityPanel.Builder class to specify a EntityPanel class configuration, for panels that should not be initialized until used, such the lookup table panels.
private static List<EntityPanel.Builder> createLookupPanelBuilders() {
EntityPanel.Builder addressPanelBuilder =
EntityPanel.builder(Address.TYPE, connectionProvider -> {
SwingEntityModel addressModel =
new SwingEntityModel(Address.TYPE, connectionProvider);
return new EntityPanel(addressModel,
new AddressEditPanel(addressModel.editModel()));
});
return List.of(addressPanelBuilder);
}
1.3.5. EntityApplicationPanel
The EntityApplicationPanel class serves as the main application UI. When extending this class you must provide a constructor with a single application model parameter, as seen below.
public class StoreApplicationPanel extends EntityApplicationPanel<StoreApplicationModel> {
public StoreApplicationPanel(StoreApplicationModel applicationModel) {
super(applicationModel, createPanels(applicationModel), createLookupPanelBuilders());
}
private static List<EntityPanel> createPanels(StoreApplicationModel applicationModel) {
CustomerModel customerModel = (CustomerModel)
applicationModel.entityModels().get(Customer.TYPE);
CustomerAddressModel customerAddressModel = (CustomerAddressModel)
customerModel.detailModels().get(CustomerAddress.TYPE);
EntityPanel customerPanel = new EntityPanel(customerModel,
new CustomerEditPanel(customerModel.editModel()),
new CustomerTablePanel(customerModel.tableModel()));
EntityPanel customerAddressPanel = new EntityPanel(customerAddressModel,
new CustomerAddressEditPanel(customerAddressModel.editModel()));
customerPanel.detailPanels().add(customerAddressPanel);
return List.of(customerPanel);
}
private static List<EntityPanel.Builder> createLookupPanelBuilders() {
EntityPanel.Builder addressPanelBuilder =
EntityPanel.builder(Address.TYPE, connectionProvider -> {
SwingEntityModel addressModel =
new SwingEntityModel(Address.TYPE, connectionProvider);
return new EntityPanel(addressModel,
new AddressEditPanel(addressModel.editModel()));
});
return List.of(addressPanelBuilder);
}
public static void main(String[] args) {
Locale.setDefault(new Locale("en", "EN"));
EntityPanel.Config.TOOLBAR_CONTROLS.set(true);
ReferentialIntegrityErrorHandling.REFERENTIAL_INTEGRITY_ERROR_HANDLING
.set(ReferentialIntegrityErrorHandling.DISPLAY_DEPENDENCIES);
EntityApplicationPanel.builder(StoreApplicationModel.class, StoreApplicationPanel.class)
.applicationName("Store")
.domainType(Store.DOMAIN)
.defaultUser(User.parse("scott:tiger"))
.start();
}
}
1.3.6. EntitySearchField
The EntitySearchField is a powerful UI component for entity selection through text-based searching.
It extends HintTextField
and provides a search interface that triggers on ENTER key, displaying results based on the configured search criteria.
Overview
EntitySearchField
provides:
-
Text-based entity searching with automatic result handling
-
Single or multi-entity selection
-
Customizable result selection UI (list, table, or custom)
-
Optional add/edit functionality for creating or modifying entities
-
Search progress indication (wait cursor or progress bar)
-
Automatic search on focus loss (optional)
-
Keyboard shortcuts for add/edit operations
Basic Usage
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider)
.searchColumns(List.of(Customer.FIRSTNAME, Customer.EMAIL))
.build();
EntitySearchField searchField = EntitySearchField.builder(searchModel)
.multiSelection()
.columns(20)
.build();
Search Behavior
The search field operates as follows:
-
User types search text and presses ENTER
-
If the search returns:
-
No results: A message dialog is shown
-
Single result: That entity is automatically selected
-
Multiple results: A selection dialog appears
-
Note
|
Multi-selection is the default mode for EntitySearchModel . The .singleSelection(false) call in examples is shown for clarity but is not required.
|
Customization Options
Custom Selectors
The default selector uses a list for result selection. You can provide custom selectors:
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider).build();
EntitySearchField searchField = EntitySearchField.builder(searchModel)
.multiSelection()
.selectorFactory(EntitySearchField::tableSelector)
.build();
Add and Edit Controls
Enable inline entity creation and editing:
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider).build();
SwingEntityEditModel editModel = new SwingEntityEditModel(Customer.TYPE, connectionProvider);
EntitySearchField searchField = EntitySearchField.builder(searchModel)
.singleSelection()
.editPanel(() -> new CustomerEditPanel(editModel))
.confirmAdd(true) // Confirm before adding
.confirmEdit(true) // Confirm before editing
.build();
// Access controls
searchField.addControl(); // INSERT key by default
searchField.editControl(); // CTRL+INSERT by default
Search Indicators
Configure how search progress is displayed:
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider).build();
EntitySearchField searchField = EntitySearchField.builder(searchModel)
.multiSelection()
.searchIndicator(SearchIndicator.PROGRESS_BAR)
.build();
Field Configuration
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider).build();
EntitySearchField searchField = EntitySearchField.builder(searchModel)
.singleSelection()
.columns(20) // Field width
.upperCase(true) // Force uppercase
.searchHintEnabled(true) // Show "Search..." hint
.searchOnFocusLost(true) // Auto-search when focus lost
.selectionToolTip(true) // Show selection as tooltip
.editable(false) // Make read-only
.stringFactory(entity -> // Custom display text
entity.get(Customer.LASTNAME) + " - " + entity.get(Customer.CITY))
.separator(" | ") // Multi-selection separator
.build();
Search Control
You can trigger searches programmatically:
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider).build();
EntitySearchField searchField = EntitySearchField.builder(searchModel)
.multiSelection()
.build();
// Get search control
Control searchControl = searchField.searchControl();
// Use in toolbar or menu
Controls.builder()
.control(searchControl)
.build();
Advanced Features
Component Value Integration
A EntitySearchField
based ComponentValue
can be created via buildValue():
EntitySearchModel searchModel = EntitySearchModel.builder(Customer.TYPE, connectionProvider).build();
SwingEntityEditModel editModel = new SwingEntityEditModel(Invoice.TYPE, connectionProvider);
ComponentValue<Entity, EntitySearchField> searchFieldValue =
EntitySearchField.builder(searchModel)
.singleSelection()
.buildValue();
EntitySearchField searchField = searchFieldValue.component();
// React to selection changes
searchField.model().selection().entities().addConsumer(selectedEntities ->
System.out.println("Selected: " + selectedEntities));
// Link to edit model
editModel.editor().value(Invoice.CUSTOMER_FK).link(searchFieldValue);
Custom Edit Component Factory
Use custom search fields in edit panels:
class TrackEditComponentFactory extends DefaultEditComponentFactory<Entity, EntitySearchField> {
@Override
protected EntitySearchField.SingleSelectionBuilder searchField(
ForeignKey foreignKey,
EntityDefinition entityDefinition,
EntitySearchModel searchModel) {
return super.searchField(foreignKey, entityDefinition, searchModel)
.selectorFactory(new TrackSelectorFactory());
}
}
Configuration Properties
Property | Default | Description |
---|---|---|
|
WAIT_CURSOR |
How to indicate ongoing searches (WAIT_CURSOR or PROGRESS_BAR) |
Best Practices
-
Provide Clear Search Columns: Configure the search model with appropriate searchable columns
-
Consider Performance: Use result limits in the search model for large datasets
-
Keyboard Support: Leverage the built-in keyboard shortcuts (INSERT for add, CTRL+INSERT for edit)
-
Custom Selectors: Create custom selectors for complex selection scenarios
1.3.7. Reporting with JasperReports
Codion uses a plugin oriented approach to report viewing and provides an implementation for JasperReports.
With the Codion JasperReports plugin you can either design your report based on an SQL query in which case you use the JRReport class, which facilitates the report being filled using the active database connection, or you can design your report around the JRDataSource implementation provided by the JasperReportsDataSource class, which is constructed around an iterator.
JDBC Reports
Using a report based on an SQL query is the simplest way of viewing a report using Codion, just add a method similar to the one below to a EntityTablePanel subclass. You can then create an action calling that method and put it in for example the table popup menu as described in the adding a print action section.
public class CustomerTablePanel extends EntityTablePanel {
public CustomerTablePanel(SwingEntityTableModel tableModel) {
super(tableModel);
// associate a custom Control with the PRINT control key,
// which calls the viewCustomerReport method in this class,
// enabled only when the selection is not empty
control(PRINT).set(Control.builder()
.command(this::viewCustomerReport)
.caption("Customer report")
.smallIcon(FrameworkIcons.instance().print())
.enabled(tableModel().selection().empty().not())
.build());
}
private void viewCustomerReport() {
List<Entity> selectedCustomers = tableModel().selection().items().get();
if (selectedCustomers.isEmpty()) {
return;
}
Collection<String> customerIds = Entity.values(Customer.ID, selectedCustomers);
Map<String, Object> reportParameters = new HashMap<>();
reportParameters.put("CUSTOMER_IDS", customerIds);
JasperPrint customerReport = tableModel().connection()
.report(Customer.REPORT, reportParameters);
Dialogs.componentDialog(new JRViewer(customerReport))
.owner(this)
.modal(false)
.title("Customer Report")
.size(new Dimension(800, 600))
.show();
}
}
JRDataSource Reports
The JRDataSource implementation provided by the JasperReportsDataSource simply iterates through the iterator received via the constructor and retrieves the field values from the underlying entities. The easiest way to make this work is to design the report using field names that correspond to the attribute names, so using the Store domain example from above the fields in a report showing the available items would have to be named 'name', 'active', 'category_code' etc.
EntityConnection connection = connectionProvider.connection();
EntityDefinition customerDefinition =
connection.entities().definition(Customer.TYPE);
Iterator<Entity> customerIterator =
connection.select(all(Customer.TYPE)).iterator();
JasperReportsDataSource<Entity> dataSource =
new JasperReportsDataSource<>(customerIterator,
(entity, reportField) ->
entity.get(customerDefinition.attributes().get(reportField.getName())));
JRReport customerReport = fileReport("reports/customer.jasper");
JasperPrint jasperPrint = JasperReports.fillReport(customerReport, dataSource);
2. Common
2.1. Common Core
2.1.1. Core classes
Three common classes used throughout the framework are Event, State and Value and their respective observers Observer and ObservableState.
Event
The Event class is a synchronous event implementation used throughout the framework. Classes typically expose observers for their events via public accessors. Events are triggered by calling the run method in case no data is associated with the event or accept in case data should be propogated to consumers.
The associated Observer instance can not trigger the event and can be safely passed around.
Event listeners must implement either Runnable or Consumer, depending on whether they are interested in the data associated with the event.
Note
|
Both listeners and consumer are notified each time the event is triggered, regardless of whether run or accept is used, listeners and consumers are notified in the order they were added. |
Events are instantiated via factory methods in the Event class.
// specify an event propagating
// a String as the event data
Event<String> event = Event.event();
// an observer manages the listeners
// for an Event but can not trigger it
Observer<String> observer = event.observer();
// add a listener if you're not
// interested in the event data
observer.addListener(() -> System.out.println("Event occurred"));
event.run();//output: 'Event occurred'
// or a consumer if you're
// interested in the event data
observer.addConsumer(data -> System.out.println("Event: " + data));
event.accept("info");//output: 'Event: info'
// Event implements Observer so
// listeneres can be added directly without
// referring to the Observer
event.addConsumer(System.out::println);
Value
A Value wraps a value and provides a change observer.
Values are instantiated via factory methods in the Value class.
Values can be linked so that changes in one are reflected in the other.
// a nullable value with 2 as the initial value
Value<Integer> value =
Value.nullable(2);
value.set(4);
// a non-null value using 0 as null substitute
Value<Integer> otherValue =
Value.nonNull(0);
// linked to the value above
value.link(otherValue);
System.out.println(otherValue.get());// output: 4
otherValue.set(3);
System.out.println(value.get());// output: 3
value.addConsumer(System.out::println);
otherValue.addListener(() ->
System.out.println("Value changed: " + otherValue.get()));
Values can be non-nullable if a nullValue is specified when the value is initialized. Null is then translated to the nullValue when set.
Integer initialValue = 42;
Integer nullValue = 0;
Value<Integer> value =
Value.builder()
.nonNull(nullValue)
.value(initialValue)
.build();
System.out.println(value.isNullable());//output: false
System.out.println(value.get());// output: 42
value.set(null); //or value.clear();
System.out.println(value.get());//output: 0
State
The State class encapsulates a boolean state and provides read only access and a change observer via ObservableState. A State implements Value<Boolean> and is non-nullable with null translating to false.
States are instantiated via factory methods in the State class.
// a boolean state, false by default
State state = State.state();
// an observable manages the listeners for a State but can not modify it
ObservableState observable = state.observable();
// a not observable is always available, which is
// always the reverse of the original state
ObservableState not = state.not();
// add a listener notified each time the state changes
observable.addListener(() -> System.out.println("State changed"));
state.set(true);//output: 'State changed'
observable.addConsumer(value -> System.out.println("State: " + value));
state.set(null);//output: 'State: false'
// State extends ObservableState so listeners can be added
// directly without referring to the ObservableState
state.addListener(() -> System.out.println("State changed"));
private static final class IntegerValue {
private final State negative = State.state(false);
private final Value<Integer> integer = Value.builder()
.nonNull(0)
.consumer(value -> negative.set(value < 0))
.build();
/**
* Increment the value by one
*/
public void increment() {
integer.map(value -> value + 1);
}
/**
* Decrement the value by one
*/
public void decrement() {
integer.map(value -> value - 1);
}
/**
* @return an observer notified each time the value changes
*/
public Observer<Integer> changed() {
return integer.observable();
}
/**
* @return a state observer indicating whether the value is negative
*/
public ObservableState negative() {
return negative.observable();
}
}
Any Action object can be linked to a State instance via the Utilities.linkToEnabledState method, where the action’s enabled status is updated according to the state.
State state = State.state();
Action action = new AbstractAction("action") {
@Override
public void actionPerformed(ActionEvent e) {
System.out.println("Hello Action");
}
};
Utilities.enableActions(state, action);
System.out.println(action.isEnabled());// output: false
state.set(true);
System.out.println(action.isEnabled());// output: true
Controls can also be linked to a State instance.
State state = State.state();
CommandControl control = Control.builder()
.command(() -> System.out.println("Hello Control"))
.enabled(state)
.build();
System.out.println(control.isEnabled());// output: false
state.set(true);
System.out.println(control.isEnabled());// output: true
Note
|
When a State or Event is linked to a Swing component, for example its enabled state, all state changes must happen on the Event Dispatch Thread. |
2.2. Common Database
The core JDBC related classes.
2.2.1. Common classes
Two common classes used throughout the framework are the Database and DatabaseConnection classes.
Database
The Database class represents a DBMS instance and provides connections to that instance.
There are multiple ways to aquire a Database instance.
-
By specifying a JDBC url via a system property.
System.setProperty("codion.db.url", "jdbc:h2:mem:h2db");
Database database = Database.instance();
-
By setting the JDBC url configuration value directly (which also sets the system property).
Database.DATABASE_URL.set("jdbc:h2:mem:h2db");
Database database = Database.instance();
-
By instantiating a DatabaseFactory directly.
String url = "jdbc:h2:mem:h2db";
DatabaseFactory databaseFactory = DatabaseFactory.instance(url);
Database database = databaseFactory.create(url);
-
By instantiating a DBMS specific DatabaseFactory directly.
String url = "jdbc:h2:mem:h2db";
H2DatabaseFactory databaseFactory = new H2DatabaseFactory();
Database database = databaseFactory.create(url);
A Database instance provides java.sql.Connection instances via the createConnection method.
Database.DATABASE_URL.set("jdbc:h2:mem:h2db");
Database database = Database.instance();
User user = User.parse("scott:tiger");
java.sql.Connection connection = database.createConnection(user);
DatabaseConnection
The DatabaseConnection class represents a connection to a database instance and is a wrapper around a java.sql.Connection instance and provides transaction control.
A DatabaseConnection instance is created via the databaseConnection factory methods.
Database.DATABASE_URL.set("jdbc:h2:mem:h2db");
Database database = Database.instance();
User user = User.parse("scott:tiger");
DatabaseConnection databaseConnection =
DatabaseConnection.databaseConnection(database, user);
databaseConnection.startTransaction();
try {
java.sql.Connection connection = databaseConnection.getConnection();
connection.createStatement().execute("select 1");
databaseConnection.commitTransaction();
}
catch (SQLException e) {
databaseConnection.rollbackTransaction();
throw new DatabaseException(e);
}
catch (Exception e) {
databaseConnection.rollbackTransaction();
throw new RuntimeException(e);
}
databaseConnection.close();
2.3. Common Model
2.3.1. Table Model
FilterTableModel
The FilterTableModel is a table model central to the framework.
// Define a record representing the table rows
public record Person(String name, int age) {
// Constants identifying the table columns
public static final String NAME = "Name";
public static final String AGE = "Age";
}
// Implement TableColumns, which specifies the column identifiers,
// the column class and how to extract column values from row objects
public static final class PersonColumns implements TableColumns<Person, String> {
private static final List<String> COLUMNS = List.of(NAME, AGE);
@Override
public List<String> identifiers() {
return COLUMNS;
}
@Override
public Class<?> columnClass(String column) {
return switch (column) {
case NAME -> String.class;
case AGE -> Integer.class;
default -> throw new IllegalArgumentException();
};
}
@Override
public Object value(Person person, String column) {
return switch (column) {
case NAME -> person.name();
case AGE -> person.age();
default -> throw new IllegalArgumentException();
};
}
}
// Implement a RowEditor for handling row edits
private static final class PersonEditor implements RowEditor<Person, String> {
// We need the underlying VisibleItems instance to replace the edited
// row since the row objects are records and thereby immutable
private final VisibleItems<Person> items;
private PersonEditor(FilterTableModel<Person, String> tableModel) {
this.items = tableModel.items().visible();
}
@Override
public boolean editable(Person person, String identifier) {
// Both columns editable
return true;
}
@Override
public void set(Object value, int rowIndex, Person person, String identifier) {
switch (identifier) {
case NAME -> items.set(rowIndex, new Person((String) value, person.age()));
case AGE -> items.set(rowIndex, new Person(person.name(), (Integer) value));
}
}
}
// Implement an item supplier responsible for supplying
// the data when the table items are refreshed.
// Without one the model can be populated by adding items manually
Supplier<Collection<Person>> supplier = () -> List.of(
new Person("John", 42),
new Person("Mary", 43),
new Person("Andy", 33),
new Person("Joan", 37));
// Build the table model, providing the TableColumns
// implementation along with the item supplier and row editor.
FilterTableModel<Person, String> tableModel =
FilterTableModel.builder(new PersonColumns())
.supplier(supplier)
.rowEditor(PersonEditor::new)
.build();
// Populate the model
tableModel.items().refresh();
Selection
FilterListSelection<Person> selection = tableModel.selection();
// Print the selected items when they change
selection.items().addConsumer(System.out::println);
// Print a message when the minimum selected index changes
selection.index().addListener(() ->
System.out.println("Selected index changed"));
// Select the first row
selection.index().set(0);
// Select the first two rows
selection.indexes().set(List.of(0, 1));
// Fetch the selected items
List<Person> items = selection.items().get();
// Or just the first (minimum index)
Person item = selection.item().get();
// Select a specific person
selection.item().set(new Person("John", 42));
// Select all persons over 40
selection.items().set(person -> person.age() > 40);
// Increment all selected indexes by
// one, moving the selection down
selection.indexes().increment();
// Clear the selection
selection.clear();
Filters
TableConditionModel<String> filters = tableModel.filters();
// Filter out people under 40 years old
ConditionModel<Integer> ageFilter = filters.get(Person.AGE);
ageFilter.set().greaterThanOrEqualTo(40);
// Not necessary since filters auto-enable by default
// when operators and operands are specified
ageFilter.enabled().set(true);
// Filter is automatically disabled when it is cleared
ageFilter.clear();
// Filter out anyone besides John and Joan
ConditionModel<String> nameFilter = filters.get(NAME);
nameFilter.caseSensitive().set(false);
nameFilter.set().equalTo("jo%");
// Clear all filters
filters.clear();
Sorting
FilterTableSort<Person, String> sort = tableModel.sort();
// Sort by age and name, ascending
sort.ascending(AGE, NAME);
// Sort by age, descending,
// set() clears the previous sort
sort.order(AGE).set(DESCENDING);
// add sorting by name, ascending,
// add() adds to any previous sort
sort.order(NAME).add(ASCENDING);
// Clear the sorting
sort.clear();
2.4. Common UI
2.4.1. Table UI
FilterTable
The FilterTable is a JTable subclass central to the framework.
// See FilterTableModel example
FilterTableModel<Person, String> tableModel = createFilterTableModel();
// Create the columns, specifying the identifier and the model index
List<FilterTableColumn<String>> columns = List.of(
FilterTableColumn.builder(Person.NAME, 0).build(),
FilterTableColumn.builder(Person.AGE, 1).build());
FilterTable<Person, String> table =
FilterTable.builder(tableModel, columns)
.doubleClick(Control.command(() ->
tableModel.selection().item().optional()
.ifPresent(System.out::println)))
.autoResizeMode(JTable.AUTO_RESIZE_ALL_COLUMNS)
.build();
Columns
FilterTableColumnModel<String> columns = table.columnModel();
// Reorder the columns
columns.visible().set(Person.AGE, Person.NAME);
// Print hidden columns when they change
columns.hidden().addConsumer(System.out::println);
// Hide the age column
columns.visible(Person.AGE).set(false);
// Only show the age column
columns.visible().set(Person.AGE);
// Reset columns to their default location and visibility
columns.reset();
Search
FilterTableSearchModel search = table.search();
// Search for the value "43" in the table
search.predicate().set(value -> value.equals("43"));
RowColumn searchResult = search.results().current().get();
System.out.println(searchResult); // row: 1, column: 1
// Print the next available result
search.results().next().ifPresent(System.out::println);
2.4.2. Input Controls
Control
State somethingEnabledState = State.state(true);
CommandControl control = Control.builder()
.command(() -> System.out.println("Doing something"))
.caption("Do something")
.mnemonic('D')
.enabled(somethingEnabledState)
.build();
JButton somethingButton = new JButton(control);
Control.ActionCommand actionCommand = actionEvent -> {
if ((actionEvent.getModifiers() & ActionEvent.SHIFT_MASK) != 0) {
System.out.println("Doing something else");
}
};
CommandControl actionControl = Control.builder()
.action(actionCommand)
.caption("Do something else")
.mnemonic('S')
.build();
JButton somethingElseButton = new JButton(actionControl);
ToggleControl
State state = State.state();
ToggleControl toggleStateControl = Control.builder()
.toggle(state)
.build();
JToggleButton toggleButton = Components.toggleButton()
.toggleControl(toggleStateControl)
.text("Change state")
.mnemonic('C')
.build();
Value<Boolean> booleanValue = Value.nonNull(false);
ToggleControl toggleValueControl = Control.builder()
.toggle(booleanValue)
.build();
JCheckBox checkBox = Components.checkBox()
.toggleControl(toggleValueControl)
.text("Change value")
.mnemonic('V')
.build();
Controls
Controls controls = Controls.builder()
.control(Control.builder()
.command(this::doFirst)
.caption("First")
.mnemonic('F'))
.control(Control.builder()
.command(this::doSecond)
.caption("Second")
.mnemonic('S'))
.control(Controls.builder()
.caption("Submenu")
.control(Control.builder()
.command(this::doSubFirst)
.caption("Sub-first")
.mnemonic('b'))
.control(Control.builder()
.command(this::doSubSecond)
.caption("Sub-second")
.mnemonic('u')))
.build();
JMenu menu = Components.menu(controls).build();
Control firstControl = Control.builder()
.command(this::doFirst)
.caption("First")
.mnemonic('F')
.build();
Control secondControl = Control.builder()
.command(this::doSecond)
.caption("Second")
.mnemonic('S')
.build();
Controls twoControls = Controls.builder()
.controls(firstControl, secondControl)
.build();
JPanel buttonPanel = Components.buttonPanel(twoControls).build();
2.4.3. Input Components
Binding model data to UI components is accomplished by linking a Value instance to an instance of its subclass ComponentValue, which represents a value based on an input component.
//a nullable integer value, initialized to 42
Value<Integer> integerValue =
Value.nullable(42);
//create a spinner linked to the value
JSpinner spinner =
Components.integerSpinner(integerValue)
.build();
//create a NumberField component value, basically doing the same as
//the above, with an extra step to expose the underlying ComponentValue
ComponentValue<Integer, NumberField<Integer>> numberFieldValue =
Components.integerField()
//linked to the same value
.link(integerValue)
.buildValue();
//fetch the input field from the component value
NumberField<Integer> numberField = numberFieldValue.component();
Text
TextField
Value<String> stringValue = Value.nullable();
JTextField textField =
Components.stringField(stringValue)
.preferredWidth(120)
.transferFocusOnEnter(true)
.build();
Value<Character> characterValue = Value.nullable();
JTextField textField =
Components.characterField(characterValue)
.preferredWidth(120)
.transferFocusOnEnter(true)
.build();
Numbers
Integer
Value<Integer> integerValue = Value.nullable();
NumberField<Integer> integerField =
Components.integerField(integerValue)
.valueRange(0, 10_000)
.groupingUsed(false)
.build();
Long
Value<Long> longValue = Value.nullable();
NumberField<Long> longField =
Components.longField(longValue)
.groupingUsed(true)
.build();
Date & Time
LocalTime
Value<LocalTime> localTimeValue = Value.nullable();
TemporalField<LocalTime> temporalField =
Components.localTimeField(localTimeValue)
.dateTimePattern("HH:mm:ss")
.build();
Boolean
CheckBox
//non-nullable so use this value instead of null
boolean nullValue = false;
Value<Boolean> booleanValue =
Value.builder()
.nonNull(nullValue)
.value(true)
.build();
JCheckBox checkBox =
Components.checkBox(booleanValue)
.text("Check")
.horizontalAlignment(SwingConstants.CENTER)
.build();
Selection
ComboBox
Value<String> stringValue = Value.nullable();
DefaultComboBoxModel<String> comboBoxModel =
new DefaultComboBoxModel<>(new String[] {"one", "two", "three"});
JComboBox<String> comboBox =
Components.comboBox(comboBoxModel, stringValue)
.preferredWidth(160)
.build();
Supplier<Collection<String>> items = () ->
List.of("One", "Two", "Three");
FilterComboBoxModel<String> model =
FilterComboBoxModel.builder(items)
.nullItem("-")
.build();
JComboBox<String> comboBox =
Components.comboBox(model)
.mouseWheelScrolling(true)
.build();
// Hides the 'Two' item.
model.items().visible().predicate()
.set(item -> !item.equals("Two"));
// Prints the selected item
model.selection().item()
.addConsumer(System.out::println);
// Refreshes the items using the supplier from above
model.items().refresh();
Completion provides a way to enable completion for combo boxes.
The available completion modes are:
Combo boxes created via Components have completion enabled by default, with MAXIMUM_MATCH being the default completion mode.
The default completion mode is controlled via the Completion.COMPLETION_MODE configuration value.
Strings are normalized by default during completion, that is, accents are removed, i.e. á, í and ú become a, i and u. To enable accented character sensitivity, normalization can be turned off, either globally via the Completion.NORMALIZE configuration value or individually via the combo box builder.
FilterComboBoxModel<String> model =
FilterComboBoxModel.builder(List.of("Jon", "Jón", "Jónsi"))
.nullItem("-")
.build();
JComboBox<String> comboBox =
Components.comboBox(model)
// Auto completion
.completionMode(Completion.Mode.AUTOCOMPLETE)
// Accented characters not normalized
.normalize(false)
.build();
Custom
TextField
In the following example we link a value based on a Person class to a component value displaying text fields for a first and last name.
class Person {
final String firstName;
final String lastName;
public Person(String firstName, String lastName) {
this.firstName = firstName;
this.lastName = lastName;
}
@Override
public String toString() {
return lastName + ", " + firstName;
}
}
class PersonPanel extends JPanel {
final JTextField firstNameField = new JTextField();
final JTextField lastNameField = new JTextField();
public PersonPanel() {
setLayout(new GridLayout(2, 2));
add(new JLabel("First name"));
add(new JLabel("Last name"));
add(firstNameField);
add(lastNameField);
}
}
class PersonPanelValue extends AbstractComponentValue<Person, PersonPanel> {
public PersonPanelValue(PersonPanel component) {
super(component);
//We must call notifyListeners() each time this value changes,
//that is, when either the first or last name changes.
component.firstNameField.getDocument()
.addDocumentListener((DocumentAdapter) e -> notifyListeners());
component.lastNameField.getDocument()
.addDocumentListener((DocumentAdapter) e -> notifyListeners());
}
@Override
protected Person getComponentValue() {
return new Person(component().firstNameField.getText(), component().lastNameField.getText());
}
@Override
protected void setComponentValue(Person value) {
component().firstNameField.setText(value == null ? null : value.firstName);
component().lastNameField.setText(value == null ? null : value.lastName);
}
}
Value<Person> personValue = Value.nullable();
PersonPanel personPanel = new PersonPanel();
Value<Person> personPanelValue = new PersonPanelValue(personPanel);
personPanelValue.link(personValue);
2.4.4. ProgressWorker
ProgressWorker is a SwingWorker extension, providing a fluent API for constructing background task workers for a variety of task types.
All handlers get called on the EventDispatchThread.
Note
|
Like SwingWorker, ProgressWorker instances can not be reused. Tasks, on the other hand, can be made stateful and reusable if required. |
Task
// A non-progress aware task, producing no result
ProgressWorker.Task task = () -> {
// Perform the task
};
ProgressWorker.builder(task)
.onException(exception ->
exceptionDialog()
.owner(applicationFrame)
.show(exception))
.execute();
ResultTask
// A non-progress aware task, producing a result
ProgressWorker.ResultTask<String> task = () -> {
// Perform the task
return "Result";
};
ProgressWorker.builder(task)
.onResult(result ->
showMessageDialog(applicationFrame, result))
.onException(exception ->
exceptionDialog()
.owner(applicationFrame)
.show(exception))
.execute();
ProgressTask
// A progress aware task, producing no result
ProgressWorker.ProgressTask<String> task = progressReporter -> {
// Perform the task
progressReporter.report(42);
progressReporter.publish("Message");
};
ProgressWorker.builder(task)
.onProgress(progress ->
System.out.println("Progress: " + progress))
.onPublish(message ->
showMessageDialog(applicationFrame, message))
.onException(exception ->
exceptionDialog()
.owner(applicationFrame)
.show(exception))
.execute();
ProgressResultTask
// A reusable, cancellable task, producing a result.
// Displays a progress bar in a dialog while running.
var task = new DemoProgressResultTask();
ProgressWorker.builder(task.prepare(142))
.onStarted(task::started)
.onProgress(task::progress)
.onPublish(task::publish)
.onDone(task::done)
.onCancelled(task::cancelled)
.onException(task::failed)
.onResult(task::finished)
.execute();
static final class DemoProgressResultTask implements ProgressResultTask<Integer, String> {
private final JProgressBar progressBar = progressBar()
.indeterminate(false)
.stringPainted(true)
.string("")
.build();
// Indicates whether the task has been cancelled
private final AtomicBoolean cancelled = new AtomicBoolean();
// A Control for setting the cancelled state
private final Control cancel = Control.builder()
.command(() -> cancelled.set(true))
.caption("Cancel")
.mnemonic('C')
.build();
// A panel containing the progress bar and cancel button
private final JPanel progressPanel = borderLayoutPanel()
.centerComponent(progressBar)
.eastComponent(button(cancel).build())
.build();
// The dialog displaying the progress panel
private final JDialog dialog = componentDialog(progressPanel)
.owner(applicationFrame)
// Trigger the cancel control with the Escape key
.keyEvent(KeyEvents.builder(VK_ESCAPE)
.action(cancel))
// Prevent the dialog from closing on Escape
.disposeOnEscape(false)
.build();
private int taskSize;
@Override
public int maximumProgress() {
return taskSize;
}
@Override
public Integer execute(ProgressReporter<String> progressReporter) throws Exception {
List<Integer> result = new ArrayList<>();
for (int i = 0; i < taskSize; i++) {
Thread.sleep(50);
if (cancelled.get()) {
throw new CancelException();
}
result.add(i);
reportProgress(progressReporter, i);
}
return result.stream()
.mapToInt(Integer::intValue)
.sum();
}
// Makes this task reusable by resetting the internal state
private DemoProgressResultTask prepare(int taskSize) {
this.taskSize = taskSize;
progressBar.getModel().setMaximum(taskSize);
cancelled.set(false);
return this;
}
private void reportProgress(ProgressReporter<String> reporter, int progress) {
reporter.report(progress);
if (progress < taskSize * 0.5) {
reporter.publish("Going strong");
}
else if (progress > taskSize * 0.5 && progress < taskSize * 0.85) {
reporter.publish("Half way there");
}
else if (progress > taskSize * 0.85) {
reporter.publish("Almost done");
}
}
private void started() {
dialog.setVisible(true);
}
private void progress(int progress) {
progressBar.setValue(progress);
}
private void publish(List<String> strings) {
progressBar.setString(strings.get(0));
}
private void done() {
dialog.setVisible(false);
}
private void cancelled() {
showMessageDialog(applicationFrame, "Cancelled");
}
private void failed(Exception exception) {
exceptionDialog()
.owner(applicationFrame)
.show(exception);
}
private void finished(Integer result) {
showMessageDialog(applicationFrame, "Result : " + result);
}
}