Jean-Francois Leveque

Comments in English

1 package org.legrog.entities; 1 package org.legrog.entities;
2 2
3 /** 3 /**
4 - * Énumération des actions possibles. 4 + * Available actions are an enumeration
5 */ 5 */
6 public enum ActionType { 6 public enum ActionType {
7 VALIDATE; 7 VALIDATE;
......
...@@ -3,8 +3,8 @@ package org.legrog.entities; ...@@ -3,8 +3,8 @@ package org.legrog.entities;
3 import javax.persistence.*; 3 import javax.persistence.*;
4 4
5 /** 5 /**
6 - * Entité persistante repésentant un pays. 6 + * Country persistence entity
7 - * Simplement composée d'un identitiant et d'un libellé. 7 + * Id and name seem enough
8 */ 8 */
9 @Entity 9 @Entity
10 public class Country { 10 public class Country {
......
...@@ -4,7 +4,7 @@ import javax.persistence.Id; ...@@ -4,7 +4,7 @@ import javax.persistence.Id;
4 import javax.persistence.Lob; 4 import javax.persistence.Lob;
5 5
6 /** 6 /**
7 - * Classe simplifiée du contenu éditeur servant à l'indexation de données du PublisherVersion valide avec l'identifiant Publisher correspondant 7 + * Simplified class for indexing validated publisher: content from PublisherVersion with id from Publisher
8 */ 8 */
9 public class IndexedPublisher { 9 public class IndexedPublisher {
10 @Id 10 @Id
...@@ -17,9 +17,9 @@ public class IndexedPublisher { ...@@ -17,9 +17,9 @@ public class IndexedPublisher {
17 private String publisherHistory; 17 private String publisherHistory;
18 18
19 /** 19 /**
20 - * Extrait l'id du Publisher et le nom et l'historique du PublisherVersion validé pour construire l'IndexedPublisher 20 + * Extracts data needed for indexing from Publisher and its validated PublisherVersion
21 * 21 *
22 - * @param publisher 22 + * @param publisher Publisher we want to be indexed
23 */ 23 */
24 public IndexedPublisher(Publisher publisher) { 24 public IndexedPublisher(Publisher publisher) {
25 PublisherVersion publisherVersion = publisher.getValidatedVersion(); 25 PublisherVersion publisherVersion = publisher.getValidatedVersion();
......
...@@ -4,9 +4,10 @@ import javax.persistence.*; ...@@ -4,9 +4,10 @@ import javax.persistence.*;
4 import java.util.Set; 4 import java.util.Set;
5 5
6 /** 6 /**
7 - * Entité persistante correspondant à un éditeur. 7 + * Persisted entity for a publisher
8 - * Pointe vers la version valide si elle existe, ainsi que son validateur et la date de validation. 8 + * Has versions of type PublisherVersion
9 - * Pointe vers l'ensemble de ses versions. 9 + * May have a validated PublisherVersion among those
10 + * Has access to PublisherAction related to it
10 */ 11 */
11 @Entity 12 @Entity
12 public class Publisher /* extends org.roliste.data.DbLinkableEntity */ { 13 public class Publisher /* extends org.roliste.data.DbLinkableEntity */ {
......
...@@ -4,7 +4,7 @@ import javax.persistence.*; ...@@ -4,7 +4,7 @@ import javax.persistence.*;
4 import java.sql.Timestamp; 4 import java.sql.Timestamp;
5 5
6 /** 6 /**
7 - * Classe des actions sur des (versions d') éditeurs. 7 + * Pesisted entity for actions made on PublisherVersion
8 */ 8 */
9 @Entity 9 @Entity
10 public class PublisherAction { 10 public class PublisherAction {
...@@ -21,7 +21,7 @@ public class PublisherAction { ...@@ -21,7 +21,7 @@ public class PublisherAction {
21 21
22 private Timestamp publisherActionDatetime; 22 private Timestamp publisherActionDatetime;
23 23
24 - // Accès simplifié plutôt que de passer par publisherVersion 24 + // Simplified access instead of going through PublisherVersion
25 @ManyToOne 25 @ManyToOne
26 private Publisher publisher; 26 private Publisher publisher;
27 27
......
...@@ -5,22 +5,23 @@ import org.springframework.data.jpa.repository.JpaRepository; ...@@ -5,22 +5,23 @@ import org.springframework.data.jpa.repository.JpaRepository;
5 import java.util.List; 5 import java.util.List;
6 6
7 /** 7 /**
8 - * Interface d'accès aux PublisherAction. 8 + * Interface for accessing PublisherAction
9 */ 9 */
10 public interface PublisherActionRepository extends JpaRepository<PublisherAction, Integer> { 10 public interface PublisherActionRepository extends JpaRepository<PublisherAction, Integer> {
11 11
12 /** 12 /**
13 - * Retourne la dernière action du type indiqué sur le Publisher indiqué. 13 + * Returns last action of a type for a publisher
14 * 14 *
15 - * @param actionType 15 + * @param actionType ActionType requested
16 - * @param publisher 16 + * @param publisher Publisher concerned by the action
17 * @return PublisherAction 17 * @return PublisherAction
18 */ 18 */
19 PublisherAction findFirstByActionTypeAndPublisherOrderByPublisherActionDatetimeDesc(ActionType actionType, Publisher publisher); 19 PublisherAction findFirstByActionTypeAndPublisherOrderByPublisherActionDatetimeDesc(ActionType actionType, Publisher publisher);
20 20
21 /** 21 /**
22 - * Retourne l'ensemble des actions concernant la PublisherVersion indiquée 22 + * Returns all actions for a PublisherVersion
23 - * @param publisherVersion 23 + *
24 + * @param publisherVersion PublisherVersion concerned by the actions
24 * @return List<PublisherAction> 25 * @return List<PublisherAction>
25 */ 26 */
26 List<PublisherAction> findByPublisherVersion(PublisherVersion publisherVersion); 27 List<PublisherAction> findByPublisherVersion(PublisherVersion publisherVersion);
......
1 package org.legrog.entities; 1 package org.legrog.entities;
2 2
3 /** 3 /**
4 - * Interface d'indexation/recherche des IndexedPublisher 4 + * Indexing/Search interface for IndexedPublisher
5 */ 5 */
6 public interface PublisherSearchRepository { 6 public interface PublisherSearchRepository {
7 /** 7 /**
8 - * Indexe la version simplifiée de Publisher, IndexedPublisher. 8 + * Indexes an IndexedPublisher
9 * 9 *
10 - * @param indexedPublisher 10 + * @param indexedPublisher IndexedPublisher to be indexed
11 * @return IndexedPublisher 11 * @return IndexedPublisher
12 */ 12 */
13 public IndexedPublisher save(IndexedPublisher indexedPublisher) throws IndexingException; 13 public IndexedPublisher save(IndexedPublisher indexedPublisher) throws IndexingException;
......
...@@ -10,7 +10,7 @@ import javax.inject.Inject; ...@@ -10,7 +10,7 @@ import javax.inject.Inject;
10 import java.io.IOException; 10 import java.io.IOException;
11 11
12 /** 12 /**
13 - * Classe implémentant l'interface PublisherSearchRepository avec l'API SolrJ 13 + * Implementation of PublisherSearchRepository using SolrJ
14 */ 14 */
15 public class PublisherSearchRepositorySolrj implements PublisherSearchRepository { 15 public class PublisherSearchRepositorySolrj implements PublisherSearchRepository {
16 Logger logger = LoggerFactory.getLogger(getClass()); 16 Logger logger = LoggerFactory.getLogger(getClass());
......
...@@ -4,11 +4,9 @@ import javax.persistence.*; ...@@ -4,11 +4,9 @@ import javax.persistence.*;
4 import java.sql.Timestamp; 4 import java.sql.Timestamp;
5 5
6 /** 6 /**
7 - * Entité persistente représentant une version d'un éditeur. 7 + * Persisted entity for a publisher version
8 - * Contient les données représentant un éditeur. 8 + * Contains the data
9 - * Adresse découpée en suivant http://schema.org/PostalAddress. 9 + * Postal Address is split according to http://schema.org/PostalAddress
10 - * Pointe vers l'éditeur auquel elle correspond.
11 - * Pointe vers l'auteur de la version et contient la date et heure de celle-ci.
12 */ 10 */
13 @Entity 11 @Entity
14 public class PublisherVersion { 12 public class PublisherVersion {
......