lopezton / tennis-score-processor

Open source library dedicated to processing tennis match scoring and providing analytics over scoring data.

Tennis Score Processor

Tennis Score Processor is an open source library dedicated to processing tennis match scoring.

Tennis Score Processor is a Java based library that records and processes tennis match data on a stroke-by-stroke or point-by-point bases.

Overview

Tennis Score Processor uses a main processor object called MatchProcessor to update and modify the Match object, a simple POJO containing match data. See the following diagram:

Quick Links

• Request a feature
• Report a defect

Installation

Maven

Tennis Score Processor is hosted on Maven Central. Include the following in your project's pom.xml:

<dependency>
    <groupId>com.tonelope.tennis</groupId>
    <artifactId>scoreprocessor</artifactId>
    <version>0.1.0</version>
</dependency>

Manual

You can download the .jar file directly from the Github release page and include it on your project's classpath.

Usage

Use Cases

Use Tennis Score Processor to:

• Record match data on a stroke-by-stroke or point-by-point basis
• Analyze recorded match data
• Process tennis scoring results in real-time
• Build a real working tennis scoreboard
• Whatever else your imagine can dream up!

Get Started

Getting started with Tennis Score Processor is easy. Create a Match entity and update it with the necessary information for the processor to be able to perform updates. See the following code sample:

public static void main(String[] args) {

	// Build the match data
	Player player1 = new Player("Roger", "Federer");
	Player player2 = new Player("Rafael", "Nadal");
		
	List<Player> players = new ArrayList<>();
	players.add(player1);
	players.add(player2);
		
	// Initialize the playerConfig data
	PlayerConfig playerConfig = new PlayerConfig(players, player1, player2);
		
	// Utilize the framework's match factory to create a new match entity
	MatchFactory matchFactory = new DefaultMatchFactory();
		
	// Instantiate the matchProcessor
	MatchProcessor matchProcessor = new MatchProcessor(matchFactory.create(new MatchRules(), playerConfig));
		
	// Use the matchProcessor to update match results on stroke or point basis
	matchProcessor.update(new Stroke(player1, StrokeType.FIRST_SERVE, false, true));
}

Development setup

1. Fork/Clone the Repository
2. Install Lombok into your IDE
3. Import the project into your IDE

Contributing

See Contributing for information on how to contribute to this project. Contributions are open to the community and very much appreciated!

Meta

The application is currently in it's discovery phase and at the time supports singles scoring features. As the project grows, several types of scoring will be supported as well as other great features including:

• Doubles Scoring
• Live/Post Match Reporting
• Generated Match Metrics

Feedback and Pull Requests are extremely welcome!

Maintained by: Tony Lopez – [e-mail]

Distributed under the Apache License. See LICENSE for more information.

https://github.com/lopezton/tennis-score-processor