ResultSetHelper (ymate-platform-v2-码云(gitee.com))

java.lang.Object
- net.ymate.platform.persistence.jdbc.support.ResultSetHelper

```
public final class ResultSetHelper
extends Object
```
数据结果集处理类，用于帮助开发人员便捷的读取结果集中数据内容
注：此类仅支持结果集由 ArrayResultSetHandler 和 MapResultSetHandler 产生的数据

Author:

刘镇 (suninformation@163.com) on 2010-10-10 上午10:59:40

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ResultSetHelper.IColumnRenderer` 结果集输出列渲染器
`static interface`	`ResultSetHelper.ItemHandler` 结果集元素处理器
`class`	`ResultSetHelper.ItemWrapper` 结果集元素包装对象

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ResultSetHelper`	`bind(IResultSet<?> resultSet)`
`static ResultSetHelper`	`bind(List<?> dataSet)`
`static ResultSetHelper`	`bind(Map<String,Object> data)`
`static ResultSetHelper`	`bind(Object[] data)`
`void`	`clearAll()` 清除结果集本方法为可选方法
`protected void`	`finalize()`
`ResultSetHelper.ItemWrapper`	`firstItemWrapper()`
`void`	`forEach(int step, ResultSetHelper.ItemHandler handler)` 遍历结果集合
`void`	`forEach(ResultSetHelper.ItemHandler handler)` 遍历结果集合
`String[]`	`getColumnNames()` 获取结果集的列名
`boolean`	`isResultsAvailable()` 获取当前结果集是否可用，即是否为空或元素数量为0
`String`	`toCsv()`
`String`	`toCsv(ResultSetHelper.IColumnRenderer columnRenderer)`
`String`	`toMarkdown()`
`String`	`toMarkdown(ResultSetHelper.IColumnRenderer columnRenderer)`
`String`	`toString()`
`String`	`toString(ResultSetHelper.IColumnRenderer columnRenderer)`
`void`	`writeTo(File outputFile)` 输出控制台表格到文件
`void`	`writeTo(OutputStream outputStream)` 输出控制台表格到流
`void`	`writeTo(String type, File outputFile)` 输出指定类型表格到文件
`void`	`writeTo(String type, File outputFile, ResultSetHelper.IColumnRenderer columnRenderer)` 输出指定类型表格到文件
`void`	`writeTo(String type, OutputStream outputStream)` 输出指定类型表格到流
`void`	`writeTo(String type, OutputStream outputStream, ResultSetHelper.IColumnRenderer columnRenderer)` 输出指定类型表格到流

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - bind
```
public static ResultSetHelper bind(Object[] data)
```
  - bind
```
public static ResultSetHelper bind(Map<String,Object> data)
```
  - bind
```
public static ResultSetHelper bind(IResultSet<?> resultSet)
```
  - bind
```
public static ResultSetHelper bind(List<?> dataSet)
```
    Parameters:
    
    dataSet - 结果数据集合
    
    Returns:
    
    绑定结果集数据，若参数为空则返回默认数据为空的实例对象
  - isResultsAvailable
```
public boolean isResultsAvailable()
```
    获取当前结果集是否可用，即是否为空或元素数量为0
    
    Returns:
    
    若当前结果集可用将返回true，否则返回false
    
    Since:
    
    2.1.0
  - getColumnNames
```
public String[] getColumnNames()
```
    获取结果集的列名
    
    Returns:
    
    String[] 字段名称集合
  - clearAll
```
public void clearAll()
```
    清除结果集本方法为可选方法
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - forEach
```
public void forEach(ResultSetHelper.ItemHandler handler)
             throws Exception
```
    遍历结果集合
    
    Parameters:
    
    handler - 结果集元素处理器
    
    Throws:
    
    Exception - 可能产生的异常
  - forEach
```
public void forEach(int step,
                    ResultSetHelper.ItemHandler handler)
             throws Exception
```
    遍历结果集合
    
    Parameters:
    
    step - 步长
    
    handler - 结果集元素处理器
    
    Throws:
    
    Exception - 可能产生的异常
  - firstItemWrapper
```
public ResultSetHelper.ItemWrapper firstItemWrapper()
```
    Returns:
    
    返回结果集中第一个元素的包装对象
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    输出控制台表格
    
    Since:
    
    2.1.0
  - toString
```
public String toString(ResultSetHelper.IColumnRenderer columnRenderer)
```
    Parameters:
    
    columnRenderer - 结果集输出列渲染器
    
    Returns:
    
    输出控制台表格
    
    Since:
    
    2.1.0
  - toCsv
```
public String toCsv()
```
    Returns:
    
    输出CSV表格
    
    Since:
    
    2.1.0
  - toCsv
```
public String toCsv(ResultSetHelper.IColumnRenderer columnRenderer)
```
    Parameters:
    
    columnRenderer - 结果集输出列渲染器
    
    Returns:
    
    输出CSV表格
    
    Since:
    
    2.1.0
  - toMarkdown
```
public String toMarkdown()
```
    Returns:
    
    输出Markdown表格
    
    Since:
    
    2.1.0
  - toMarkdown
```
public String toMarkdown(ResultSetHelper.IColumnRenderer columnRenderer)
```
    Parameters:
    
    columnRenderer - 结果集输出列渲染器
    
    Returns:
    
    输出Markdown表格
    
    Since:
    
    2.1.0
  - writeTo
```
public void writeTo(File outputFile)
             throws IOException
```
    输出控制台表格到文件
    
    Parameters:
    
    outputFile - 输出文件对象
    
    Throws:
    
    IOException - 可能产生的IO异常
    
    Since:
    
    2.1.0
  - writeTo
```
public void writeTo(String type,
                    File outputFile)
             throws IOException
```
    输出指定类型表格到文件
    
    Parameters:
    
    type - 表格类型(可选值: 空|csv|markdown)
    
    outputFile - 输出文件对象
    
    Throws:
    
    IOException - 可能产生的IO异常
    
    Since:
    
    2.1.0
  - writeTo
```
public void writeTo(String type,
                    File outputFile,
                    ResultSetHelper.IColumnRenderer columnRenderer)
             throws IOException
```
    输出指定类型表格到文件
    
    Parameters:
    
    type - 表格类型(可选值: 空|csv|markdown)
    
    outputFile - 输出文件对象
    
    columnRenderer - 结果集输出列渲染器
    
    Throws:
    
    IOException - 可能产生的IO异常
    
    Since:
    
    2.1.0
  - writeTo
```
public void writeTo(OutputStream outputStream)
             throws IOException
```
    输出控制台表格到流
    
    Parameters:
    
    outputStream - 输出流对象
    
    Throws:
    
    IOException - 可能产生的IO异常
    
    Since:
    
    2.1.0
  - writeTo
```
public void writeTo(String type,
                    OutputStream outputStream)
             throws IOException
```
    输出指定类型表格到流
    
    Parameters:
    
    type - 表格类型(可选值: 空|csv|markdown)
    
    outputStream - 输出流对象
    
    Throws:
    
    IOException - 可能产生的IO异常
    
    Since:
    
    2.1.0
  - writeTo
```
public void writeTo(String type,
                    OutputStream outputStream,
                    ResultSetHelper.IColumnRenderer columnRenderer)
             throws IOException
```
    输出指定类型表格到流
    
    Parameters:
    
    type - 表格类型(可选值: 空|csv|markdown)
    
    outputStream - 输出流对象
    
    columnRenderer - 结果集输出列渲染器
    
    Throws:
    
    IOException - 可能产生的IO异常
    
    Since:
    
    2.1.0

Class ResultSetHelper

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

bind

bind

bind

bind

isResultsAvailable

getColumnNames

clearAll

finalize

forEach

forEach

firstItemWrapper

toString

toString

toCsv

toCsv

toMarkdown

toMarkdown

writeTo

writeTo

writeTo

writeTo

writeTo

writeTo