Burtha

Burtha, stands for Burmese-Pyi-Thar (ဗမာပြည်သား) meaning, a member of Burma Country. Burtha is a Burmese National Registration Card(NRC) tool written in Kotlin.

val input = "၁၂/မရက(နိုင်)၁၂၃၄၅၆"
NationalRegistrationCardFormatLanguageConverter.convertToEnglishFormat(input) 

//Output: "12/MaRaKa(C)123456"

Burtha supports all NRC types with the following pattern

Getting Started

Add Dependency

Gradle

If you use gradle, add this repository first

repositories {
  mavenCentral()
} 

dependencies {
  implementation 'dev.aungkyawpaing.burtha:burtha-kt:1.1.4'
}

Features

Validation

NationalRegistrationCardFormatValidator.validateFormat provides a method to validate a format. It accepts String and returns true if it's a valid NRC format.

val validator = NationalRegistrationCardFormatValidator()
val input = "၁၂/မရက(နိုင်)၁၂၃၄၅၆"
val result = NationalRegistrationCardFormatValidator.validate(input)
//result : true

Configuration

By default, the validator try to match with both Burmese and English format. You can configure this to your liking. For burmese only check, you can use NationalRegistrationCardFormatValidator.burmese(), and for English use NationalRegistrationCardFormatValidator.english() respectively. For more advanced configuration, you can use Rule and Validate Mode

Rule

Validator is made out of multiple ValidationRule, where each rule confirm whether the format match its rule.

Validate Mode

Validate Mode provides either you can check with AND mode or OR mode.

• In AND mode, the validator returns true if and only if all rules returns true
• In OR mode, the validator returns true as soon as one of the rules returns true. By default, OR method is used to check both Burmese or English format.

With the combination of Rule and Mode, you can come up with any validation method you want, such as all caps English NRC, combination of both English and Burmese... etc.

Conversion

Burtha also provide a Burmese to English Conversion, vice versa.

val input = "12/MaRaKa(C)123456"
NationalRegistrationCardFormatLanguageConverter.convertToBurmeseFormat(input) 

//Output: "၁၂/မရက(နိုင်)၁၂၃၄၅၆" 

Currently, Burtha doesn't provide configurations for Conversion yet.

Contribution

You are more than welcomed to contribute to development of Burtha. If you're new to Open source softwares, you can start by

• Suggesting new issues, and feature requests
• Commenting your thoughts on existing issues
• Using the library yourself

License

Copyright 2020 Aung Kyaw Paing

Licensed 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.