Natty 自然语言日期解析器技术文档

1. 安装指南

1.1 环境要求

• Java 8 或更高版本
• Maven 3.x 或更高版本

1.2 安装步骤

1. 克隆项目到本地：

   git clone https://github.com/joestelmach/natty.git
   

2. 进入项目目录：

   cd natty
   

3. 使用 Maven 构建项目：

   mvn clean install
   

4. 构建完成后，生成的 JAR 文件位于 target 目录下，可以将其添加到你的项目依赖中。

2. 项目的使用说明

2.1 基本使用

Natty 是一个用于解析自然语言日期的 Java 库。你可以通过以下方式使用它：

import com.joestelmach.natty.Parser;
import java.util.List;
import java.util.Date;

public class NattyExample {
    public static void main(String[] args) {
        Parser parser = new Parser();
        List<Date> dates = parser.parse("next Monday at 10am").get(0).getDates();
        for (Date date : dates) {
            System.out.println(date);
        }
    }
}

2.2 解析结果

Natty 的解析结果是一个包含 DateGroup 对象的列表，每个 DateGroup 包含以下信息：

• dates: 解析出的日期列表
• text: 原始输入文本
• position: 解析的起始位置
• parse: 解析的详细信息

3. 项目API使用文档

3.1 Parser 类

Parser 类是 Natty 的核心类，负责解析自然语言日期表达式。

3.1.1 Parser()

构造函数，创建一个新的 Parser 实例。

3.1.2 List<DateGroup> parse(String input)

解析输入的自然语言日期表达式，返回一个包含 DateGroup 对象的列表。

3.2 DateGroup 类

DateGroup 类表示一个解析结果，包含以下方法：

3.2.1 List<Date> getDates()

返回解析出的日期列表。

3.2.2 String getText()

返回原始输入文本。

3.2.3 int getPosition()

返回解析的起始位置。

3.2.4 List<Parse> getParse()

返回解析的详细信息。

4. 项目安装方式

4.1 通过 Maven 安装

在你的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.joestelmach</groupId>
    <artifactId>natty</artifactId>
    <version>0.13</version>
</dependency>

4.2 通过 Gradle 安装

在你的 build.gradle 文件中添加以下依赖：

implementation 'com.joestelmach:natty:0.13'

通过以上步骤，你可以成功安装并使用 Natty 自然语言日期解析器。