cleo-primer 项目使用教程

1. 项目的目录结构及介绍

cleo-primer 项目的目录结构如下：

cleo-primer/
├── AUTHORS
├── LICENSE
├── README.md
├── pom.xml
├── dat/
│   └── nasdaq-company-list.xml
├── scripts/
│   ├── post-element-list.sh
│   └── post-element.sh
├── src/
│   └── main/
│       ├── java/
│       │   └── cleo/
│       │       └── primer/
│       │           └── rest/
│       │               └── model/
│       │                   └── ElementDTO.java
│       └── resources/
│           └── config/
│               └── generic-typeahead
└── target/

目录结构介绍

• AUTHORS: 项目作者信息文件。
• LICENSE: 项目许可证文件，采用 Apache-2.0 许可证。
• README.md: 项目介绍和使用说明文件。
• pom.xml: Maven 项目配置文件。
• dat/: 数据文件目录，包含示例数据文件 nasdaq-company-list.xml。
• scripts/: 脚本文件目录，包含用于发布新元素的脚本 post-element-list.sh 和 post-element.sh。
• src/main/java/cleo/primer/rest/model/ElementDTO.java: 项目的主要 Java 代码文件，定义了 RESTful API 的模型类。
• src/main/resources/config/generic-typeahead: 配置文件目录，包含项目的配置文件。
• target/: Maven 构建输出目录，包含编译后的文件和打包结果。

2. 项目的启动文件介绍

cleo-primer 项目的启动文件主要是通过 Maven 命令来启动 Web 应用。以下是启动步骤：

1. 构建 WAR 文件:

   mvn clean package
   

2. 启动 Web 应用:

   MAVEN_OPTS="-Xms1g -Xmx1g" mvn jetty:run -Dcleo.instance.name=Company -Dcleo.instance.type=cleo.primer.GenericTypeaheadInstance -Dcleo.instance.conf=src/main/resources/config/generic-typeahead
   

启动文件介绍

• pom.xml: Maven 项目配置文件，定义了项目的依赖和构建配置。
• src/main/java/cleo/primer/rest/model/ElementDTO.java: 定义了 RESTful API 的模型类，是项目的主要 Java 代码文件。

3. 项目的配置文件介绍

cleo-primer 项目的配置文件位于 src/main/resources/config/ 目录下，主要配置文件为 generic-typeahead。

配置文件介绍

• generic-typeahead: 该文件包含了项目的配置参数，如 cleo.instance.name, cleo.instance.type, 和 cleo.instance.conf。这些参数用于自定义 Web 应用的行为和数据处理方式。

配置参数说明

• cleo.instance.name: 实例名称，用于标识不同的实例。
• cleo.instance.type: 实例类型，指定实例的具体类型。
• cleo.instance.conf: 配置文件路径，指定配置文件的具体位置。

通过调整这些参数，可以定制化 cleo-primer 项目的运行行为，以适应不同的数据集和需求。