PRA - PSA Report API

PRA is an api specification to generate reports for the Sporttag PSA.

Usage

This api provides a factory class to get the specific implementation. Make sure an implementation of PRA is in your dependency list.

private TotalRankingApi api = new ReportApiFactory.getTotalRanking();

API

The following APIs are available:

• discipline group ranking api - to generate ranking for specific disciplines
• discipline ranking api - to generate ranking for a single discipline
• total ranking api - to generate the total ranking for all disciplines
• participant list api - to generate a participant list of a single sport
• event sheet api - to generate sheets for a discipline to fill in the results of competitors
• start list api - to generate a start list of the competitors

Implement your own

To implement your own report generation you have to add this project as a dependency to your report project. This project is not available on any public repository expect Github. I recommend to use JitPack to add this project as a dependency.

Step 1. Add the JitPack repository to your build file

Add it into your root build.gradle at the end of repositories:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Step 2. Add PRA dependency

dependencies {
    compile 'com.github.BilledTrain380:PRA:1.0.0'
}

Step 3. Implement the APIs you wanna support

Available APIs:

• ch.schulealtendorf.pra.api.DisciplineGroupRankingAPI
• ch.schulealtendorf.pra.api.DisciplineRankingAPI
• ch.schulealtendorf.pra.api.EventSheetAPI
• ch.schulealtendorf.pra.api.ParticipantListAPI
• ch.schulealtendorf.pra.api.TotalRankingAPI
• ch.schulealtendorf.pra.api.StarListAPI

Example

import ch.schulealtendorf.pra.api.EventSheetAPI;
import ch.schulealtendorf.pra.pojo.EventSheet;
import java.io.InputStream;

public class MyEventSheetAPI implements EventSheetAPI {
    
    @Override
    public InputStream createReport(EventSheet data) {
        // Do your stuff here
    }
}

Step 4. Register your implementation as a service

You must register your implementation in order to be found by the service loader used.

1. Create a META-INF/services directory inside your resources directory
2. Create a file with the FQDN of the interface you wanna support
3. Write the FQDN of your implementation to the file

example with gradle / maven:

src/main/resources/META-INF/services/ch.schulealtendorf.pra.api.EventSheetAPI

ch.schulealtendorf.report.MyCustomEventSheetAPI

Built With

• Gradle - Dependency Management

Versioning

I use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Nicolas Märchy - Initial work - BilledTrain380

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU GPL-3.0 License - see the LICENSE.md file for details