Package org.apache.flink.runtime.checkpoint.filemerging

Class LogicalFile

java.lang.Object

org.apache.flink.runtime.checkpoint.filemerging.LogicalFile

public class LogicalFile
extends Object

An abstraction of logical files in file-merging checkpoints. It stands for a data segment, that is to say a single file before file-merging.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LogicalFile.LogicalFileId	ID for LogicalFile.

Constructor Summary

Constructors

Constructor	Description
LogicalFile(LogicalFile.LogicalFileId fileId, PhysicalFile physicalFile, long startOffset, long length, FileMergingSnapshotManager.SubtaskKey subtaskKey)

Method Summary

Modifier and Type	Method	Description
void	advanceLastCheckpointId(long checkpointId)	A logical file may share across checkpoints (especially for shared state).
void	discardWithCheckpointId(long checkpointId)	When a checkpoint that uses this logical file is subsumed or aborted, discard this logical file.
boolean	equals(Object o)
LogicalFile.LogicalFileId	getFileId()
long	getLastUsedCheckpointID()
long	getLength()
PhysicalFile	getPhysicalFile()
long	getStartOffset()
FileMergingSnapshotManager.SubtaskKey	getSubtaskKey()
int	hashCode()
boolean	isDiscarded()

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicalFile

public LogicalFile(LogicalFile.LogicalFileId fileId,
                   @Nonnull
                   PhysicalFile physicalFile,
                   long startOffset,
                   long length,
                   @Nonnull
                   FileMergingSnapshotManager.SubtaskKey subtaskKey)

Method Detail

getFileId

public LogicalFile.LogicalFileId getFileId()

advanceLastCheckpointId

public void advanceLastCheckpointId(long checkpointId)

A logical file may share across checkpoints (especially for shared state). When this logical file is used/reused by a checkpoint, update the last checkpoint id that uses this logical file.

Parameters:

checkpointId - the checkpoint that uses this logical file.

discardWithCheckpointId

public void discardWithCheckpointId(long checkpointId)
                             throws IOException

When a checkpoint that uses this logical file is subsumed or aborted, discard this logical file. If this file is used by a later checkpoint, the file should not be discarded. Note that the removal of logical may cause the deletion of physical file.

Parameters:

checkpointId - the checkpoint that is notified subsumed or aborted.

Throws:

IOException - if anything goes wrong with file system.

getLastUsedCheckpointID

public long getLastUsedCheckpointID()

getPhysicalFile

@Nonnull
public PhysicalFile getPhysicalFile()

getStartOffset

public long getStartOffset()

getLength

public long getLength()

getSubtaskKey

@Nonnull
public FileMergingSnapshotManager.SubtaskKey getSubtaskKey()

isDiscarded

@VisibleForTesting
public boolean isDiscarded()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object