org.dbflute.infra.doc.decomment

クラス DfDecoMapFile

java.lang.Object

org.dbflute.infra.doc.decomment.DfDecoMapFile

public class DfDecoMapFile
extends Object

作成者:

cabos, hakiba, jflute, deco

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

コンストラクタ

コンストラクタと説明
DfDecoMapFile(Supplier<LocalDateTime> currentDatetimeSupplier)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	assertClientDirPath(String clientDirPath)
protected String	buildMappingFileName(DfDecoMapMapping decoMapMapping)
protected String	buildPickupFilePath(String clientDirPath)
protected String	buildPieceDirPath(String clientDirPath)
protected String	buildPieceFileName(DfDecoMapPiece decoMapPiece) Build piece file name for piece map file e.g. table decomment : decomment-piece-TABLE_NAME-20171224-143000-123-owner-ABCDEFG.dfmap e.g. column decomment : decomment-piece-TABLE_NAME-COLUMN_NAME-20171224-143000-123-owner-ABCDEFG.dfmap
protected DfMapFile	createDfMapFile()
protected void	createMappingMapFile(File mappingMapFile)
protected void	createPickupMapFile(File pickupMapFile)
protected void	createPieceMapFile(File pieceMapFile)
void	deletePiece(String clientPath)
protected void	doWriteMapping(String mappingFilePath, DfDecoMapMapping decoMapMapping)
protected void	doWritePickup(String pickupFilePath, DfDecoMapPickup decoMapPickup)
protected String	filterOwner(String owner)
protected String	getCurrentDateStr()
protected LocalDateTime	getCurrentLocalDateTime()
DfDecoMapPickup	merge(OptionalThing<DfDecoMapPickup> optPickup, List<DfDecoMapPiece> outputPieceList, List<DfDecoMapMapping> outputMappingList) merge piece map and pickup map with previous piece code and mapping code clue to go on.
List<DfDecoMapMapping>	readMappingList(String clientDirPath) Read all decomment mapping map file in "clientDirPath/schema/decomment/piece/".
OptionalThing<DfDecoMapPickup>	readPickup(String clientDirPath) Read decomment pickup map file at "clientDirPath/schema/decomment/pickup/decomment-pickup.dfmap".
List<DfDecoMapPiece>	readPieceList(String clientDirPath) Read all decomment piece map file in "clientDirPath/schema/decomment/piece/".
protected void	throwDecoMapReadFailureException(String path, Exception cause)
protected void	throwDecoMapResourceReleaseFailureException(String path, Map<String,Object> decoMap, Exception cause)
protected void	throwDecoMapWriteFailureException(String path, Exception cause)
protected void	throwDecoMapWriteFailureException(String path, Map<String,Object> decoMap, Exception cause)
protected void	throwIllegalTargetTypeException(DfDecoMapMapping decoMapMapping)
protected void	throwIllegalTargetTypeException(DfDecoMapPiece decoMapPiece)
void	writeMapping(String clientDirPath, DfDecoMapMapping decoMapMapping)
void	writePickup(String clientDirPath, DfDecoMapPickup decoMapPickup)
void	writePiece(String clientDirPath, DfDecoMapPiece decoMapPiece) Write single decomment piece map file at "clientDirPath/schema/decomment/piece".

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

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

コンストラクタの詳細

DfDecoMapFile

public DfDecoMapFile(Supplier<LocalDateTime> currentDatetimeSupplier)

メソッドの詳細

readPieceList

public List<DfDecoMapPiece> readPieceList(String clientDirPath)

Read all decomment piece map file in "clientDirPath/schema/decomment/piece/".

パラメータ:

clientDirPath - The path of DBFlute client directory (NotNull)

戻り値:

List of all decomment piece map (NotNull: If piece map file not exists, returns empty list)

関連項目:

DfDecoMapPiece.convertToMap()

readPickup

public OptionalThing<DfDecoMapPickup> readPickup(String clientDirPath)

Read decomment pickup map file at "clientDirPath/schema/decomment/pickup/decomment-pickup.dfmap".

パラメータ:

clientDirPath - The path of DBFlute client directory (NotNull)

戻り値:

pickup decomment map (NotNull: If pickup map file not exists, returns empty)

関連項目:

DfDecoMapPickup.convertToMap()

readMappingList

public List<DfDecoMapMapping> readMappingList(String clientDirPath)

Read all decomment mapping map file in "clientDirPath/schema/decomment/piece/".

パラメータ:

clientDirPath - The path of DBFlute client directory (NotNull)

戻り値:

List of all decomment mapping map (NotNull: If mapping map file not exists, returns empty list)

throwDecoMapReadFailureException

protected void throwDecoMapReadFailureException(String path,
                                                Exception cause)

writePiece

public void writePiece(String clientDirPath,
                       DfDecoMapPiece decoMapPiece)

Write single decomment piece map file at "clientDirPath/schema/decomment/piece".

パラメータ:

clientDirPath - The path of DBFlute client directory (NotNull)

decoMapPiece - Decoment piece map (NotNull)

buildPieceFileName

protected String buildPieceFileName(DfDecoMapPiece decoMapPiece)

Build piece file name for piece map file
e.g. table decomment : decomment-piece-TABLE_NAME-20171224-143000-123-owner-ABCDEFG.dfmap
e.g. column decomment : decomment-piece-TABLE_NAME-COLUMN_NAME-20171224-143000-123-owner-ABCDEFG.dfmap

パラメータ:

decoMapPiece - Decoment piece map (NotNull)

戻り値:

piece file name

filterOwner

protected String filterOwner(String owner)

getCurrentDateStr

protected String getCurrentDateStr()

createPieceMapFile

protected void createPieceMapFile(File pieceMapFile)

writePickup

public void writePickup(String clientDirPath,
                        DfDecoMapPickup decoMapPickup)

doWritePickup

protected void doWritePickup(String pickupFilePath,
                             DfDecoMapPickup decoMapPickup)

createPickupMapFile

protected void createPickupMapFile(File pickupMapFile)

writeMapping

public void writeMapping(String clientDirPath,
                         DfDecoMapMapping decoMapMapping)

buildMappingFileName

protected String buildMappingFileName(DfDecoMapMapping decoMapMapping)

doWriteMapping

protected void doWriteMapping(String mappingFilePath,
                              DfDecoMapMapping decoMapMapping)

createMappingMapFile

protected void createMappingMapFile(File mappingMapFile)

throwDecoMapWriteFailureException

protected void throwDecoMapWriteFailureException(String path,
                                                 Exception cause)

throwDecoMapWriteFailureException

protected void throwDecoMapWriteFailureException(String path,
                                                 Map<String,Object> decoMap,
                                                 Exception cause)

throwDecoMapResourceReleaseFailureException

protected void throwDecoMapResourceReleaseFailureException(String path,
                                                           Map<String,Object> decoMap,
                                                           Exception cause)

throwIllegalTargetTypeException

protected void throwIllegalTargetTypeException(DfDecoMapPiece decoMapPiece)

throwIllegalTargetTypeException

protected void throwIllegalTargetTypeException(DfDecoMapMapping decoMapMapping)

merge

public DfDecoMapPickup merge(OptionalThing<DfDecoMapPickup> optPickup,
                             List<DfDecoMapPiece> outputPieceList,
                             List<DfDecoMapMapping> outputMappingList)

merge piece map and pickup map with previous piece code and mapping code clue to go on.

パラメータ:

optPickup - Decoment pickup map (NotNull: If pickup map file not exists, Empty allowed)

outputPieceList - Decoment piece maps in piece directory (NotNull: If piece map file not exists, Empty allowed)

outputMappingList - Decomment mapping maps in piece directory (NotNull: If mapping map file not exists, Empty allowed)

戻り値:

pickup decomment map (NotNull)

deletePiece

public void deletePiece(String clientPath)

createDfMapFile

protected DfMapFile createDfMapFile()

buildPieceDirPath

protected String buildPieceDirPath(String clientDirPath)

buildPickupFilePath

protected String buildPickupFilePath(String clientDirPath)

assertClientDirPath

protected void assertClientDirPath(String clientDirPath)

getCurrentLocalDateTime

protected LocalDateTime getCurrentLocalDateTime()