Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/PTAssistantPlugin.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/PTAssistantPlugin.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/PTAssistantPlugin.java (revision 32874) @@ -32,5 +32,8 @@ private static PTRouteSegment lastFix; + /* item of the Tools menu for adding stop_positions */ private JMenuItem addStopPositionMenu; + + /* item of the Tools menu for repeating the last fix */ private static JMenuItem repeatLastFixMenu; Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/AddStopPositionAction.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/AddStopPositionAction.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/AddStopPositionAction.java (revision 32874) @@ -39,4 +39,7 @@ } + /** + * Actions that add the new node, set tags and update the map frame. + */ @Override public void actionPerformed(ActionEvent e) { Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/IncompleteMembersDownloadThread.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/IncompleteMembersDownloadThread.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/IncompleteMembersDownloadThread.java (revision 32874) @@ -14,6 +14,14 @@ import org.openstreetmap.josm.plugins.pt_assistant.utils.RouteUtils; +/** + * Thread that downloads incomplete relation members while pausing the rest of testing + * @author darya + * + */ public class IncompleteMembersDownloadThread extends Thread { + /** + * Default constructor + */ public IncompleteMembersDownloadThread() { super(); Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/RepeatLastFixAction.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/RepeatLastFixAction.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/RepeatLastFixAction.java (revision 32874) @@ -13,8 +13,17 @@ import org.openstreetmap.josm.tools.Shortcut; +/** + * Carries out the changes after the Repeat last fix button has been pressed + * + * @author darya + * + */ public class RepeatLastFixAction extends JosmAction { private static final long serialVersionUID = 2681464946469047054L; + /** + * Default constructor + */ public RepeatLastFixAction() { super(tr("Repeat last fix"), new ImageProvider("presets/transport", "bus.svg"), tr("Repeat last fix"), @@ -24,4 +33,7 @@ } + /** + * Applies the fixes, resets the last fix attribute + */ @Override public void actionPerformed(ActionEvent e) { Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTRouteSegment.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTRouteSegment.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTRouteSegment.java (revision 32874) @@ -19,10 +19,26 @@ public class PTRouteSegment { + /* first stop of the route segment */ private PTStop firstStop; + + /* last stop of the route segment */ private PTStop lastStop; + + /* ptways that belong to this route segment */ private List ptways; + + /* fix variants available for this route segment */ private List> fixVariants; + + /* route relation for which this route segment was created */ private Relation relation; + /** + * Constructor + * @param firstStop first stop of the route segment + * @param lastStop last stop of the route segment + * @param ways ways PTWays that belong to this route segment + * @param relation the route relation for which this route segment is created + */ public PTRouteSegment(PTStop firstStop, PTStop lastStop, List ways, Relation relation) { this.firstStop = firstStop; @@ -34,8 +50,16 @@ } + /** + * Returns the PTWays of this route segment + * @return + */ public List getPTWays() { return this.ptways; } + /** + * Sets the PTWays of this route segment to the given list + * @param ptwayList + */ public void setPTWays(List ptwayList) { this.ptways = ptwayList; @@ -43,12 +67,24 @@ } + /** + * Returns the first stop of this route segment + * @return + */ public PTStop getFirstStop() { return this.firstStop; } - + + /** + * Returns the last stop of this route segment + * @return + */ public PTStop getLastStop() { return this.lastStop; } + /** + * Returns the first PTWay of this route segment + * @return + */ public PTWay getFirstPTWay() { if (ptways.isEmpty()) { @@ -58,4 +94,8 @@ } + /** + * Returns the last PTWay of this route segment + * @return + */ public PTWay getLastPTWay() { if (ptways.isEmpty()) { @@ -65,4 +105,8 @@ } + /** + * Returns the first way of this route segment + * @return + */ public Way getFirstWay() { if (ptways.isEmpty()) { @@ -72,4 +116,8 @@ } + /** + * Returns the last way of this route segment + * @return + */ public Way getLastWay() { if (ptways.isEmpty()) { @@ -114,8 +162,16 @@ } + /** + * Returns the fix variants stored for this route segment + * @return + */ public List> getFixVariants() { return this.fixVariants; } + /** + * Returns the route relation for which this route segment was created + * @return + */ public Relation getRelation() { return this.relation; Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTStop.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTStop.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTStop.java (revision 32874) @@ -12,11 +12,29 @@ import org.openstreetmap.josm.data.osm.RelationMember; +/** + * Model a stop with one or two elements (platform and/or stop_position) + * + * @author darya + * + */ public class PTStop extends RelationMember { + /* stop_position element of this stop */ private Node stopPosition = null; + + /* platform element of this stop */ private OsmPrimitive platform = null; + /* the name of this stop */ private String name = ""; + /** + * Constructor + * + * @param other + * @throws IllegalArgumentException + * if the given relation member does not fit to the data model + * used in the plugin + */ public PTStop(RelationMember other) throws IllegalArgumentException { @@ -111,8 +129,16 @@ } + /** + * Returns the name of this stop + * @return + */ protected String getName() { return this.name; } + /** + * Sets the stop_position for this stop to the given node + * @param newStopPosition + */ public void setStopPosition(Node newStopPosition) { Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTWay.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTWay.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/data/PTWay.java (revision 32874) @@ -118,9 +118,15 @@ return endNodes; } - + + /** + * Checks if this PTWay contains an unsplit roundabout (i.e. a way that + * touches itself) among its ways + * + * @return + */ public boolean containsUnsplitRoundabout() { - + List ways = this.getWays(); - for (Way way: ways) { + for (Way way : ways) { if (way.firstNode() == way.lastNode()) { return true; @@ -129,5 +135,11 @@ return false; } - + + /** + * Checks if the first Way of this PTWay is an unsplit roundabout (i.e. a + * way that touches itself) + * + * @return + */ public boolean startsWithUnsplitRoundabout() { if (this.ways.get(0).firstNode() == this.ways.get(0).lastNode()) { @@ -136,7 +148,13 @@ return false; } - + + /** + * Checks if the last Way of this PTWay is an unsplit roundabout (i.e. a way + * that touches itself) + * + * @return + */ public boolean endsWithUnsplitRoundabout() { - if (this.ways.get(this.ways.size() - 1).firstNode() == this.ways.get(this.ways.size()-1).lastNode()) { + if (this.ways.get(this.ways.size() - 1).firstNode() == this.ways.get(this.ways.size() - 1).lastNode()) { return true; } Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/DownloadReferrersDialog.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/DownloadReferrersDialog.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/DownloadReferrersDialog.java (revision 32874) @@ -7,4 +7,9 @@ import javax.swing.JPanel; +/** + * Dialog that asks the user whether referrers should be downloaded + * @author darya + * + */ public class DownloadReferrersDialog extends JPanel { Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/IncompleteMembersDownloadDialog.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/IncompleteMembersDownloadDialog.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/IncompleteMembersDownloadDialog.java (revision 32874) @@ -7,4 +7,11 @@ import javax.swing.JPanel; +/** + * Dialog that asks the user whether the incomplete relation members should be + * downloaded. + * + * @author darya + * + */ public class IncompleteMembersDownloadDialog extends JPanel { @@ -26,7 +33,8 @@ public IncompleteMembersDownloadDialog() { - + selectedOption = Integer.MIN_VALUE; - message = tr("Route relations have incomplete members.\nThey need to be downloaded to proceed with validation.\nDo you want to download them?"); + message = tr( + "Route relations have incomplete members.\nThey need to be downloaded to proceed with validation.\nDo you want to download them?"); checkbox = new JCheckBox(tr("Remember my choice and do not ask me again in this session")); options = new String[2]; @@ -53,9 +61,8 @@ } - - Object[] params = {message, checkbox}; - selectedOption = JOptionPane.showOptionDialog(this, params, tr("PT_Assistant Fetch Request"), JOptionPane.YES_NO_OPTION, - JOptionPane.QUESTION_MESSAGE, null, options, 0); - + Object[] params = { message, checkbox }; + selectedOption = JOptionPane.showOptionDialog(this, params, tr("PT_Assistant Fetch Request"), + JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE, null, options, 0); + if (checkbox.isSelected()) { if (selectedOption == JOptionPane.YES_OPTION) { Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantLayer.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantLayer.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantLayer.java (revision 32874) @@ -38,4 +38,10 @@ import org.openstreetmap.josm.tools.ImageProvider; +/** + * Layer that visualizes the routes in a more convenient way + * + * @author darya + * + */ public class PTAssistantLayer extends Layer implements SelectionChangedListener, PropertyChangeListener, LayerChangeListener { @@ -61,8 +67,16 @@ } + /** + * Adds a primitive (route) to be displayed in this layer + * + * @param primitive + */ public void addPrimitive(OsmPrimitive primitive) { this.primitives.add(primitive); } + /** + * Clears all primitives (routes) from being displayed. + */ public void clear() { this.primitives.clear(); @@ -82,5 +96,5 @@ public void addFixVariants(List> fixVariants) { HashMap, Character> fixVariantLetterMap = new HashMap<>(); - + char alphabet = 'A'; for (int i = 0; i < 5 && i < fixVariants.size(); i++) { @@ -91,5 +105,5 @@ } - for (Character currentFixVariantLetter: this.fixVariants.keySet()) { + for (Character currentFixVariantLetter : this.fixVariants.keySet()) { List fixVariant = this.fixVariants.get(currentFixVariantLetter); for (PTWay ptway : fixVariant) { Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantPaintVisitor.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantPaintVisitor.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantPaintVisitor.java (revision 32874) @@ -25,4 +25,10 @@ import org.openstreetmap.josm.tools.Pair; +/** + * Visits the primitives to be visualized in the pt_assistant layer + * + * @author darya + * + */ public class PTAssistantPaintVisitor extends PaintVisitor { @@ -32,4 +38,10 @@ private final MapView mv; + /** + * Constructor + * + * @param g + * @param mv + */ public PTAssistantPaintVisitor(Graphics g, MapView mv) { super(g, mv); @@ -141,4 +153,11 @@ } + /** + * Variation of the visit method that allows a special visualization of + * oneway roads + * + * @param nodes + * @param oneway + */ public void visit(List nodes, int oneway) { Node lastN = null; @@ -270,4 +289,9 @@ } + /** + * Draws s stop_position as a blue circle; draws a platform as a blue square + * + * @param primitive + */ protected void drawStop(OsmPrimitive primitive) { @@ -287,4 +311,11 @@ } + /** + * Draws the labels for the stops, which include the ordered position of the + * stop in the route and the ref numbers of other routes that use this stop + * + * @param primitive + * @param label + */ protected void drawStopLabel(OsmPrimitive primitive, String label) { @@ -342,4 +373,9 @@ } + /** + * Compares route ref numbers + * @author darya + * + */ private class RefTagComparator implements Comparator { @@ -398,5 +434,5 @@ /** - * + * Visualizes the fix variants, assigns colors to them based on their order * @param fixVariants */ @@ -538,4 +574,11 @@ } + /** + * Visuallizes the letters for each fix variant + * @param letter + * @param color + * @param letterX + * @param letterY + */ private void drawFixVariantLetter(String letter, Color color, double letterX, double letterY) { g.setColor(color); Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantPreferenceSetting.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantPreferenceSetting.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/PTAssistantPreferenceSetting.java (revision 32874) @@ -14,4 +14,9 @@ import org.openstreetmap.josm.tools.ImageProvider; +/** + * Displays the settings of the pt_assistant plugin under Preferences + * @author darya + * + */ public class PTAssistantPreferenceSetting implements SubPreferenceSetting { Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/ProceedDialog.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/ProceedDialog.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/gui/ProceedDialog.java (revision 32874) @@ -15,4 +15,12 @@ import javax.swing.SwingUtilities; +/** + * Dialog that asks the user how to proceed after the first stage of testing + * (i.e. if the errors found in the first stage of testing should be fixed + * before continuing with the testing). + * + * @author darya + * + */ public class ProceedDialog extends JPanel { @@ -44,5 +52,6 @@ if (true) { - JLabel label2 = new JLabel(" " + trn("{0} direction error", "{0} direction errors", numberOfDirectionErrors, numberOfDirectionErrors)); + JLabel label2 = new JLabel(" " + trn("{0} direction error", "{0} direction errors", + numberOfDirectionErrors, numberOfDirectionErrors)); panel.add(label2); label2.setAlignmentX(Component.LEFT_ALIGNMENT); @@ -50,5 +59,6 @@ if (numberOfRoadTypeErrors != 0) { - JLabel label3 = new JLabel(" " + trn("{0} road type error", "{0} road type errors", numberOfRoadTypeErrors, numberOfRoadTypeErrors)); + JLabel label3 = new JLabel(" " + trn("{0} road type error", "{0} road type errors", + numberOfRoadTypeErrors, numberOfRoadTypeErrors)); panel.add(label3); label3.setAlignmentX(Component.LEFT_ALIGNMENT); @@ -67,5 +77,5 @@ fixOptionButtonGroup.add(radioButtonDontFix); panel.add(radioButtonFixAutomatically); -// panel.add(radioButtonFixManually); + // panel.add(radioButtonFixManually); panel.add(radioButtonDontFix); radioButtonFixAutomatically.setAlignmentX(Component.LEFT_ALIGNMENT); Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/utils/RouteUtils.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/utils/RouteUtils.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/utils/RouteUtils.java (revision 32874) @@ -236,4 +236,9 @@ } + /** + * Checks if this way is suitable for public transport (not only for buses) + * @param way + * @return + */ public static boolean isWaySuitableForPublicTransport(Way way) { Index: /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/validation/Checker.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/validation/Checker.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/validation/Checker.java (revision 32874) @@ -135,5 +135,7 @@ if (testError.getCode() != PTAssistantValidatorTest.ERROR_CODE_STOP_BY_STOP - && testError.getCode() != PTAssistantValidatorTest.ERROR_CODE_DIRECTION) { + && testError.getCode() != PTAssistantValidatorTest.ERROR_CODE_DIRECTION + && testError.getCode() != PTAssistantValidatorTest.ERROR_CODE_CONSTRUCTION + && testError.getCode() != PTAssistantValidatorTest.ERROR_CODE_ROAD_TYPE) { return null; } Index: /applications/editors/josm/plugins/pt_assistant/test/unit/org/openstreetmap/josm/plugins/pt_assistant/AbstractTest.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/test/unit/org/openstreetmap/josm/plugins/pt_assistant/AbstractTest.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/test/unit/org/openstreetmap/josm/plugins/pt_assistant/AbstractTest.java (revision 32874) @@ -54,6 +54,6 @@ public static final String PATH_TO_STOP_AREA_MANY_PLATFORMS = "test/data/stop-area-many-platforms.osm"; + public static final String PATH_TO_SEGMENT_TEST = "test/data/segment-test.osm"; - public static final String PATH_TO_REPEAT_FIX = "test/data/repeat-fix.osm"; /** Index: /applications/editors/josm/plugins/pt_assistant/test/unit/org/openstreetmap/josm/plugins/pt_assistant/validation/SegmentCheckerTest.java =================================================================== --- /applications/editors/josm/plugins/pt_assistant/test/unit/org/openstreetmap/josm/plugins/pt_assistant/validation/SegmentCheckerTest.java (revision 32873) +++ /applications/editors/josm/plugins/pt_assistant/test/unit/org/openstreetmap/josm/plugins/pt_assistant/validation/SegmentCheckerTest.java (revision 32874) @@ -13,15 +13,16 @@ public class SegmentCheckerTest extends AbstractTest { - + @Test - public void testStopByStopTest() { - + public void test() { + + File file = new File(AbstractTest.PATH_TO_SEGMENT_TEST); DataSet ds = ImportUtils.importOsmFile(file, "testLayer"); PTAssistantValidatorTest test = new PTAssistantValidatorTest(); - + Relation route = null; - - for (Relation r : ds.getRelations()) { + + for (Relation r: ds.getRelations()) { if (RouteUtils.isTwoDirectionRoute(r)) { route = r; @@ -29,55 +30,13 @@ } } - - SegmentChecker.reset(); + SegmentChecker segmentChecker = new SegmentChecker(route, test); segmentChecker.performStopByStopTest(); assertEquals(SegmentChecker.getCorrectSegmentCount(), 27); assertEquals(segmentChecker.getErrors().size(), 0); - } - - /** - * Tests the stop-by-stop test - */ - @Test - public void testRepeatLastFix() { - File file = new File(AbstractTest.PATH_TO_REPEAT_FIX); - DataSet ds = ImportUtils.importOsmFile(file, "testLayer"); - PTAssistantValidatorTest test = new PTAssistantValidatorTest(); - - Relation route123 = null; - Relation route130 = null; - Relation route168 = null; - Relation route184 = null; - - for (Relation r : ds.getRelations()) { - if (r.getId() == 5379737) { - route123 = r; - } else if (r.getId() == 5379738) { - route130 = r; - } else if (r.getId() == 5379739) { - route168 = r; - } else if (r.getId() == 5379740) { - route184 = r; - } - } - - SegmentChecker.reset(); - SegmentChecker segmentChecker123 = new SegmentChecker(route123, test); - SegmentChecker segmentChecker130 = new SegmentChecker(route130, test); - SegmentChecker segmentChecker168 = new SegmentChecker(route168, test); - SegmentChecker segmentChecker184 = new SegmentChecker(route184, test); - segmentChecker123.performStopByStopTest(); -// TestError error123 = segmentChecker123.getErrors().get(0); -// PTRouteSegment wrongSegment123 = SegmentChecker.getWrongSegment(error123); - segmentChecker130.performStopByStopTest(); - segmentChecker168.performStopByStopTest(); - segmentChecker184.performStopByStopTest(); - - // Check the error number: - assertEquals(segmentChecker123.getErrors().size(), 1); - assertEquals(segmentChecker130.getErrors().size(), 1); - assertEquals(segmentChecker168.getErrors().size(), 1); - assertEquals(segmentChecker184.getErrors().size(), 0); + + + + } }