# About Me(关于作者)
    author(作者): malijie727@163.com
    time(时间): 2018/06/06

# Introductions(项目介绍)
    The local commuter railroad services a number of towns in Kiwiland.  Because of monetary concerns, all of the tracks are 'one-way.'  That is, a route from Kaitaia to Invercargill does not imply the existence of a route from Invercargill to Kaitaia.  In fact, even if both of these routes do happen to exist, they are distinct and are not necessarily the same distance!
    The purpose of this problem is to help the railroad provide its customers with information about the routes.
    Kiwiland 地区的城镇之前需要提供一些道路通勤服务，为了成本考虑，所有道路都是单向的，及时是两个城镇互通，其路线距离也是不同的。
    本项目的目的在于为顾客提供道路信息的查询服务，其中包括查询站点之间的距离，查询符合要求的所有站点，以及向顾客推荐最优站点等功能。

# Build and Run(项目运行介绍)
    Build environment(编译环境要求):
        JDK: higher than 1.6
        MAVEN: higher than 3.2.3
    Running environment(执行环境要求):
        JRE: higher than 1.6

    1. build project, under the project folder,  run commands
       mvn clean install

    2. check UnitTest report under target folder
       check target/surefire-reports/*

    3. run application with JAR file siteplan-1.0.jar under target folder
       java -jar <path>/siteplan-1.0.jar


# Architecture overview(模块介绍)
    org.lijma.demo.siteplan.main: Application module, 应用模块，提供应用的入口
    org.lijma.demo.siteplan.config：Loading module for route information.加载模块，将原始道路信息加载到系统里面
    org.lijma.demo.siteplan.core：core module for storaging and searching. 核心模块，提供道路系统的存储和查询服务
        org.lijma.demo.siteplan.core.StopManager:  management module for route update.管理模块，提供给管理员站点的更新服务
        org.lijma.demo.siteplan.core.StopSearcher: search module for customer query.查询模块，提供给客户查询站点的信息

# Technical overview(技术概况)
    route storage:  list data structure (采用图的邻接表存储道路站点和边的信息，参考ManagerImpl实现)
    route search: DFS, deepth first search (采用图的深度优先搜索算法查询对应信息，参考ManagerImpl实现)


# Release 1.0 Requirements(第一版本需求列表)
    1. The distance of the route A-B-C.
    2. The distance of the route A-D.
    3. The distance of the route A-D-C.
    4. The distance of the route A-E-B-C-D.
    5. The distance of the route A-E-D.
    6. The number of trips starting at C and ending at C with a maximum of 3 stops.  In the sample data below, there are two such trips: C-D-C (2 stops). and C-E-B-C (3 stops).
    7. The number of trips starting at A and ending at C with exactly 4 stops.  In the sample data below, there are three such trips: A to C (via B,C,D); A to C (via D,C,D); and A to C (via D,E,B).
    8. The length of the shortest route (in terms of distance to travel) from A to C.
    9. The length of the shortest route (in terms of distance to travel) from B to B.
    10. The number of different routes from C to C with a distance of less than 30.  In the sample data, the trips are: CDC, CEBC, CEBCDC, CDCEBC, CDEBC, CEBCEBC, CEBCEBCEBC.