JMinor Application Framework

As simple as possible but not simpler

User Tools

Site Tools

Trace: • world

Sidebar

Download

Documentation

Tutorials

Technical

Quality

Misc

documentation:tutorials:world

Table of Contents

World: Application tutorial

Run the application

Web Start

World (Web Start)

You'll need to add http://jminor.no-ip.org to the Java exception site list.

Getdown

empdept-getdown.zip

Zip file containing the necessary files for running with Getdown.

Local JAR file

world.zip

Zip file containing a jar file along with an assortment of launch files for running the application without WebStart. Note that the remote configurations all assume the server is running on localhost.

Data

World database

Domain model

File: org/jminor/framework/demos/world/domain/World.java - 

/*
 * Copyright (c) 2004 - 2019, Björn Darri Sigurðsson. All Rights Reserved.
 */
package org.jminor.framework.demos.world.domain;
 
import org.jminor.framework.domain.Domain;
import org.jminor.framework.domain.Entity;
 
import java.awt.Color;
import java.sql.Types;
 
import static java.text.NumberFormat.getIntegerInstance;
import static java.text.NumberFormat.getNumberInstance;
import static org.jminor.common.Util.notNull;
import static org.jminor.framework.domain.property.Properties.*;
 
// tag::entityAndPropertyIds[]
public final class World extends Domain {
 
  public static final String T_CITY = "world.city";
  public static final String CITY_ID = "id";
  public static final String CITY_NAME = "name";
  public static final String CITY_COUNTRYCODE = "countrycode";
  public static final String CITY_COUNTRY_FK = "country_fk";
  public static final String CITY_DISTRICT = "district";
  public static final String CITY_POPULATION = "population";
 
  public static final String T_COUNTRY = "world.country";
  public static final String COUNTRY_CODE = "code";
  public static final String COUNTRY_NAME = "name";
  public static final String COUNTRY_CONTINENT = "continent";
  public static final String COUNTRY_REGION = "region";
  public static final String COUNTRY_SURFACEAREA = "surfacearea";
  public static final String COUNTRY_INDEPYEAR = "indepyear";
  public static final String COUNTRY_POPULATION = "population";
  public static final String COUNTRY_LIFEEXPECTANCY = "lifeexpectancy";
  public static final String COUNTRY_GNP = "gnp";
  public static final String COUNTRY_GNPOLD = "gnpold";
  public static final String COUNTRY_LOCALNAME = "localname";
  public static final String COUNTRY_GOVERNMENTFORM = "governmentform";
  public static final String COUNTRY_HEADOFSTATE = "headofstate";
  public static final String COUNTRY_CAPITAL = "capital";
  public static final String COUNTRY_CAPITAL_FK = "capital_fk";
  public static final String COUNTRY_CODE2 = "code2";
  public static final String COUNTRY_CAPITAL_POPULATION = "capital_population";
 
  public static final String T_COUNTRYLANGUAGE = "world.countrylanguage";
  public static final String COUNTRYLANGUAGE_COUNTRYCODE = "countrycode";
  public static final String COUNTRYLANGUAGE_COUNTRY_FK = "country_fk";
  public static final String COUNTRYLANGUAGE_LANGUAGE = "language";
  public static final String COUNTRYLANGUAGE_ISOFFICIAL = "isofficial";
  public static final String COUNTRYLANGUAGE_PERCENTAGE = "percentage";
  public static final String COUNTRYLANGUAGE_NO_OF_SPEAKERS = "no_of_speakers";
  // end::entityAndPropertyIds[]
 
  public World() {
    //disable this default check so we can define a foreign key relation
    //from country to city without having defined the city entity
    Entity.Definition.STRICT_FOREIGN_KEYS.set(false);
 
    city();
    country();
    countryLanguage();
  }
 
  // tag::defineCity[]
  void city() {
    define(T_CITY,
            primaryKeyProperty(CITY_ID),
            columnProperty(CITY_NAME, Types.VARCHAR, "Name")
                    .setNullable(false)
                    .setMaxLength(35),
            foreignKeyProperty(CITY_COUNTRY_FK, "Country", T_COUNTRY,
                    columnProperty(CITY_COUNTRYCODE, Types.VARCHAR))
                    .setNullable(false),
            columnProperty(CITY_DISTRICT, Types.VARCHAR, "District")
                    .setNullable(false)
                    .setMaxLength(20),
            columnProperty(CITY_POPULATION, Types.INTEGER, "Population")
                    .setNullable(false)
                    .setFormat(getIntegerInstance()))
            .setKeyGenerator(sequenceKeyGenerator("world.city_seq"))
            .setOrderBy(orderBy().ascending(CITY_NAME))
            .setSearchPropertyIds(CITY_NAME)
            .setStringProvider(new StringProvider(CITY_NAME))
            // tag::colorProvider[]
            .setColorProvider((entity, property) -> {
              if (property.is(CITY_POPULATION) &&
                      entity.getInteger(CITY_POPULATION) > 1_000_000) {
                return Color.BLUE;
              }
 
              return null;
            })
            // end::colorProvider[]
            .setCaption("City");
  }
  // end::defineCity[]
 
  void country() {
    define(T_COUNTRY,
            // tag::primaryKey[]
            primaryKeyProperty(COUNTRY_CODE, Types.VARCHAR, "Country code")
                    .setUpdatable(true)
                    .setMaxLength(3),
            // end::primaryKey[]
            columnProperty(COUNTRY_NAME, Types.VARCHAR, "Name")
                    .setNullable(false)
                    .setMaxLength(52),
            columnProperty(COUNTRY_CONTINENT, Types.VARCHAR, "Continent")
                    .setNullable(false)
                    .setMaxLength(20),
            // tag::columnProperty[]
            columnProperty(COUNTRY_REGION, Types.VARCHAR, "Region")
                    .setNullable(false),
            columnProperty(COUNTRY_SURFACEAREA, Types.DOUBLE, "Surface area")
                    .setNullable(false)
                    .setFormat(getNumberInstance())
                    .setMaximumFractionDigits(2),
            columnProperty(COUNTRY_INDEPYEAR, Types.INTEGER, "Indep. year")
                    .setMin(-200).setMax(2500),
            columnProperty(COUNTRY_POPULATION, Types.INTEGER, "Population")
                    .setNullable(false)
                    .setFormat(getIntegerInstance()),
            columnProperty(COUNTRY_LIFEEXPECTANCY, Types.DOUBLE, "Life expectancy")
                    .setMaximumFractionDigits(1)
                    .setMin(0).setMax(99),
            // end::columnProperty[]
            columnProperty(COUNTRY_GNP, Types.DOUBLE, "GNP")
                    .setFormat(getNumberInstance())
                    .setMaximumFractionDigits(2),
            columnProperty(COUNTRY_GNPOLD, Types.DOUBLE, "GNP old")
                    .setFormat(getNumberInstance())
                    .setMaximumFractionDigits(2),
            columnProperty(COUNTRY_LOCALNAME, Types.VARCHAR, "Local name")
                    .setNullable(false)
                    .setMaxLength(45),
            columnProperty(COUNTRY_GOVERNMENTFORM, Types.VARCHAR, "Government form")
                    .setNullable(false),
            columnProperty(COUNTRY_HEADOFSTATE, Types.VARCHAR, "Head of state"),
            // tag::foreignKeyPropertyCapital[]
            foreignKeyProperty(COUNTRY_CAPITAL_FK, "Capital", T_CITY,
                    columnProperty(COUNTRY_CAPITAL)),
            // end::foreignKeyPropertyCapital[]
            // tag::denormalizedViewProperty[]
            denormalizedViewProperty(COUNTRY_CAPITAL_POPULATION, COUNTRY_CAPITAL_FK,
                    getDefinition(T_CITY).getProperty(CITY_POPULATION), "Capital pop.")
                    .setFormat(getIntegerInstance()),
            // end::denormalizedViewProperty[]
            columnProperty(COUNTRY_CODE2, Types.VARCHAR, "Code2")
                    .setNullable(false)
                    .setMaxLength(2))
            .setOrderBy(orderBy().ascending(COUNTRY_NAME))
            .setSearchPropertyIds(COUNTRY_NAME)
            .setStringProvider(new StringProvider(COUNTRY_NAME))
            .setCaption("Country");
  }
 
  void countryLanguage() {
    define(T_COUNTRYLANGUAGE,
            // tag::compositePrimaryKey[]
            foreignKeyProperty(COUNTRYLANGUAGE_COUNTRY_FK, "Country", T_COUNTRY,
                    columnProperty(COUNTRYLANGUAGE_COUNTRYCODE, Types.VARCHAR)
                            .setPrimaryKeyIndex(0)
                            .setUpdatable(true))
                    .setNullable(false),
            columnProperty(COUNTRYLANGUAGE_LANGUAGE, Types.VARCHAR, "Language")
                    .setPrimaryKeyIndex(1)
                    .setUpdatable(true),
            // end::compositePrimaryKey[]
            // tag::booleanProperty[]
            columnProperty(COUNTRYLANGUAGE_ISOFFICIAL, Types.BOOLEAN, "Is official")
                    .setColumnHasDefaultValue(true)
                    .setNullable(false),
            // end::booleanProperty[]
            columnProperty(COUNTRYLANGUAGE_PERCENTAGE, Types.DOUBLE, "Percentage")
                    .setNullable(false)
                    .setMaximumFractionDigits(1)
                    .setMin(0).setMax(100),
            // tag::derivedProperty[]
            derivedProperty(COUNTRYLANGUAGE_NO_OF_SPEAKERS, Types.INTEGER, "No. of speakers",
                    sourceValues -> {
                      final Double percentage = (Double) sourceValues.get(COUNTRYLANGUAGE_PERCENTAGE);
                      final Entity country = (Entity) sourceValues.get(COUNTRYLANGUAGE_COUNTRY_FK);
                      if (notNull(percentage, country) && country.isNotNull(COUNTRY_POPULATION)) {
                        return country.getInteger(COUNTRY_POPULATION) * (percentage / 100);
                      }
 
                      return null;
                    }, COUNTRYLANGUAGE_COUNTRY_FK, COUNTRYLANGUAGE_PERCENTAGE)
                    .setFormat(getIntegerInstance())
            // end::derivedProperty[]
    ).setOrderBy(orderBy().ascending(COUNTRYLANGUAGE_LANGUAGE).descending(COUNTRYLANGUAGE_PERCENTAGE))
            .setCaption("Language");
  }
}

Domain model unit test

File: org/jminor/framework/demos/world/domain/WorldTest.java - 

/*
 * Copyright (c) 2004 - 2019, Björn Darri Sigurðsson. All Rights Reserved.
 */
package org.jminor.framework.demos.world.domain;
 
import org.jminor.common.User;
import org.jminor.common.db.exception.DatabaseException;
import org.jminor.framework.domain.Entity;
import org.jminor.framework.domain.test.EntityTestUnit;
 
import org.junit.jupiter.api.Test;
 
import java.util.Map;
 
public final class WorldTest extends EntityTestUnit {
 
  private static final User UNIT_TEST_USER = new User(
          System.getProperty("jminor.unittest.username", "scott"),
          System.getProperty("jminor.unittest.password", "tiger").toCharArray());
 
  public WorldTest() {
    super(World.class.getName());
  }
 
  @Test
  public void country() throws DatabaseException {
    testEntity(World.T_COUNTRY);
  }
 
  @Test
  public void city() throws DatabaseException {
    testEntity(World.T_CITY);
  }
 
  @Test
  public void countryLanguage() throws DatabaseException {
    testEntity(World.T_COUNTRYLANGUAGE);
  }
 
  @Override
  protected Entity initializeTestEntity(final String entityId, final Map<String, Entity> foreignKeyEntities) {
    final Entity entity = super.initializeTestEntity(entityId, foreignKeyEntities);
    if (entityId.equals(World.T_COUNTRY)) {
      entity.put(World.COUNTRY_CODE, "XXX");
      entity.put(World.COUNTRY_CONTINENT, "Asia");
    }
 
    return entity;
  }
 
  @Override
  protected void modifyEntity(final Entity testEntity, final Map<String, Entity> foreignKeyEntities) {
    super.modifyEntity(testEntity, foreignKeyEntities);
    if (testEntity.is(World.T_COUNTRY)) {
      testEntity.put(World.COUNTRY_CONTINENT, "Europe");
    }
  }
 
  @Override
  protected Entity initializeReferenceEntity(final String entityId, final Map<String, Entity> foreignKeyEntities) {
    switch (entityId) {
      case World.T_COUNTRY:
        final Entity iceland = getDomain().entity(World.T_COUNTRY);
        iceland.put(World.COUNTRY_CODE, "ISL");
 
        return iceland;
      case World.T_CITY:
        final Entity reykjavik = getDomain().entity(World.T_CITY);
        reykjavik.put(World.CITY_ID, 1449);
 
        return reykjavik;
    }
 
    return super.initializeReferenceEntity(entityId, foreignKeyEntities);
  }
 
  @Override
  protected User getTestUser() {
    return UNIT_TEST_USER;
  }
}

Application UI layer

File: org/jminor/framework/demos/world/beans/ui/CountryEditPanel.java - 

/*
 * Copyright (c) 2004 - 2019, Björn Darri Sigurðsson. All Rights Reserved.
 */
package org.jminor.framework.demos.world.beans.ui;
 
import org.jminor.framework.demos.world.domain.World;
import org.jminor.swing.framework.model.SwingEntityEditModel;
import org.jminor.swing.framework.ui.EntityEditPanel;
 
import java.awt.GridLayout;
 
import static org.jminor.swing.common.ui.UiUtil.makeUpperCase;
import static org.jminor.swing.common.ui.UiUtil.setPreferredWidth;
 
public final class CountryEditPanel extends EntityEditPanel {
 
  private static final int COMBOBOX_WIDTH = 120;
  private static final int TEXT_FIELD_COLUMNS = 12;
 
  public CountryEditPanel(final SwingEntityEditModel editModel) {
    super(editModel);
  }
 
  @Override
  protected void initializeUI() {
    setInitialFocusProperty(World.COUNTRY_CODE);
 
    makeUpperCase(createTextField(World.COUNTRY_CODE)).setColumns(TEXT_FIELD_COLUMNS);
    makeUpperCase(createTextField(World.COUNTRY_CODE2)).setColumns(TEXT_FIELD_COLUMNS);
    createTextField(World.COUNTRY_NAME).setColumns(TEXT_FIELD_COLUMNS);
    setPreferredWidth(createPropertyComboBox(World.COUNTRY_CONTINENT), COMBOBOX_WIDTH);
    setPreferredWidth(createPropertyComboBox(World.COUNTRY_REGION), COMBOBOX_WIDTH);
    createTextField(World.COUNTRY_SURFACEAREA);
    createTextField(World.COUNTRY_INDEPYEAR);
    createTextField(World.COUNTRY_POPULATION);
    createTextField(World.COUNTRY_LIFEEXPECTANCY);
    createTextField(World.COUNTRY_GNP);
    createTextField(World.COUNTRY_GNPOLD);
    createTextField(World.COUNTRY_LOCALNAME).setColumns(TEXT_FIELD_COLUMNS);
    setPreferredWidth(createPropertyComboBox(World.COUNTRY_GOVERNMENTFORM), COMBOBOX_WIDTH);
    createTextField(World.COUNTRY_HEADOFSTATE).setColumns(TEXT_FIELD_COLUMNS);
    setPreferredWidth(createForeignKeyComboBox(World.COUNTRY_CAPITAL_FK), COMBOBOX_WIDTH);
 
    setLayout(new GridLayout(4, 5, 5, 5));
 
    addPropertyPanel(World.COUNTRY_CODE);
    addPropertyPanel(World.COUNTRY_CODE2);
    addPropertyPanel(World.COUNTRY_NAME);
    addPropertyPanel(World.COUNTRY_CONTINENT);
    addPropertyPanel(World.COUNTRY_REGION);
    addPropertyPanel(World.COUNTRY_SURFACEAREA);
    addPropertyPanel(World.COUNTRY_INDEPYEAR);
    addPropertyPanel(World.COUNTRY_POPULATION);
    addPropertyPanel(World.COUNTRY_LIFEEXPECTANCY);
    addPropertyPanel(World.COUNTRY_GNP);
    addPropertyPanel(World.COUNTRY_GNPOLD);
    addPropertyPanel(World.COUNTRY_LOCALNAME);
    addPropertyPanel(World.COUNTRY_GOVERNMENTFORM);
    addPropertyPanel(World.COUNTRY_HEADOFSTATE);
    addPropertyPanel(World.COUNTRY_CAPITAL_FK);
  }
}

File: org/jminor/framework/demos/world/beans/ui/CityEditPanel.java - 

/*
 * Copyright (c) 2004 - 2019, Björn Darri Sigurðsson. All Rights Reserved.
 */
package org.jminor.framework.demos.world.beans.ui;
 
import org.jminor.framework.demos.world.domain.World;
import org.jminor.swing.framework.model.SwingEntityEditModel;
import org.jminor.swing.framework.ui.EntityEditPanel;
 
import java.awt.GridLayout;
 
import static org.jminor.swing.common.ui.UiUtil.setPreferredWidth;
 
public final class CityEditPanel extends EntityEditPanel {
 
  private static final int COMBOBOX_WIDTH = 120;
  private static final int TEXT_FIELD_COLUMNS = 12;
 
  public CityEditPanel(final SwingEntityEditModel editModel) {
    super(editModel);
  }
 
  @Override
  protected void initializeUI() {
    setInitialFocusProperty(World.CITY_COUNTRY_FK);
 
    setPreferredWidth(createForeignKeyComboBox(World.CITY_COUNTRY_FK), COMBOBOX_WIDTH);
    createTextField(World.CITY_NAME).setColumns(TEXT_FIELD_COLUMNS);
    createTextField(World.CITY_DISTRICT).setColumns(TEXT_FIELD_COLUMNS);
    createTextField(World.CITY_POPULATION);
 
    setLayout(new GridLayout(2, 2, 5, 5));
 
    addPropertyPanel(World.CITY_COUNTRY_FK);
    addPropertyPanel(World.CITY_NAME);
    addPropertyPanel(World.CITY_DISTRICT);
    addPropertyPanel(World.CITY_POPULATION);
  }
}

File: org/jminor/framework/demos/world/beans/ui/CountryLanguageEditPanel.java - 

/*
 * Copyright (c) 2004 - 2019, Björn Darri Sigurðsson. All Rights Reserved.
 */
package org.jminor.framework.demos.world.beans.ui;
 
import org.jminor.framework.demos.world.domain.World;
import org.jminor.swing.framework.model.SwingEntityEditModel;
import org.jminor.swing.framework.ui.EntityEditPanel;
 
import java.awt.GridLayout;
 
import static org.jminor.swing.common.ui.UiUtil.setPreferredWidth;
 
public final class CountryLanguageEditPanel extends EntityEditPanel {
 
  private static final int COMBOBOX_WIDTH = 120;
  private static final int TEXT_FIELD_COLUMNS = 12;
 
  public CountryLanguageEditPanel(final SwingEntityEditModel editModel) {
    super(editModel);
  }
 
  @Override
  protected void initializeUI() {
    setInitialFocusProperty(World.COUNTRYLANGUAGE_COUNTRY_FK);
 
    setPreferredWidth(createForeignKeyComboBox(World.COUNTRYLANGUAGE_COUNTRY_FK), COMBOBOX_WIDTH);
    createTextField(World.COUNTRYLANGUAGE_LANGUAGE).setColumns(TEXT_FIELD_COLUMNS);
    createCheckBox(World.COUNTRYLANGUAGE_ISOFFICIAL, null, false);
    createTextField(World.COUNTRYLANGUAGE_PERCENTAGE);
 
    setLayout(new GridLayout(2, 4, 5, 5));
 
    addPropertyPanel(World.COUNTRYLANGUAGE_COUNTRY_FK);
    addPropertyPanel(World.COUNTRYLANGUAGE_LANGUAGE);
    addPropertyPanel(World.COUNTRYLANGUAGE_ISOFFICIAL);
    addPropertyPanel(World.COUNTRYLANGUAGE_PERCENTAGE);
  }
}

Main application panel

File: org/jminor/framework/demos/world/client/ui/WorldAppPanel.java - 

/*
 * Copyright (c) 2004 - 2019, Björn Darri Sigurðsson. All Rights Reserved.
 */
package org.jminor.framework.demos.world.client.ui;
 
import org.jminor.common.User;
import org.jminor.common.model.CancelException;
import org.jminor.framework.db.EntityConnectionProvider;
import org.jminor.framework.demos.world.beans.ui.CityEditPanel;
import org.jminor.framework.demos.world.beans.ui.CountryEditPanel;
import org.jminor.framework.demos.world.beans.ui.CountryLanguageEditPanel;
import org.jminor.framework.demos.world.domain.World;
import org.jminor.swing.common.ui.UiUtil;
import org.jminor.swing.framework.model.SwingEntityApplicationModel;
import org.jminor.swing.framework.ui.EntityApplicationPanel;
import org.jminor.swing.framework.ui.EntityPanel;
import org.jminor.swing.framework.ui.EntityPanelProvider;
 
import java.util.Locale;
 
public final class WorldAppPanel extends EntityApplicationPanel<WorldAppPanel.WorldAppModel> {
 
  @Override
  protected void setupEntityPanelProviders() {
    final EntityPanelProvider countryPanelProvider = new EntityPanelProvider(World.T_COUNTRY);
    countryPanelProvider.setEditPanelClass(CountryEditPanel.class);
    final EntityPanelProvider cityPanelProvider = new EntityPanelProvider(World.T_CITY);
    cityPanelProvider.setEditPanelClass(CityEditPanel.class);
    final EntityPanelProvider countryLanguagePanelProvider = new EntityPanelProvider(World.T_COUNTRYLANGUAGE);
    countryLanguagePanelProvider.setEditPanelClass(CountryLanguageEditPanel.class);
    countryPanelProvider.addDetailPanelProvider(cityPanelProvider);
    countryPanelProvider.addDetailPanelProvider(countryLanguagePanelProvider);
 
    addEntityPanelProvider(countryPanelProvider);
  }
 
  @Override
  protected WorldAppModel initializeApplicationModel(final EntityConnectionProvider connectionProvider) {
    return new WorldAppModel(connectionProvider);
  }
 
  public static void main(final String[] args) throws CancelException {
    Locale.setDefault(new Locale("en", "EN"));
    EntityPanel.TOOLBAR_BUTTONS.set(true);
    EntityPanel.COMPACT_ENTITY_PANEL_LAYOUT.set(true);
    EntityConnectionProvider.CLIENT_DOMAIN_CLASS.set("org.jminor.framework.demos.world.domain.World");
    new WorldAppPanel().startApplication("World", null, false, UiUtil.getScreenSizeRatio(0.8),
            new User("scott", "tiger".toCharArray()));
  }
 
  public static final class WorldAppModel extends SwingEntityApplicationModel {
 
    private WorldAppModel(final EntityConnectionProvider connectionProvider) {
      super(connectionProvider);
    }
  }
}
documentation/tutorials/world.txt · Last modified: 2016/05/27 13:06 by darri

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki