eclipse-sailing-analytics/sailing-analytics
1
0
Fork 0
mirror of https://github.com/eclipse-sailing-analytics/sailing-analytics.git synced 2026-09-23 22:19:13 +00:00
Code Activity

added JavaDoc to Template

Browse Source
This commit is contained in:
Armin Zamani
2013-03-02 15:36:10 +01:00
parent 188a4a371d
commit ad4e60fa89
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
java/com.sap.sailing.domain/src/com/sap/sailing/domain/racelog/RaceLogIdentifierTemplate.java
+19
View File
@@ -4,10 +4,29 @@ import java.io.Serializable;
import com.sap.sailing.domain.base.Fleet;
/**
* This interfaces serves as a template for the actual RaceLogIdentifier that is compound as follows:
* <p>
* {LeaderboardName / RegattaName} + RaceColumnName + FleetName
* <p>
* As the components of the RaceLogIdentifier are not available on RaceColumn level, we have to propagate the
* information in this template data object.
*
*/
public interface RaceLogIdentifierTemplate extends Serializable {
/**
* This method returns the name of parent object of the {@link RaceColumn}. This can be a {@link FlexibleLeaderboard} or a {@link Regatta}.
* @return the name of the parent object
*/
String getParentObjectName();
/**
* Compiles the template with giving the last component, the {@link Fleet}, to a RaceLogIdentifier that is used to retrieve the
* RaceLogEvents from a RaceLogStore
* @param fleet the fleet of the race
* @return the RaceLogIdentifier
*/
RaceLogIdentifier compile(Fleet fleet);
void resolve(RaceLogIdentifierTemplateResolver resolver);