BookClass

java.lang.Object
- object.BookClass

直接已知子类:

RootBookClass, TerminalBookClass
```
public class BookClass
extends java.lang.Object
```
图书的分类。
对应南京大学馆藏数字化图书平台中的图书。同时分类名和分类编号满足中图法分类。是树结构。具有查询子分类和查询分类下书籍列表，批量下载分类书籍等功能。如果你没有足够信息构造实例，可以通过RootBookClass查询所有分类来获取实例。或者BookSearch中的一些方法获取实例。

作者:

padeoe

构造器概要

构造器
构造器和说明
`BookClass(java.lang.String id)` 创建一个新初始化的`BookClass`对象，使之中图法分类标识是`id`
`BookClass(java.lang.String id, java.lang.String name, BookClass parent)` 创建并初始化一个书本分类。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BookClass`	`addChild(BookClass bookClass)` 添加一个子分类
`void`	`downloadAllBooks(java.lang.String pathname, int threadNumber, java.lang.String errorLogPath)` 下载分类下所有图书。
`void`	`downloadWithCataDir()` 下载分类下所有图书，会迭代测创建分类文件夹下载存储路径为当前路径，线程数为5，错误日志将保存在当前路径，文件名为`BookDownloader.ERROR_LOG_NAME` 可以调用重载`downloadWithCataDir(String, int, String)`设置参数
`void`	`downloadWithCataDir(java.lang.String pathname, int threadNumber, java.lang.String errorLogPath)` 下载分类下所有图书，会迭代测创建分类文件夹
`boolean`	`equals(java.lang.Object obj)` 判断两个`BookClass`是否是同一个分类。
`java.util.Set<Book>`	`getBooks()` 获取分类对象所有终端分类下已存储的书籍
`BookClass`	`getChild(java.lang.String idOrName)` 查询特定子分类。
`int`	`getChildCount()` 获取子分类的数量
`java.util.Map<java.lang.String,BookClass>`	`getChildren()` 获取所有子分类。
`java.lang.String`	`getCookie()` 查看当对象所使用的cookie
`java.lang.String`	`getId()`
`java.lang.String`	`getName()`
`BookClass`	`getParent()` 获取父分类
`java.lang.String`	`getPath()` 获取分类所在的路径。
`int`	`hashCode()` 返回`BookClass`的哈希值。
`boolean`	`isRoot()` 用于判断`BookClass`对象是不是`RootBookClass`的实例
`boolean`	`isTerminal()`
`BookClass`	`link(BookClass... childBookClasses)` 对当前分类添加子分类
`void`	`loadAllChild()` 迭代加载所有子分类。
`void`	`loadChild()` 加载子分类。
`java.util.Set<Book>`	`queryAllBooks()` 获得某分类下的所有图书
`java.util.Set<Book>`	`queryAllBooks(int threadNumber)` 获得分类下的所有图书
`java.util.Set<Book>`	`queryBooks(int page)` 从服务器获取该分类下图书列表的第`page`页。
`java.util.Set<Book>`	`queryBooks(java.lang.String html)` 获取HTML文本中的书籍并根据其分类添加进当前的分类结构
`int`	`queryBooksSize()` 从服务器查询当前分类下图书的数量。
`void`	`setCookie(java.lang.String cookie)` 设置`cookie`,BookClass的子每一次子分类加载，书籍查询等操作都需要cookie，设置的cookie将会对所有子分类使用，以避免频繁获取cookie
`void`	`setId(java.lang.String id)`
`void`	`setName(java.lang.String name)`
`void`	`setParent(BookClass parent)`
`java.lang.String`	`toString()` 返回`BookClass`的可读字符串描述。

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - BookClass
```
public BookClass(java.lang.String id,
                 java.lang.String name,
                 BookClass parent)
```
    创建并初始化一个书本分类。指定分类编号，分类名称和父分类。
    
    参数:
    
    id - 分类编号
    
    name - 分类名称
    
    parent - 父分类
  - BookClass
```
public BookClass(java.lang.String id)
```
    创建一个新初始化的BookClass对象，使之中图法分类标识是id
    
    参数:
    
    id - 分类的中图法分类标识。需要和南京大学馆藏数字化图书平台定义的格式一致
- 方法详细资料
  - getCookie
```
public java.lang.String getCookie()
```
    查看当对象所使用的cookie
    
    返回:
    
    cookie
  - setCookie
```
public void setCookie(java.lang.String cookie)
```
    设置cookie,BookClass的子每一次子分类加载，书籍查询等操作都需要cookie，设置的cookie将会对所有子分类使用，以避免频繁获取cookie
    
    参数:
    
    cookie - cookie
  - getChildCount
```
public int getChildCount()
```
    获取子分类的数量
    
    返回:
    
    子分类的数量
  - getParent
```
public BookClass getParent()
```
    获取父分类
    
    返回:
    
    父分类。如果不存在则为null
  - getChildren
```
public java.util.Map<java.lang.String,BookClass> getChildren()
```
    获取所有子分类。初始为null,若要查看子分类，必须先调用loadChild()或者loadAllChild()从服务器查询并加载
    
    返回:
    
    子分类的Map，键是分类编号id或分类名称name(做了冗余存储)，值是分类对象。
  - getChild
```
public BookClass getChild(java.lang.String idOrName)
```
    查询特定子分类。
    
    参数:
    
    idOrName - 子分类的名称或者代号。符合中图法分类。
    
    返回:
    
    子分类
  - getName
```
public java.lang.String getName()
```
  - setName
```
public void setName(java.lang.String name)
```
  - getId
```
public java.lang.String getId()
```
  - setId
```
public void setId(java.lang.String id)
```
  - setParent
```
public void setParent(BookClass parent)
```
  - isTerminal
```
public boolean isTerminal()
```
  - addChild
```
public BookClass addChild(BookClass bookClass)
```
    添加一个子分类
    
    参数:
    
    bookClass - 子分类
    
    返回:
    
    如果同id的子分类已存在，则返回之前的子分类，如果不存在，则添加并返回null
  - loadChild
```
public void loadChild()
               throws java.io.IOException
```
    加载子分类。仅加载一层子分类，即子分类的子分类不会被加载。当该方法被调用时，会向服务器查询该分类的子分类并更新该对象的children
    如需递归加载子分类，调用loadAllChild()
    
    抛出:
    
    java.io.IOException - 从服务器查询子节点出错
  - loadAllChild
```
public void loadAllChild()
                  throws java.io.IOException
```
    迭代加载所有子分类。直至加载到每个分类的末层分类。
    
    抛出:
    
    java.io.IOException - 从服务器查询时出错
  - downloadWithCataDir
```
public void downloadWithCataDir(java.lang.String pathname,
                                int threadNumber,
                                java.lang.String errorLogPath)
                         throws java.io.IOException
```
    下载分类下所有图书，会迭代测创建分类文件夹
    
    参数:
    
    pathname - 存储路径。将在该路径下创建多级分类目录并保存下载的图书
    
    threadNumber - 线程数
    
    errorLogPath - 错误日志路径
    
    抛出:
    
    java.io.IOException - 连接失败的错误
  - downloadWithCataDir
```
public void downloadWithCataDir()
                         throws java.io.IOException
```
    下载分类下所有图书，会迭代测创建分类文件夹下载存储路径为当前路径，线程数为5，错误日志将保存在当前路径，文件名为BookDownloader.ERROR_LOG_NAME 可以调用重载downloadWithCataDir(String, int, String)设置参数
    
    抛出:
    
    java.io.IOException - 连接失败的错误
  - queryBooks
```
public java.util.Set<Book> queryBooks(int page)
                               throws java.io.IOException
```
    从服务器获取该分类下图书列表的第page页。图书列表的分页是服务器做的，每页最多10条图书。
    页数的最大值可以根据queryBooksSize()自行计算
    
    参数:
    
    page - 图书列表的页码
    
    返回:
    
    列表该页记录的图书
    
    抛出:
    
    java.io.IOException - 从服务器查询书本列表时出错
  - queryAllBooks
```
public java.util.Set<Book> queryAllBooks()
                                  throws java.io.IOException
```
    获得某分类下的所有图书
    
    返回:
    
    分类下所有图书
    
    抛出:
    
    java.io.IOException - 从服务器查询书本列表时出错
  - queryAllBooks
```
public java.util.Set<Book> queryAllBooks(int threadNumber)
                                  throws java.io.IOException
```
    获得分类下的所有图书
    
    参数:
    
    threadNumber - 线程数
    
    返回:
    
    图书集合
    
    抛出:
    
    java.io.IOException - 连接错误
  - downloadAllBooks
```
public void downloadAllBooks(java.lang.String pathname,
                             int threadNumber,
                             java.lang.String errorLogPath)
                      throws java.io.IOException
```
    下载分类下所有图书。所有书籍将直接保存在pathname目录下，每本书一个文件夹，以书名命名。如同名，则加作者名，如又同名，加书本编号
    
    参数:
    
    pathname - 存储路径。书本文件夹所在的上级路径
    
    threadNumber - 线程数
    
    errorLogPath - 错误日志路径
    
    抛出:
    
    java.io.IOException - 连接失败的错误
  - queryBooks
```
public java.util.Set<Book> queryBooks(java.lang.String html)
```
    获取HTML文本中的书籍并根据其分类添加进当前的分类结构
    
    参数:
    
    html - 服务器特定页面返回的包含书本信息的HTML文本。服务器多个不同页面返回的包含书本信息的HTML中书本信息相关节点的格式都相似。均可调用本函数
    
    返回:
    
    HTML中记录的书本
  - queryBooksSize
```
public int queryBooksSize()
                   throws java.io.IOException
```
    从服务器查询当前分类下图书的数量。包含所有子分类下的图书
    
    返回:
    
    当前分类下图书的数量
    
    抛出:
    
    java.io.IOException - 查询失败
  - link
```
public BookClass link(BookClass... childBookClasses)
```
    对当前分类添加子分类
    
    参数:
    
    childBookClasses - 顺次路径关系子分类，后一个是前一个的子分类。第一个是当前分类的子分类
    
    返回:
    
    子分类的最后一级分类.若子路径参数为空，则为当前分类
  - getBooks
```
public java.util.Set<Book> getBooks()
```
    获取分类对象所有终端分类下已存储的书籍
    
    返回:
    
    该分类下属所有分类的图书集合
  - equals
```
public boolean equals(java.lang.Object obj)
```
    判断两个BookClass是否是同一个分类。仅根据代号即id来判断
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    obj - 任意对象
    
    返回:
    
    对象是否是同一个分类
  - getPath
```
public java.lang.String getPath()
```
    获取分类所在的路径。返回可读的String，对二级分类到当前分类顺次所经路径分别调用toString()，用"-"分割
    
    返回:
    
    从二级分类到当前分类顺次所经路径，用"-"分隔分类
  - isRoot
```
public boolean isRoot()
```
    用于判断BookClass对象是不是RootBookClass的实例
    
    返回:
    
    是否是根分类
  - hashCode
```
public int hashCode()
```
    返回BookClass的哈希值。会直接使用用id的哈希值
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    
    哈希值
  - toString
```
public java.lang.String toString()
```
    返回BookClass的可读字符串描述。
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    格式是 "分类代号(分类名)"，如果分类名为null，则格式是"分类代号"

类 BookClass

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

BookClass

BookClass

方法详细资料

getCookie

setCookie

getChildCount

getParent

getChildren

getChild

getName

setName

getId

setId

setParent

isTerminal

addChild

loadChild

loadAllChild

downloadWithCataDir

downloadWithCataDir

queryBooks

queryAllBooks

queryAllBooks

downloadAllBooks

queryBooks

queryBooksSize

link

getBooks

equals

getPath

isRoot

hashCode

toString