org.dbflute.helper.token.file

クラス FileToken

java.lang.Object

org.dbflute.helper.token.file.FileToken

public class FileToken
extends Object

The handler of token file.
You can read/write the token file.

 e.g. Tokenize (read)
  File tsvFile = ... // input file
  FileToken fileToken = new FileToken();
  fileToken.tokenize(new FileInputStream(tsvFile), resource -> {
      ... = resource.getHeaderInfo();
      ... = resource.getValueList();
      ... = resource.toColumnValueMap();
  }, op -> op.delimitateByTab().encodeAsUTF8());
 
 e.g. Make (write)
 File tsvFile = ... // output file
 List<String> columnNameList = ... // columns for header
 FileToken fileToken = new FileToken();
 fileToken.make(new FileOutputStream(tsvFile), writer -> {
     for (Member member : ...) { // output data loop
         List<String> valueList = ...; // convert the member to the row resource
         writer.writeRow(valueList); // Yes, you write!
     }
 }, op -> op.delimitateByTab().encodeAsUTF8().headerInfo(columnNameList));
 

作成者:

jflute

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	FileToken.ValueLineInfo

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected LineToken	_lineToken The handler of line token for help.
protected static String	FIRST_LINE_DONE_MARK The mark that means first line done for writing process.
protected static String	HEADER_DONE_MARK The mark that means header done for writing process.

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FileToken()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected FileTokenizingHeaderInfo	analyzeHeaderInfo(String delimiter, String lineString)
protected FileToken.ValueLineInfo	arrangeValueList(List<String> valueList, String delimiter)
protected FileToken.ValueLineInfo	arrangeValueList(String lineString, String delimiter)
protected void	assertMakingDelimiter(FileMakingOption option)
protected void	assertMakingEncoding(FileMakingOption option)
protected void	assertObjectNotNull(String variableName, Object value)
protected void	assertStringNotNullAndNotTrimmedEmpty(String variableName, String value)
protected void	callbackDataRowWriter(FileMakingCallback callback, FileMakingOption option, String lineSep, Writer writer, Set<String> doneMarkSet)
protected void	checkValueCount(FileMakingOption option, List<String> valueList)
protected String	connectPreString(String preString, String delimiter, String value)
protected FileMakingOption	createFileMakingOption(FileTokenOptionCall<FileMakingOption> opLambda)
protected FileMakingRowResource	createFileMakingRowResource()
protected FileTokenizingHeaderInfo	createFileTokenizingHeaderInfo()
protected FileTokenizingOption	createFileTokenizingOption(FileTokenOptionCall<FileTokenizingOption> opLambda)
protected FileTokenizingRowResource	createFileTokenizingRowResource()
protected FileToken.ValueLineInfo	createValueLineInfo()
protected void	doMake(OutputStream ous, FileMakingCallback handlingCall, FileTokenOptionCall<FileMakingOption> opLambda)
protected void	doTokenize(InputStream ins, FileTokenizingCallback handlingCall, FileTokenOptionCall<FileTokenizingOption> opLambda)
protected void	doWriteDataRow(Writer writer, FileMakingRowResource resource, FileMakingOption option, String lineSep, Set<String> doneMarkSet)
protected void	doWriterHeader(Writer writer, List<String> columnNameList, FileMakingOption option, Set<String> doneMarkSet)
protected boolean	endsQuote(String value, boolean startsQuote)
protected String	getTokenizedRestoredLineSeparator()
protected boolean	isFrontQOnly(String value)
protected boolean	isNotBothQ(String value)
protected boolean	isOddNumber(int number)
protected boolean	isQQ(String value)
protected boolean	isRearQOnly(String value)
void	make(OutputStream ous, FileMakingCallback oneArgLambda, FileTokenOptionCall<FileMakingOption> opLambda) Make (write) token file by row writer that accepts row resources.
void	make(String filePath, FileMakingCallback oneArgLambda, FileTokenOptionCall<FileMakingOption> opLambda) Make (write) token file by row writer that accepts row resources.
protected void	mkdirsIfNeeds(String filePath)
protected FileMakingOption	newFileMakingOption()
protected FileTokenizingOption	newFileTokenizingOption()
protected void	prepareWritingLineOption(FileMakingOption option, LineMakingOption lineOp)
protected String	prepareWritingLineSeparator(FileMakingOption option)
protected void	reflectQuoteMinimally(FileMakingOption option, LineMakingOption lineOp)
protected String	removeDoubleQuotation(String value)
protected String	removeRightDoubleQuotation(String value)
protected void	throwFileMakingInvalidValueCountException(List<String> columnNameList, List<String> valueList)
void	tokenize(InputStream ins, FileTokenizingCallback oneArgLambda, FileTokenOptionCall<FileTokenizingOption> opLambda) Tokenize (read) token data to specified file.
void	tokenize(String filePath, FileTokenizingCallback oneArgLambda, FileTokenOptionCall<FileTokenizingOption> opLambda) Tokenize (read) the token data from the specified file.

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

HEADER_DONE_MARK

protected static final String HEADER_DONE_MARK

The mark that means header done for writing process.

関連項目:

定数フィールド値

FIRST_LINE_DONE_MARK

protected static final String FIRST_LINE_DONE_MARK

The mark that means first line done for writing process.

関連項目:

定数フィールド値

_lineToken

protected final LineToken _lineToken

The handler of line token for help.

コンストラクタの詳細

FileToken

public FileToken()

メソッドの詳細

tokenize

public void tokenize(String filePath,
                     FileTokenizingCallback oneArgLambda,
                     FileTokenOptionCall<FileTokenizingOption> opLambda)
              throws FileNotFoundException,
                     IOException

Tokenize (read) the token data from the specified file. (file-tokenizing)
CR + LF is treated as LF.

 File tsvFile = ... // input file
 FileToken fileToken = new FileToken();
 fileToken.tokenize(new FileInputStream(tsvFile), resource -> {
     ... = resource.getHeaderInfo();
     ... = resource.getValueList();
     ... = resource.toColumnValueMap();
 }, op -> op.delimitateByTab().encodeAsUTF8().handleEmptyAsNull());
 

パラメータ:

filePath - The path of file name to read. (NotNull)

oneArgLambda - The callback for file-tokenizing. (NotNull)

opLambda - The callback for option for file-tokenizing. (NotNull, Required{delimiter, encoding})

例外:

FileNotFoundException - When the file was not found.

IOException - When the file reading failed.

FileTokenizingSQLHandlingFailureException - When the SQL handling fails in the row handling process.

createFileTokenizingOption

protected FileTokenizingOption createFileTokenizingOption(FileTokenOptionCall<FileTokenizingOption> opLambda)

newFileTokenizingOption

protected FileTokenizingOption newFileTokenizingOption()

tokenize

public void tokenize(InputStream ins,
                     FileTokenizingCallback oneArgLambda,
                     FileTokenOptionCall<FileTokenizingOption> opLambda)
              throws FileNotFoundException,
                     IOException

Tokenize (read) token data to specified file. (named file-tokenizing)
CR + LF is treated as LF.
This method uses InputStreamReader and BufferedReader that wrap the stream.
And these objects are closed. (close() called finally)

 File tsvFile = ... // input file
 FileToken fileToken = new FileToken();
 fileToken.tokenize(new FileInputStream(tsvFile), resource -> {
     ... = resource.getHeaderInfo();
     ... = resource.getValueList();
 }, op -> op.delimitateByTab().encodeAsUTF8().handleEmptyAsNull());
 

パラメータ:

ins - The input stream for writing. This stream is closed after writing automatically. (NotNull)

oneArgLambda - The callback for file-tokenizing. (NotNull)

opLambda - The callback for option for file-tokenizing. (NotNull, Required{delimiter, encoding})

例外:

FileNotFoundException - When the file was not found.

IOException - When the file reading failed.

FileTokenizingSQLHandlingFailureException - When the SQL handling fails in the row handling process.

doTokenize

protected void doTokenize(InputStream ins,
                          FileTokenizingCallback handlingCall,
                          FileTokenOptionCall<FileTokenizingOption> opLambda)
                   throws UnsupportedEncodingException,
                          IOException

例外:

UnsupportedEncodingException

IOException

createFileTokenizingRowResource

protected FileTokenizingRowResource createFileTokenizingRowResource()

getTokenizedRestoredLineSeparator

protected String getTokenizedRestoredLineSeparator()

arrangeValueList

protected FileToken.ValueLineInfo arrangeValueList(String lineString,
                                                   String delimiter)

arrangeValueList

protected FileToken.ValueLineInfo arrangeValueList(List<String> valueList,
                                                   String delimiter)

createValueLineInfo

protected FileToken.ValueLineInfo createValueLineInfo()

connectPreString

protected String connectPreString(String preString,
                                  String delimiter,
                                  String value)

isNotBothQ

protected boolean isNotBothQ(String value)

isRearQOnly

protected boolean isRearQOnly(String value)

isFrontQOnly

protected boolean isFrontQOnly(String value)

isQQ

protected boolean isQQ(String value)

endsQuote

protected boolean endsQuote(String value,
                            boolean startsQuote)

isOddNumber

protected boolean isOddNumber(int number)

removeDoubleQuotation

protected String removeDoubleQuotation(String value)

removeRightDoubleQuotation

protected String removeRightDoubleQuotation(String value)

analyzeHeaderInfo

protected FileTokenizingHeaderInfo analyzeHeaderInfo(String delimiter,
                                                     String lineString)

createFileTokenizingHeaderInfo

protected FileTokenizingHeaderInfo createFileTokenizingHeaderInfo()

make

public void make(String filePath,
                 FileMakingCallback oneArgLambda,
                 FileTokenOptionCall<FileMakingOption> opLambda)
          throws FileNotFoundException,
                 IOException

Make (write) token file by row writer that accepts row resources.

 String tsvFile = ... // output file
 List<String> columnNameList = ... // columns for header
 FileToken fileToken = new FileToken();
 fileToken.make(tsvFile, writer -> {
     for (Member member : ...) { // output data loop
         List<String> valueList = ...; // convert the member to the row resource
         writer.writeRow(valueList); // Yes, you write!
     }
 }, op -> op.delimitateByTab().encodeAsUTF8().headerInfo(columnNameList));
 

パラメータ:

filePath - The path of token file to write. (NotNull)

oneArgLambda - The callback for file-making with writer. (NotNull)

opLambda - The callback for option for file-making. (NotNull, Required: delimiter, encoding)

例外:

FileNotFoundException - When the file was not found.

IOException - When the file writing failed.

FileMakingInvalidValueCountException - When the value count of the row does not match column count of header.

FileMakingSQLHandlingFailureException - When the SQL handling fails in the row writing process.

mkdirsIfNeeds

protected void mkdirsIfNeeds(String filePath)

make

public void make(OutputStream ous,
                 FileMakingCallback oneArgLambda,
                 FileTokenOptionCall<FileMakingOption> opLambda)
          throws FileNotFoundException,
                 IOException

Make (write) token file by row writer that accepts row resources.
This method uses OutputStreamWriter and BufferedWriter that wrap the stream.
And these objects are closed. (close() called finally)

 File tsvFile = ... // output file
 List<String> columnNameList = ... // columns for header
 FileToken fileToken = new FileToken();
 fileToken.make(new FileOutputStream(tsvFile), writer -> {
     for (Member member : ...) { // output data loop
         List<String> valueList = ...; // convert the member to the row resource
         writer.writeRow(valueList); // Yes, you write!
     }
 }, op -> op.delimitateByTab().encodeAsUTF8().headerInfo(columnNameList));
 

パラメータ:

ous - The output stream for writing. This stream is closed after writing automatically. (NotNull)

oneArgLambda - The callback for file-making with writer. (NotNull)

opLambda - The callback for option for file-making. (NotNull, Required: delimiter, encoding)

例外:

FileNotFoundException - When the file was not found.

IOException - When the file writing failed.

FileMakingInvalidValueCountException - When the value count of the row does not match column count of header.

FileMakingSQLHandlingFailureException - When the SQL handling fails in the row writing process.

doMake

protected void doMake(OutputStream ous,
                      FileMakingCallback handlingCall,
                      FileTokenOptionCall<FileMakingOption> opLambda)
               throws FileNotFoundException,
                      IOException

例外:

FileNotFoundException

IOException

createFileMakingOption

protected FileMakingOption createFileMakingOption(FileTokenOptionCall<FileMakingOption> opLambda)

newFileMakingOption

protected FileMakingOption newFileMakingOption()

doWriterHeader

protected void doWriterHeader(Writer writer,
                              List<String> columnNameList,
                              FileMakingOption option,
                              Set<String> doneMarkSet)
                       throws IOException

例外:

IOException

callbackDataRowWriter

protected void callbackDataRowWriter(FileMakingCallback callback,
                                     FileMakingOption option,
                                     String lineSep,
                                     Writer writer,
                                     Set<String> doneMarkSet)
                              throws IOException

例外:

IOException

createFileMakingRowResource

protected FileMakingRowResource createFileMakingRowResource()

doWriteDataRow

protected void doWriteDataRow(Writer writer,
                              FileMakingRowResource resource,
                              FileMakingOption option,
                              String lineSep,
                              Set<String> doneMarkSet)
                       throws IOException

例外:

IOException

prepareWritingLineSeparator

protected String prepareWritingLineSeparator(FileMakingOption option)

prepareWritingLineOption

protected void prepareWritingLineOption(FileMakingOption option,
                                        LineMakingOption lineOp)

reflectQuoteMinimally

protected void reflectQuoteMinimally(FileMakingOption option,
                                     LineMakingOption lineOp)

checkValueCount

protected void checkValueCount(FileMakingOption option,
                               List<String> valueList)

throwFileMakingInvalidValueCountException

protected void throwFileMakingInvalidValueCountException(List<String> columnNameList,
                                                         List<String> valueList)

assertMakingDelimiter

protected void assertMakingDelimiter(FileMakingOption option)

assertMakingEncoding

protected void assertMakingEncoding(FileMakingOption option)

assertObjectNotNull

protected void assertObjectNotNull(String variableName,
                                   Object value)

assertStringNotNullAndNotTrimmedEmpty

protected void assertStringNotNullAndNotTrimmedEmpty(String variableName,
                                                     String value)