We call that star the "North Star" since it sits in the direction that the spin axis from the northern hemisphere of Earth points. At present, the star known as Polaris is the North Star. It was used by ancient navigators as a means of sensing the right direction.
Polaris is a General-Purpose Library for Java which will be compromised of tool-set which will help in crafting Simple but Robust Java-Based Softwares. The library is the successor to the Monosync Framework used in my Capstone Project.
During our internship we were sent to different organizations across the region. I have seen so many things that can be improved, I called on to my friends in order to bring these changes outside the bounderies of the classroom. This started our after school meetings to captivate creativity while eating Lugaw Rice Porridge at the canteen, hence the name Afterschool Creatives.
Afterschool Creatives is an organization aims to INFORM, EDUCATE, and PROMOTE the usage of open-source platforms for students studying the same field in the Philippines.
Polaris is a stepping stone to start such movement that all of the IT students and related fields will be someday unified and collaborate in creating open-source platforms, softwares and products that will benefit the life of Filipino People.
Projects that have used Polaris.
- Department of Science and Technology Region III, Bulacan Provincial Science and Technology Center, Information Retrieval Integrated System (I.R.I.S.)
- Bulacan State University, Automated Record Management System of Public Placement and Employment Service Office (ARMSPPESO) Portable
- Department of Information and Communications Technology, Attendance Management System (AMS)
Build using Maven
git clone https://github.com/melvinperello/polaris-java-library.git
cd polaris-java-library
mvn clean installAfter Build, Include in pom.xml
<dependency>
<groupId>com.melvinperello</groupId>
<artifactId>polaris-java-library</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>Functionality Highlights.
Inspired by the Single Page Approach (SPA) by the time of the inception of React JS, I tried to make a way to deliver this philosphy within the realms of Java Desktop Application using JavaFX.
Polaris Form makes use of the JavaFX technology in order to deliver mesmerizing UI patterns and animations with a straigh-forward approach.
It uses Single Stage, Single Scene approach and only changes the root component of the UI with the changeRoot method. See example code below.
this.btn_view.setOnMouseClicked(value -> {
ScholarInformationModel model = this.tbl_scholars.getSelectionModel().getSelectedItem();
if (model == null) {
this.showWarningMessage(null, "Please highlight an entry to edit.");
return;
}
this.changeRoot(new ScholarInformation(model).load());
value.consume();
});Polaris Record is a reflective base Object Relational Mapping tool design to simplify interactions with the backend database with presentable abstraction. The goal of this feature is to allow faster development frames and make other students like me to be knowledgeable to Object Relational Mapping concepts with minimal configuration and straight forward approach.
On my way to venture the Java Internals I came across with an intersting topic. Reflection and Introspection, it is one of the basic concepts of the Java Philosophy. As a student I tried to learn more about it and make it useful not only for me and to other students as well in order for them to be famillar with Enterprise Java Development.
Reflection is a very expensive process. Metadata of objects should be cached in order to boost performance and operation overheads, at the time of this writing, PolarisRecord uses reflection on the Mapped Object every time a DDL operation is executed, No caching mechanism was applied. If you want to use Polaris Record for commercial purposes you may want to add this feature in order to boost performance.
Custom Annotations Used for Reflection
- @Column - Defines a database table column.
- @Id - Defines a database table column as primary key.
- @Table - Defines a database table, map into a Java Object.
Built-in Audit Trails
Polaris Record also includes a built-in audit trails feature, that allows a straight forward abstraction in auditing table changes. A PolarisRecord class must implement the TableAuditor to enable this feature.
Built-in DML Operations
- Insert - Creates a new entry to the database.
- Update - Execute an update to updated columns only not the entire row.
- UpdateFull - Updates an entire row completely.
- Delete - Deletes an entire row completely.
- Find - Checks if a row is existing.
- FindQuery - Checks if a row is existing using a custom query.
- FindMany - Retrieves a data set from the database using a query builder and then maps it to a Java Object.
Sample Polaris Record class.
@Table(ScholarInformationModel.TABLE)
public class ScholarInformationModel extends PolarisRecord implements TableAuditor {
//==========
// Afterschool Creatives Polaris Record Content Standardization
//==========
// Sections
// 01. Table Columns
// 02. Model Fields
// 03. Constructor (Initialize Default Values)
// 04-A. Static Inner Classes
// 04-B. Static Methods (Mostly Database Queries)
// 04-C. Custom Methods (Non-Static Methods)
// 05-A. Getters
// 05-B. Setters
//
// To standardized the creation of PolarisRecord classes. a complete child
// class must contain all of the following sections mentioned above.
//
// All Child classes must contain this standardization notice for reference.
//
// Standardization Code: 001 - 03/31/2018
//==========
// 01. Table Columns
//==========
public final static String TABLE = "scholar_information";
public final static String SCHOLAR_ID = "scholar_id";
public final static String STUDENT_NUMBER = "student_number";
public final static String LAST_NAME = "last_name";
public final static String FIRST_NAME = "first_name";
public final static String MIDDLE_NAME = "middle_name";
public final static String EXT_NAME = "ext_name";
public final static String GENDER = "gender";
public final static String SCHOLAR_TYPE = "scholar_type";
public final static String MERIT_TYPE = "merit_type";
public final static String COURSE = "course";
public final static String YEAR = "year_level";
public final static String SECTION = "section";
public final static String UNIVERSITY = "university";
public final static String MOBILE_NO = "mobile_no";
public final static String TEL_NO = "tel_no";
public final static String E_MAIL = "e_mail";
public final static String STUDENT_ADDRESS = "student_address";
public final static String STUDENT_CITY_MUNICIPALITY = "student_city_municipality";
public final static String STUDENT_PROVINCE = "student_province";
//==========
// 02. Model Fields
//==========
@PrimaryKey
@Column(SCHOLAR_ID)
private String scholarId;
@Column(STUDENT_NUMBER)
private String studentNumber;
@Column(LAST_NAME)
private String lastName;
@Column(FIRST_NAME)
private String firstName;
@Column(MIDDLE_NAME)
private String middleName;
@Column(EXT_NAME)
private String extName;
@Column(GENDER)
private String gender;
@Column(SCHOLAR_TYPE)
private Integer scholarType;
@Column(MERIT_TYPE)
private Integer meritType;
@Column(COURSE)
private String course;
@Column(YEAR)
private Integer year;
@Column(SECTION)
private String section;
@Column(UNIVERSITY)
private String university;
@Column(MOBILE_NO)
private String mobileNo;
@Column(TEL_NO)
private String telNo;
@Column(E_MAIL)
private String mail;
@Column(STUDENT_ADDRESS)
private String studentAddress;
@Column(STUDENT_CITY_MUNICIPALITY)
private String studentCityMunicipality;
@Column(STUDENT_PROVINCE)
private String studentProvince;
//==========
// 03. Constructor (Initialize Default Values)
//==========
public ScholarInformationModel() {
this.studentNumber = "";
this.lastName = "";
this.firstName = "";
this.middleName = "";
this.extName = "";
this.gender = Gender.UNKNOWN;
this.course = "";
this.year = YearLevel.DEFAULT;
this.section = "";
this.university = "";
this.mobileNo = "";
this.telNo = "";
this.mail = "";
this.studentAddress = "";
this.studentCityMunicipality = "";
this.studentProvince = "";
}
//==========
// 04-A. Static Inner Classes
//==========
public final static class Gender {
public final static String MALE = "MALE";
public final static String FEMALE = "FEMALE";
public final static String UNKNOWN = "UNKNOWN";
public final static String[] LIST = new String[]{MALE, FEMALE};
}
public final static class YearLevel {
public final static int DEFAULT = 0;
public final static int _1 = 1;
public final static int _2 = 2;
public final static int _3 = 3;
public final static int _4 = 4;
public final static int _5 = 5;
public final static Integer[] LIST = new Integer[]{_1, _2, _3, _4, _5};
public final static String toWord(int year) {
switch (year) {
case _1:
return "FIRST YEAR";
case _2:
return "SECOND YEAR";
case _3:
return "THIRD YEAR";
case _4:
return "FOURTH YEAR";
case _5:
return "FIFTH YEAR";
default:
throw new UnknownModelValueException();
}
}
}
/**
* Scholarship Types.
*/
public final static class ScholarType {
private final String name;
private final Integer value;
public ScholarType(String name, Integer code) {
this.name = name;
this.value = code;
}
public String getName() {
return name;
}
public Integer getValue() {
return value;
}
@Override
public String toString() {
return this.name;
}
//==========
public final static ScholarType JLSS = new ScholarType("RA 10612 Junior Level Science Scholarship", 2);
public final static ScholarType UNDERGRAD = new ScholarType("RA 7687 Undergraduate Scholarship", 1);
//==========
public final static ScholarType[] LIST = new ScholarType[]{UNDERGRAD, JLSS};
public static ScholarType toObject(Integer val) {
for (ScholarType scholarType : LIST) {
if (scholarType.getValue().intValue() == val.intValue()) {
return scholarType;
}
}
throw new UnknownModelValueException();
}
/**
* 3rd Degree Inner class from parent.
*/
public final static class Merit {
private final String name;
private final Integer value;
public String getName() {
return name;
}
public Integer getValue() {
return value;
}
public Merit(String name, Integer value) {
this.name = name;
this.value = value;
}
@Override
public String toString() {
return this.name;
}
//==========
public final static Merit MERIT = new Merit("MERIT", 2);
public final static Merit NON_MERIT = new Merit("NON-MERIT", 1);
//==========
public final static Merit[] LIST = new Merit[]{NON_MERIT, MERIT};
public static Merit toObject(Integer val) {
for (Merit meritType : LIST) {
if (meritType.getValue().intValue() == val.intValue()) {
return meritType;
}
}
throw new UnknownModelValueException();
}
}
}
//==========
// 04-B. Static Class Methods
//==========
public static <T> List<T> listAllActive() throws SQLException {
// Build Query
SimpleQuery querySample = new SimpleQuery();
querySample.addStatement("SELECT")
.addStatement("*")
.addStatement("FROM")
.addStatement(TABLE)
.addStatement("WHERE")
.addStatement(DELETED_AT)
.addStatement("IS NULL");
// Execute Query
try (ConnectionManager con = Context.app().db().createConnectionManager()) {
return new ScholarInformationModel().findMany(con, querySample);
}
}
public static boolean insert(ScholarInformationModel model) throws SQLException {
try (ConnectionManager con = Context.app().db().createConnectionManager()) {
model.auditCreate();
return model.insert(con);
}
}
public static boolean update(ScholarInformationModel model) throws SQLException {
try (ConnectionManager con = Context.app().db().createConnectionManager()) {
model.auditUpdate();
return model.updateFull(con);
}
}
public static boolean remove(ScholarInformationModel model) throws SQLException {
ConnectionManager con = null;
try {
//==========
// open connection
con = Context.app().db().createConnectionManager();
//==========
model.auditDelete();
// execute query.
return model.updateFull(con);
} finally {
if (con != null) {
con.close();
}
}
}
//==========
// 04-C. Custom Methods
//==========
public String getFullName() {
return this.getLastName() + ", "
+ this.getFirstName() + " "
+ this.getMiddleName() + " "
+ this.getExtName();
}
//==========
// 05-A. Getters
//==========
public String getScholarId() {
return scholarId;
}
public String getStudentNumber() {
return ModelAccess.textAccess(studentNumber);
}
public String getLastName() {
return ModelAccess.textAccess(lastName);
}
public String getFirstName() {
return ModelAccess.textAccess(firstName);
}
public String getMiddleName() {
return ModelAccess.textAccess(middleName);
}
public String getExtName() {
return ModelAccess.textAccess(extName);
}
public String getGender() {
return ModelAccess.textAccess(gender);
}
public Integer getScholarType() {
return scholarType;
}
public Integer getMeritType() {
return meritType;
}
public String getCourse() {
return ModelAccess.textAccess(course);
}
public Integer getYear() {
return year;
}
public String getSection() {
return ModelAccess.textAccess(section);
}
public String getUniversity() {
return ModelAccess.textAccess(university);
}
public String getMobileNo() {
return ModelAccess.textAccess(mobileNo);
}
public String getTelNo() {
return ModelAccess.textAccess(telNo);
}
public String getMail() {
return ModelAccess.textAccess(mail);
}
public String getStudentAddress() {
return ModelAccess.textAccess(studentAddress);
}
public String getStudentCityMunicipality() {
return ModelAccess.textAccess(studentCityMunicipality);
}
public String getStudentProvince() {
return ModelAccess.textAccess(studentProvince);
}
//==========
// 05-B. Setters
//==========
public void setScholarId(String scholarId) {
this.scholarId = scholarId;
}
public void setStudentNumber(String studentNumber) {
this.studentNumber = studentNumber;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public void setMiddleName(String middleName) {
this.middleName = middleName;
}
public void setExtName(String extName) {
this.extName = extName;
}
public void setGender(String gender) {
this.gender = gender;
}
public void setScholarType(Integer scholarType) {
this.scholarType = scholarType;
}
public void setMeritType(Integer meritType) {
this.meritType = meritType;
}
public void setCourse(String course) {
this.course = course;
}
public void setYear(Integer year) {
this.year = year;
}
public void setSection(String section) {
this.section = section;
}
public void setUniversity(String university) {
this.university = university;
}
public void setMobileNo(String mobileNo) {
this.mobileNo = mobileNo;
}
public void setTelNo(String telNo) {
this.telNo = telNo;
}
public void setMail(String mail) {
this.mail = mail;
}
public void setStudentAddress(String studentAddress) {
this.studentAddress = studentAddress;
}
public void setStudentCityMunicipality(String studentCityMunicipality) {
this.studentCityMunicipality = studentCityMunicipality;
}
public void setStudentProvince(String studentProvince) {
this.studentProvince = studentProvince;
}
//==========
// ANNEX-A. Table Audit
//==========
// Table Columns
//==========
public final static String CREATED_BY = "created_by";
public final static String CREATED_AT = "created_at";
public final static String UPDATED_BY = "updated_by";
public final static String UPDATED_AT = "updated_at";
public final static String DELETED_BY = "deleted_by";
public final static String DELETED_AT = "deleted_at";
//==========
//==========
@Column(CREATED_BY)
private String createdBy;
@Column(CREATED_AT)
private java.util.Date createdAt;
@Column(UPDATED_BY)
private String updatedBy;
@Column(UPDATED_AT)
private java.util.Date updatedAt;
@Column(DELETED_BY)
private String deletedBy;
@Column(DELETED_AT)
private java.util.Date deletedAt;
//==========
// Getters
//==========
@Override
public String getCreatedBy() {
return (this.createdBy == null) ? "" : this.createdBy;
}
@Override
public java.util.Date getCreatedAt() {
return (this.createdAt == null) ? null : new Date(this.createdAt.getTime());
}
@Override
public String getUpdatedBy() {
return (this.updatedBy == null) ? "" : this.updatedBy;
}
@Override
public java.util.Date getUpdatedAt() {
return (this.updatedAt == null) ? null : new Date(this.updatedAt.getTime());
}
@Override
public String getDeletedBy() {
return (this.deletedBy == null) ? "" : this.deletedBy;
}
@Override
public java.util.Date getDeletedAt() {
return (this.deletedAt == null) ? null : new Date(this.deletedAt.getTime());
}
//==========
// Setters
//==========
@Override
public void setCreatedBy(String createdBy) {
this.createdBy = (createdBy == null) ? "" : createdBy;
}
@Override
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = (createdAt == null) ? null : new Date(createdAt.getTime());
}
@Override
public void setUpdatedBy(String updatedBy) {
this.updatedBy = (updatedBy == null) ? "" : updatedBy;
}
@Override
public void setUpdatedAt(java.util.Date updatedAt) {
this.updatedAt = (updatedAt == null) ? null : new Date(updatedAt.getTime());
}
@Override
public void setDeletedBy(String deletedBy) {
this.deletedBy = (deletedBy == null) ? "" : deletedBy;
}
@Override
public void setDeletedAt(java.util.Date deletedAt) {
this.deletedAt = (deletedAt == null) ? null : new Date(deletedAt.getTime());
}
// </ANNEX-A. Table Audit>
}
If you have brand new or creative ideas that can help the growth of this project let us know by sending us a pull request. This will help to support the growth of open-source community among Filipino Students. You can also like and share our Facebook Page to Promote the existence of the organization.
You can use Polaris Library whether for your School Project, Thesis or even for your Commercial Projects Free of Charge. Please see MIT Open Source License for details.
Moving Forward with a Digital Philippines.
Polaris Java Library (C) Afterschool Creatives 2018
Cheers,
Melvin Perello