/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.empire.samples.db;
import org.apache.empire.commons.Options;
import org.apache.empire.data.DataType;
import org.apache.empire.data.DataMode;
import org.apache.empire.db.DBColumn;
import org.apache.empire.db.DBDatabase;
import org.apache.empire.db.DBTable;
import org.apache.empire.db.DBTableColumn;
/**
* <PRE>
* This file contains the definition of the data model in Java.
* The SampleDB data model consists of two tables and a foreign key relation.
* The tables are defined as nested classes here, but you may put them in separate files if you want to.
*
* PLEASE NOTE THE NAMING CONVENTION:
* Since all tables, views and columns are declared as "final" constants they are all in upper case.
* We recommend using a prefix of T_ for tables and C_ for columns in order to keep them together
* when listed in your IDE's code completion.
* There is no need to stick to this convention but it makes life just another little bit easier.
*
* You may declare other database tables or views in the same way.
* </PRE>
*/
public class SampleDB extends DBDatabase
{
private final static long serialVersionUID = 1L;
public enum Gender
{
M, // Male
F; // Female
}
/**
* This class represents the definition of the Departments table.
*/
public static class Departments extends DBTable
{
private final static long serialVersionUID = 1L;
public final DBTableColumn DEPARTMENT_ID;
public final DBTableColumn NAME;
public final DBTableColumn HEAD;
public final DBTableColumn BUSINESS_UNIT;
public final DBTableColumn UPDATE_TIMESTAMP;
public Departments(DBDatabase db)
{
super("DEPARTMENTS", db);
// ID
DEPARTMENT_ID = addColumn("DEPARTMENT_ID", DataType.AUTOINC, 0, DataMode.AutoGenerated, "DEP_ID_SEQUENCE");
NAME = addColumn("NAME", DataType.TEXT, 80, DataMode.NotNull);
HEAD = addColumn("HEAD", DataType.TEXT, 80, DataMode.Nullable);
BUSINESS_UNIT = addColumn("BUSINESS_UNIT", DataType.TEXT, 4, DataMode.NotNull, "ITTK");
UPDATE_TIMESTAMP= addColumn("UPDATE_TIMESTAMP", DataType.DATETIME, 0, DataMode.AutoGenerated);
// Primary Key
setPrimaryKey(DEPARTMENT_ID);
// Set other Indexes
addIndex("DEPARTMENT_NAME_IDX", true, new DBColumn[] { NAME });
// Set timestamp column for save updates
setTimestampColumn(UPDATE_TIMESTAMP);
}
}
/**
* This class represents the definition of the Employees table.
*/
public static class Employees extends DBTable
{
private final static long serialVersionUID = 1L;
public final DBTableColumn EMPLOYEE_ID;
public final DBTableColumn SALUTATION;
public final DBTableColumn FIRSTNAME;
public final DBTableColumn LASTNAME;
public final DBTableColumn DATE_OF_BIRTH;
public final DBTableColumn DEPARTMENT_ID;
public final DBTableColumn GENDER;
public final DBTableColumn PHONE_NUMBER;
public final DBTableColumn EMAIL;
public final DBTableColumn SALARY;
public final DBTableColumn RETIRED;
public final DBTableColumn UPDATE_TIMESTAMP;
public Employees(DBDatabase db)
{
super("EMPLOYEES", db);
// ID
EMPLOYEE_ID = addColumn("EMPLOYEE_ID", DataType.AUTOINC, 0, DataMode.AutoGenerated, "EMPLOYEE_ID_SEQUENCE");
SALUTATION = addColumn("SALUTATION", DataType.TEXT, 20, DataMode.Nullable);
FIRSTNAME = addColumn("FIRSTNAME", DataType.TEXT, 40, DataMode.NotNull);
LASTNAME = addColumn("LASTNAME", DataType.TEXT, 40, DataMode.NotNull);
DATE_OF_BIRTH = addColumn("DATE_OF_BIRTH", DataType.DATE, 0, DataMode.Nullable);
DEPARTMENT_ID = addColumn("DEPARTMENT_ID", DataType.INTEGER, 0, DataMode.NotNull);
GENDER = addColumn("GENDER", DataType.TEXT, 1, DataMode.Nullable);
PHONE_NUMBER = addColumn("PHONE_NUMBER", DataType.TEXT, 40, DataMode.Nullable);
EMAIL = addColumn("EMAIL", DataType.TEXT, 80, DataMode.Nullable);
SALARY = addColumn("SALARY", DataType.DECIMAL, 10.2, DataMode.Nullable);
RETIRED = addColumn("RETIRED", DataType.BOOL, 0, DataMode.NotNull, false);
UPDATE_TIMESTAMP= addColumn("UPDATE_TIMESTAMP", DataType.DATETIME, 0, DataMode.AutoGenerated);
// Primary Key
setPrimaryKey(EMPLOYEE_ID);
// Set other Indexes
addIndex("EMPLOYEE_NAME_IDX", true, new DBColumn[] { FIRSTNAME, LASTNAME, DATE_OF_BIRTH });
// Set timestamp column for save updates
setTimestampColumn(UPDATE_TIMESTAMP);
// Create Options for GENDER column
Options genders = new Options();
genders.set(Gender.M, "Male");
genders.set(Gender.F, "Female");
GENDER.setOptions(genders);
}
}
// Declare all Tables and Views here
public final Departments DEPARTMENTS = new Departments(this);
public final Employees EMPLOYEES = new Employees(this);
/**
* Constructor of the SampleDB data model description
*
* Put all foreign key relations here.
*/
public SampleDB()
{
// Define Foreign-Key Relations
addRelation( EMPLOYEES.DEPARTMENT_ID.referenceOn( DEPARTMENTS.DEPARTMENT_ID ));
}
}